AW HUD ELEMENT ID

From ActiveWiki
Jump to: navigation, search


Minimum requirements
Added in version 4.1
SDKbuild 64


AW_HUD_ELEMENT_ID

Type

Integer

Description

Id of a HUD element.

Notes

This attribute must be set to a positive integer (1 or larger). Setting it to 0 and placing a blocking call to aw_hud_create will return RC_TIMEOUT after a delay.

The value of this attribute uniquely defines a HUD element for one particular user. The value is stored by the Activeworlds browser when a new HUD element is created using aw_hud_create. Any subsequent calls to aw_hud_create with AW_HUD_ELEMENT_ID set to the value it was set at creation will cause the new element to replace the old one, rather than create an entirely new element.

When aw_hud_destroy is called, the HUD element with the Id of AW_HUD_ELEMENT_ID will be removed from the 3D viewport.

This Id is used in AW_EVENT_HUD_CLICK to identify which clickable (i.e. AW_HUD_ELEMENT_FLAGS had the flag AW_HUD_ELEMENT_FLAG_CLICKS) HUD element was clicked by a user.

Used by

See also