Aw hud destroy
|Added in version 4.1|
int aw_hud_destroy (int session, int id)
Destroys a single HUD element.
None (returns immediately)
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.
- Session number of user for which to destroy a HUD element. If set to zero then all users will have the element destroyed.
- ID of the HUD element to be destroyed.
/* destroy HUD element with ID #1000 for all users */ aw_hud_destroy (0, 1000);