Aw cav delete

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.2
SDKbuild 70


int aw_cav_delete (void)

Description

Deletes the custom universe avatar definition of a user.

Callback

AW_CALLBACK_CAV_RESULT

Notes

This method is currently available to "Invite" applications (see aw_login).

Arguments

None

Argument attributes

AW_CAV_CITIZEN
Citizen number, set to 0 for tourists and bots.
AW_CAV_SESSION
Session number, must be specified.

Return values

RC_SUCCESS
RC_NO_CONNECTION (1)
Network connection to the universe is down.
RC_UNAUTHORIZED (2)
Attempted to delete the custom avatar of another user without root privileges (citizen #1 - universe administrators).

(1) Possible return values when a callback has been established.

(2) Returned from the universe server and is passed to a callback handler.

Blocking calls may return any of the listed reason codes.

Returned attributes

AW_CAV_CITIZEN
AW_CAV_SESSION

Usage

Delete the custom avatar of the current instance.

 int rc;
 
 aw_int_set (AW_CAV_CITIZEN, 0);
 aw_int_set (AW_CAV_SESSION, aw_session ());
 
 rc = aw_cav_delete ();
 if (rc)
   printf ("Unable to delete custom avatar (reason %d)\n", rc);

An invite application can delete the custom avatar of the citizen it is logged in for.

 int rc;
 
 aw_int_set (AW_CAV_CITIZEN, aw_int (AW_CITIZEN_NUMBER));
 aw_int_set (AW_CAV_SESSION, aw_session ());
 
 rc = aw_cav_delete ();
 if (rc)
   printf ("Unable to delete custom avatar (reason %d)\n", rc);

See also