Aw world cav delete
Jump to navigation
Jump to search
| Minimum requirements | ||
|---|---|---|
| Added in version 4.2 | ||
| SDK | build 70 | |
int aw_world_cav_delete (void)
Description
Deletes the custom world avatar definition of a user.
Callback
Notes
This method will currently not trigger AW_EVENT_WORLD_CAV_DEFINITION_CHANGE.
Arguments
None
Argument attributes
- AW_CAV_CITIZEN
- Citizen number, set to 0 for tourists and bots.
- AW_CAV_SESSION
- Session number, used for tourists and bots.
Return values
- RC_SUCCESS (1) (2)
- RC_NO_CONNECTION (1)
- The connection to the world is down.
- RC_UNAUTHORIZED (2)
- Only world server administration instances or those owned by a caretaker (i.e. aw_bool (AW_WORLD_CARETAKER_CAPABILITY) returns 1) may delete the custom avatar of another user.
- RC_UNABLE_TO_DELETE_CAV (2)
- Unable to delete custom avatar.
(1) Possible return values when a callback is installed.
(2) Returned by the world server.
Returned attributes
Usage
Delete custom world avatar definition of the current instance.
int rc; aw_int_set (AW_CAV_CITIZEN, 0); aw_int_set (AW_CAV_SESSION, aw_session ()); rc = aw_world_cav_delete (); if (rc != RC_SUCCESS) printf ("Unable to delete custom world avatar (reason %d)\n", rc);