Aw hud destroy

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.1
SDKbuild 64


int aw_hud_destroy (int session, int id)

Description

Destroys a single HUD element.

Callback

None (returns immediately)

Notes

This method will trigger AW_EVENT_HUD_DESTROY in a neighbor, or all neighbors (i.e. if session is 0), provided that they are subscribing to the event.

Each HUD element has a unique ID, as specified by AW_HUD_ELEMENT_ID when the element was first created using aw_hud_create. You must use this ID when destroying the element. If an element with the given ID does not exist on the user's viewport, then this will have no effect.

Only world server administration instances or those owned by a caretaker (i.e. aw_bool (AW_WORLD_CARETAKER_CAPABILITY) returns 1) may use this method.

Arguments

session
Session number of user for which to destroy a HUD element. If set to zero then all users will have the element destroyed.
id
ID of the HUD element to be destroyed.

Argument attributes

None

Return values

RC_SUCCESS
RC_NOT_INITIALIZED
RC_NO_INSTANCE
RC_NO_CONNECTION
The connection to the world is down.

Returned attributes

None

Usage

/* destroy HUD element with ID #1000 for all users */
aw_hud_destroy (0, 1000);

See also