Aw world cav request
| Minimum requirements | ||
|---|---|---|
| Added in version 4.2 | ||
| SDK | build 70 | |
int aw_world_cav_request (int citizen, int session)
Description
Queries the custom world avatar definition of a user.
Callback
Notes
It is possible for the custom avatar definition to have an uncompressed size of up to 40940 bytes. It can be 0 bytes long which would cause this method to succeed and return an empty AW_CAV_DEFINITION. The maximum compressed size is 4094 bytes.
Arguments
- citizen
- Citizen number, set to 0 for tourists and bots.
- session
- Session number, must be specified.
Argument attributes
None
Return values
- RC_SUCCESS (1) (2)
- RC_NO_CONNECTION (1)
- The connection to the world is down.
- RC_UNAUTHORIZED (2)
- No session number was specified.
- RC_NO_SUCH_SESSION (2)
- RC_NO_SUCH_CAV (2)
- User has not defined a custom world avatar.
(1) Possible return values when a callback is installed.
(2) Returned by the world server.
Returned attributes
Usage
Query custom world avatar definition of the current instance.
int rc; rc = aw_world_cav_request (0, aw_session ()); if (rc != RC_SUCCESS) printf ("Unable to query custom world avatar (reason %d)\n", rc);