PM_OVERLAY_ADD_TEXT
Syntax
handle_val = PM_OVERLAY_ADD_TEXT ( overlay_handle, [properties_tag_record_handle,] x, y, z, prompt );
- Input arguments
-
handle overlay_handle Handle of the overlay context to which to add the text. float x X coordinate of the text in world space. float y Y coordinate of the text in world space. float z Z coordinate of the text in world space. string prompt The text to draw.
- Optional input arguments
-
handle properties_tag_record_handle Handle of the tag record from which to get the properties of the text.
Accepted properties: color.
Return Values
- Success:
-
handle entity_handle Handle to the created overlay entity.
- Failure:
-
int -1 Script interface error.
Description
This function adds a text to a given overlay context. The text will be drawn to the specified point. The overlay context must first be opened with PM_OVERLAY_OPEN(overlay_handle).
Example
%PMS_HOME%\pm\macro\Examples\PM_OVERLAY_DEMO.mac
Function Set
Related Functions