1

string

Name for the text pointer. Must be unique amongst text pointers.

2

string

optional, default value="bottom"

Pointer display mode. Determines in what direction the arrow pointer appears relative to the pointer label. Supported values:

• "top", the pointer line is drawn above the text label, pointing upwards.
• "bottom", the pointer line is drawn below the text label, pointing downwards.
• "left", the pointer line is drawn to the left of the text label, pointing to the left.
• "right", the pointer line is drawn to the right of the text label, pointing to the right.
• "worldspace", a special mode, whereby the text pointer appears in 3D space rather than 2D. In this case the pointer line appears below the text label.
• "subtitle", a special mode, whereby the text pointer appears and behaves as a cutscene subtitle in the lower cinematic bar. x/y positions are disregarded in this case.

3

number

optional, default value=0

Length of the attached arrow pointer and line. Can be zero.

4

number

optional, default value=0

X position. This is either the absolute position on-screen, or the position in 3D space if the pointer display mode is set to worldspace.

5

number

optional, default value=0

Y position. This is either the absolute position on-screen, or the position in 3D space if the pointer display mode is set to worldspace.

1

string

Name for the text pointer. Must be unique amongst text pointers.

2

string

optional, default value="bottom"

Pointer display mode. Determines in what direction the arrow pointer appears relative to the pointer label. Supported values:

• "top", the pointer line is drawn above the text label, pointing upwards.
• "bottom", the pointer line is drawn below the text label, pointing downwards.
• "left", the pointer line is drawn to the left of the text label, pointing to the left.
• "right", the pointer line is drawn to the right of the text label, pointing to the right.
• "worldspace", a special mode, whereby the text pointer appears in 3D space rather than 2D. In this case the pointer line appears below the text label.
• "subtitle", a special mode, whereby the text pointer appears and behaves as a cutscene subtitle in the lower cinematic bar. x/y positions are disregarded in this case.

3

number

optional, default value=0

Length of the attached arrow pointer and line. Can be zero.

4

object

UI component to point at. This can be supplied as either a uicomponent or a function that returns a uicomponent. By default the pointer will point to the middle of the component - use the offset parameters to change this.

5

number

optional, default value=0.5

Unary x proportion specifying a pointed position relative to the dimensions of the specified component. Supply zero to point at the left edge of the component, one to point at the right edge of the component, or 0.5 to point at the middle of the component, for example. Values less than zero or greater than one are valid.

6

number

optional, default value=0.5

Unary y proportion specifying a pointed position relative to the dimensions of the specified component. Supply zero to point at the top edge of the component, one to point at the bottom edge of the component, or 0.5 to point at the middle of the component, for example. Values less than zero or greater than one are valid.

1

string

Name for the text pointer. Must be unique amongst text pointers.

2

text_pointer

Text pointer object to display relative to.

3

number

x offset in pixels from the other text pointer. This takes into account the other text pointer's size, so the two text pointers cannot overlap.

Supplying a value of 10 would mean a gap of 10 pixels between the two text pointers, with this text pointer on the right of the other, while a value of -10 would mean a gap of 10 pixels with this text pointer on the left.

4

number

y offset in pixels from the other text pointer. This takes into account the other text pointer's size, so the two text pointers cannot overlap.

Supplying a value of 10 would mean a gap of 10 pixels between the two text pointers, with this text pointer below the other (as a higher value of y means a position further down the screen), while a value of -10 would mean a gap of 10 pixels with this text pointer above the other.

1

string

path

1

string

path

1

number

pointer width

1

number

Width of panel on-screen in pixels.

2

boolean

optional, default value=false

Shrink text horizontally if on one line.

1

number

Width of panel on-screen will be the screen width minus this value, in pixels.

2

boolean

optional, default value=false

Shrink text horizontally if on one line.

1

number

display height

1

number

x offset

2

number

y offset

1

boolean

show line end without line

1

number

priority

1

boolean

optional, default value=true

topmost

1

boolean

optional, default value=true

Set to true to enable pulsing.

2

number

optional, default value=nil

Pulse strength override. Supply a positive number here to modify the strength of the pulse. Default value is 5.

1

boolean

should stream

2

number

optional, default value=nil

stream duration

1

number

stream duration

1

string

animation name

1

string

animation name

1

string

animation name

1

string

animation name

1

string

state name

1

string

state name

1

string

state name

1

boolean

optional, default value=true

show button

1

boolean

optional, default value=true

close on click

1

function

Callback

2

number

optional, default value=0

Delay before calling callback, in s (campaign) or ms (battle/frontend)

1

function

Callback

2

number

optional, default value=0

Delay before calling callback, in s (campaign) or ms (battle/frontend)

3

boolean

optional, default value=nil

Sets the close button to show on the text pointer. If no value is specified then the current behaviour remains untouched.

1

string

component name

1

number

optional, default value=0

Period the text pointer should wait after being shown before the button highlight begins. This is specified in s in campaign, ms in battle or the frontend.

This is disregarded if the text pointer is already showing at the time this function is called.

1

position

optional, default value=true

as subtitle

1

string

Name of text component on the text pointer.

2

string

Full database key of localised text, in the form [table]_[localised_field]_[record_key].

3

exempt

optional, default value=false

Exempts this text from being streamed, if the text pointer is set to stream text.

1

function

callback

1

force

optional, default value=false

Forces the text pointer to display. This flag is only considered if the text pointer has been set to behave as a subtitle with text_pointer:set_position_as_subtitle, and if set to true causes the text pointer to override the player's subtitles preferences.

1

hide

optional, default value=false

Hide the text pointer immediately without any animation.

2

suppress

optional, default value=false

Suppress the scripted event that triggers - this is for internal use.

1

boolean

should ignore

1

boolean

should stop release

1

string

style

2

...

additional args

1

string

Name for this text pointer. If this pointer is storing a record in the advice history (which is the default behaviour, and must be opted-out of by setting this suppress record in advice argument to true on this function) then the supplied name must be unique.

2

string

Orientation of the pointer arrow that is drawn. Supported values are "topleft", "topright", "bottomleft" and "bottomright".

3

uicomponent/function

Specifier of uicomponent to point at. This can either be a uicomponent object or a function that returns a uicomponent. It's strongly recommended that if the text pointer is not being displayed immediately after being created that a function is used.

4

string

Localised text key to display, in [table]_[field]_[key] format.

5

number

optional, default value=0.5

Unary x proportion specifying a pointed position relative to the dimensions of the specified component. Supply 0 to point at the left edge of the component, 1 to point at the right edge of the component, or 0.5 to point at the middle of the component, for example. Values less than zero or greater than one are valid.

6

number

optional, default value=0.5

Unary y proportion specifying a pointed position relative to the dimensions of the specified component. Supply 0 to point at the top edge of the component, 1 to point at the bottom edge of the component, or 0.5 to point at the middle of the component, for example. Values less than zero or greater than one are valid.

7

number

optional, default value=250

Width of the text pointer panel in pixels.

8

boolean

optional, default value=false

Sets this active pointer to not record a record of whether it's been triggered in advice history. If this is set to true then the active pointer is not registered with the script core, and it doesn't need to have a unique name. However, the active pointer will not be able to automatically listen for events.

1

number

Delay value. This should be set in seconds in campaign, and milliseconds in battle or in the frontend.

1

number

Default timeout value. This should be set in seconds in campaign, and milliseconds in battle or in the frontend.

1

string

Script event name.

2

function/boolean

optional, default value=true

Conditional check. This can be a function that returns a boolean, or true to always pass when the supplied event is received.

3

boolean

optional, default value=true

Hide the text pointer immediately, without a fade animation.

1

number

optional, default value=0

Delay between the uicomponent stopping moving/becoming visible and the text pointer actually being shown. This should be supplied in seconds in campaign, and in milliseconds in battle and the frontend. The default value is 1 second, or 1000ms, or whatever has been set with active_pointer:set_default_delay.

2

number

optional, default value=0

Timeout period override. The timeout is the elapsed period after which the show_when_ready process will halt if the target uicomponent has not stopped moving or become visible. In campaign this should be supplied in seconds, and defaults to either 5 or whatever value has been set with active_pointer:set_default_timeout. In battle and the frontend, the timeout period is set in milliseconds and defaults to 5000.

1

string

Name of active pointer to wait for. The active pointer being waited for must have registered itself in the advice history.

2

number

optional, default value=0

Delay override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. This is the delay between the uicomponent stopping moving/becoming visible and the text pointer actually being shown. This should be supplied in seconds in campaign, and in milliseconds in battle and the frontend. The default value is 1 second, or 1000ms, or whatever has been set with active_pointer:set_default_delay.

3

number

optional, default value=0

Timeout period override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. The timeout is the elapsed period after which the show_when_ready process will halt if the target uicomponent has not stopped moving or become visible. In campaign this should be supplied in seconds, and defaults to either 5 or whatever value has been set with active_pointer:set_default_timeout. In battle and the frontend, the timeout period is set in milliseconds and defaults to 5000.

1

string

Name of active pointer to wait for. The active pointer being waited for must have registered itself in the advice history.

2

number

optional, default value=0

Delay override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. This is the delay between the uicomponent stopping moving/becoming visible and the text pointer actually being shown. This should be supplied in seconds in campaign, and in milliseconds in battle and the frontend. The default value is 1 second, or 1000ms, or whatever has been set with active_pointer:set_default_delay.

3

number

optional, default value=0

Timeout period override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. The timeout is the elapsed period after which the show_when_ready process will halt if the target uicomponent has not stopped moving or become visible. In campaign this should be supplied in seconds, and defaults to either 5 or whatever value has been set with active_pointer:set_default_timeout. In battle and the frontend, the timeout period is set in milliseconds and defaults to 5000.

1

string

Event name.

2

boolean/function

optional, default value=true

Conditional check. This may be omitted, or true may be supplied to always trigger whenever the supplied event is received.

3

number

optional, default value=0

Delay override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. This is the delay between the uicomponent stopping moving/becoming visible and the text pointer actually being shown. This should be supplied in seconds in campaign, and in milliseconds in battle and the frontend. The default value is 1 second, or 1000ms, or whatever has been set with active_pointer:set_default_delay.

4

number

optional, default value=0

Timeout period override, which will be supplied to active_pointer:show_when_ready if this monitor tries to show the pointer. The timeout is the elapsed period after which the show_when_ready process will halt if the target uicomponent has not stopped moving or become visible. In campaign this should be supplied in seconds, and defaults to either 5 or whatever value has been set with active_pointer:set_default_timeout. In battle and the frontend, the timeout period is set in milliseconds and defaults to 5000.