Aw world cav change

From ActiveWiki
Revision as of 11:16, 2 November 2008 by Macavity (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Minimum requirements
Added in version 4.2
SDKbuild 70


int aw_world_cav_change (void)

Description

Changes the custom world avatar definition of a user.

Callback

AW_CALLBACK_WORLD_CAV_RESULT

Notes

This method will trigger AW_EVENT_WORLD_CAV_DEFINITION_CHANGE when the change is made for a user that is currently in the world.

Arguments

None

Argument attributes

AW_CAV_CITIZEN
Citizen number, set to 0 for tourists and bots.
AW_CAV_SESSION
Session number, must be specified.
AW_CAV_DEFINITION
Compressed custom avatar definition.

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 change the custom avatar of another user.
RC_UNABLE_TO_UPDATE_CAV (2)
Unable to update the custom world avatar.

(1) Possible return values when a callback is installed.

(2) Returned by the world server.

Returned attributes

AW_CAV_CITIZEN
AW_CAV_SESSION

Usage

...

See also