Aw hud clear
Jump to navigation
Jump to search
| Minimum requirements | ||
|---|---|---|
| Added in version 4.1 | ||
| SDK | build 64 | |
int aw_hud_clear (int session)
Description
Clears all HUD elements.
Callback
None (returns immediately)
Notes
This method will trigger AW_EVENT_HUD_CLEAR in a neighbor, or all neighbors (i.e. if session is 0), provided that they are subscribing to the event.
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 clear all HUD elements. If set to 0 (zero) then all users will have their HUD cleared.
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
void hud_clear (int session)
{
/* remove all hud elements */
aw_hud_clear (session);
}
/* clear the hud of every user in the world */
hud_clear (0);
/* clear the hud of user with session number 1234 */
hud_clear (1234);