CreateTextTag

comment

Creates a text tag.

note

The text tag initially has the absolute world coordinates (0, 0, 0).

note

The maximum amount of existing text tags is limited (MAX_TAG_COUNT):

• v3.0.0: 10000 tags
• older patches: 100 text tags

note

The IDs of text tags range from (MAX_TAG_COUNT-1) to 0 as returned by GetHandleId.

note

When there are already MAX_TAG_COUNT text tags, this function will return the text tag with the ID 0 without resetting any of its properties.

note

When a text tag is destroyed, its ID is pushed to a stack. Creating a text tag, when there are still IDs available, will pop from the stack, i.e., the last destroyed ID will be re-used first. You can also envision that MAX_TAG_COUNT IDs counting up from 0 to (MAX_TAG_COUNT-1) are pushed to the stack at the beginning of the game and ID (MAX_TAG_COUNT-1) will be popped first.

patch

1.07

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

texttag

Source code

native CreateTextTag                takes nothing returns texttag