GUI core hooks, functions, messages, properties and constants for creation and manipulation of GUI nodes. The "gui" namespace is accessible only from gui scripts.
See GuiMessages for related messages.
Static variables
Static methods
staticanimate<T>(node:GuiNode, property:String, to:GoAnimatedProperty, easing:EitherType<GuiEasing, EitherType<Vector3, Vector4>>, duration:Float, ?delay:Float, ?complete_function:(T, GuiNode) ‑> Void, ?playback:GuiPlayback):Void
Animates a node property.
This starts an animation of a node property according to the specified parameters. If the node property is already being
animated, that animation will be canceled and replaced by the new one. Note however that several different node properties
can be animated simultaneously. Use gui.cancel_animation to stop the animation before it has completed.
Composite properties of type vector3, vector4 or quaternion also expose their sub-components (x, y, z and w). You can address the components individually by suffixing the name with a dot '.' and the name of the component. For instance, "position.x" (the position x coordinate) or "color.w" (the color alpha value).
If a complete_function is specified, that function will be called when the animation has completed.
By starting a new animation in that function, several animations can be sequenced together. See the examples for more information.
Parameters:
node | node to animate |
|---|---|
property | property to animate (one of PROP_* constant) |
to | target property value |
easing | easing to use during animation. |
duration | duration of the animation in seconds. |
delay | delay before the animation starts in seconds. |
complete_function | function to call when the animation has completed |
playback | playback mode |
staticcancel_animation(node:GuiNode, property:String):Void
Cancels an ongoing animation.
If an animation of the specified node is currently running (started by gui.animate), it will immediately be canceled.
Parameters:
node | node that should have its animation canceled |
|---|---|
property | property for which the animation should be canceled |
staticcancel_flipbook(node:GuiNode):Void
Cancel a node flipbook animation.
Cancels any running flipbook animation on the specified node.
Parameters:
node | node cancel flipbook animation for |
|---|
staticcancel_spine(node:GuiNode):Void
Cancel a spine animation.
Parameters:
node | spine node that should cancel its animation |
|---|
staticclone(node:GuiNode):GuiNode
Clone a node.
This does not include its children. Use Gui.clone_tree for that purpose.
Parameters:
node | node to clone |
|---|
Returns:
the cloned node
staticclone_tree(node:GuiNode):Table<Hash, GuiNode>
Clone a node including its children.
Use Gui.clone to clone a node excluding its children.
Parameters:
node | root node to clone |
|---|
Returns:
a table mapping node ids to the corresponding cloned nodes
staticdelete_node(node:GuiNode):Void
Deletes a node.
Deletes the specified node. Any child nodes of the specified node will be recursively deleted.
Parameters:
node | node to delete |
|---|
staticdelete_texture(texture:HashOrString):Void
Delete a dynamically created texture.
Parameters:
texture | texture id |
|---|
staticget_adjust_mode(node:GuiNode):GuiAdjustMode
Gets the node adjust mode.
Adjust mode defines how the node will adjust itself to a screen resolution which differs from the project settings.
Parameters:
node | node from which to get the adjust mode |
|---|
Returns:
node adjust mode
staticget_blend_mode(node:GuiNode):GuiBlendMode
Gets the node blend mode.
Blend mode defines how the node will be blended with the background.
Parameters:
node | node from which to get the blend mode |
|---|
Returns:
node blend mode
staticget_clipping_inverted(node:GuiNode):Bool
Gets node clipping inverted state.
If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
Parameters:
node | node from which to get the clipping inverted state |
|---|
Returns:
true or false
staticget_clipping_mode(node:GuiNode):GuiClippingMode
Gets the node clipping mode.
Clipping mode defines how the node will clipping it's children nodes
Parameters:
node | node from which to get the clipping mode |
|---|
Returns:
node clipping mode
staticget_clipping_visible(node:GuiNode):Bool
Gets node clipping visibility state.
If node is set as visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
Parameters:
node | node from which to get the clipping visibility state |
|---|
Returns:
true or false
staticget_color(node:GuiNode):Vector4
Gets the node color.
Parameters:
node | node to get the color from |
|---|
Returns:
node color
staticget_fill_angle(node:GuiNode):Float
Gets the angle for the filled pie sector.
Parameters:
node | node from which to get the fill angle |
|---|
Returns:
sector angle
staticget_flipbook(node:GuiNode):Hash
Get node flipbook animation.
Parameters:
node | node to get flipbook animation from |
|---|
Returns:
animation animation id
staticget_flipbook_cursor(node:GuiNode):Float
Gets the normalized cursor of the animation on a node with flipbook animation.
This is only useful nodes with flipbook animations. Gets the normalized cursor of the flipbook animation on a node.
Parameters:
node | node to get the cursor for |
|---|
Returns:
cursor value
staticget_flipbook_playback_rate(node:GuiNode):Float
Gets the playback rate of the flipbook animation on a node.
This is only useful nodes with flipbook animations. Gets the playback rate of the flipbook animation on a node.
Parameters:
node | node to set the cursor for |
|---|
Returns:
playback rate
staticget_font(node:GuiNode):Hash
Gets the node font.
This is only useful for text nodes. The font must be mapped to the gui scene in the gui editor.
Parameters:
node | node from which to get the font |
|---|
Returns:
font id
staticget_id(node:GuiNode):Hash
Gets the id of the specified node.
Parameters:
node | node to retrieve the id from |
|---|
Returns:
id of the node
staticget_index(node:GuiNode):Float
Gets the index of the specified node.
The index defines the order in which a node appear in a GUI scene. Higher index means the node is drawn on top of lower indexed nodes.
Parameters:
node | node to retrieve the id from |
|---|
Returns:
id of the node
staticget_inherit_alpha(node:GuiNode):Bool
Gets the node inherit alpha state.
Parameters:
node | node from which to get the inherit alpha state |
|---|
staticget_inner_radius(node:GuiNode):Float
Gets the pie inner radius (defined along the x dimension).
Parameters:
node | node from where to get the inner radius |
|---|
Returns:
inner radius
staticget_layer(node:GuiNode):Hash
Gets the node layer.
The layer must be mapped to the gui scene in the gui editor.
Parameters:
node | node from which to get the layer |
|---|
Returns:
layer id
staticget_leading(node:GuiNode):Float
Gets the leading of the text node.
Parameters:
node | node from where to get the leading |
|---|
Returns:
scaling number (default=1)
staticget_line_break(node:GuiNode):Bool
Get line-break mode..
This is only useful for text nodes.
Parameters:
node | node from which to get the line-break for |
|---|
Returns:
line_break
staticget_node(id:HashOrString):GuiNode
Gets the node with the specified id.
Parameters:
id | id of the node to retrieve |
|---|
Returns:
node instance
staticget_outer_bounds(node:GuiNode):GuiPieBounds
Gets the pie outer bounds mode.
Parameters:
node | node from where to get the outer bounds mode (node) |
|---|
Returns:
PIEBOUNDS_RECTANGLE or PIEBOUNDS_ELLIPSE
staticget_outline(node:GuiNode):Vector4
Gets the node outline color.
Parameters:
node | node to get the outline color from |
|---|
Returns:
node outline color
staticget_parent(node:GuiNode):Null<GuiNode>
Gets the parent of the specified node.
If the specified node does not have a parent, null is returned.
Parameters:
node | the node from which to retrieve its parent |
|---|
Returns:
parent instance
staticget_particlefx(node:GuiNode):Hash
Get the paricle fx for a gui node
Parameters:
node | node to get particle fx for |
|---|
Returns:
particle fx id
staticget_perimeter_vertices():Int
Gets the number of generated vertices around the perimeter.
Returns:
vertex count
staticget_pivot(node:GuiNode):GuiPivot
Gets the pivot of a node.
The pivot specifies how the node is drawn and rotated from its position.
Parameters:
node | node to get pivot from |
|---|
Returns:
pivot constant
staticget_position(node:GuiNode):Vector3
Gets the node position.
Parameters:
node | node to get the position from |
|---|
Returns:
node position
staticget_rotation(node:GuiNode):Vector3
Gets the node rotation.
Parameters:
node | node to get the rotation from |
|---|
Returns:
node rotation
staticget_scale(node:GuiNode):Vector3
Gets the node scale.
Parameters:
node | node to get the scale from |
|---|
Returns:
node scale
staticget_screen_position(node:GuiNode):Vector3
Returns the screen position of the supplied node. This function returns the calculated transformed position of the node, taking into account any parent node transforms.
Parameters:
node | node to get the screen position from |
|---|
Returns:
node screen position
staticget_shadow(node:GuiNode):Vector4
Gets the node shadow color.
Parameters:
node | node to get the shadow color from |
|---|
Returns:
node shadow color
staticget_size(node:GuiNode):Vector3
Gets the node size.
Parameters:
node | node to get the size from |
|---|
Returns:
node size
staticget_size_mode(node:GuiNode):GuiSizeMode
Gets the node size mode.
Size mode defines how the node will adjust itself in size according to mode.
Parameters:
node | node from which to get the size mode |
|---|
Returns:
node size mode
staticget_slice9(node:GuiNode):Vector4
Get the slice9 values for the node.
Parameters:
node | node to manipulate |
|---|
Returns:
configuration values
staticget_spine_animation(node:GuiNode):Hash
Gets the playing animation on a spine node.
Parameters:
node | node to get spine skin from |
|---|
Returns:
id spine animation id, 0 if no animation is playing
staticget_spine_bone(node:GuiNode, bone_id:HashOrString):GuiNode
Retrieve the GUI node corresponding to a spine skeleton bone.
The returned node can be used for parenting and transform queries. This function has complexity O(n), where n is the number of bones in the spine model skeleton.
Parameters:
node | spine node to query for bone node |
|---|---|
bone_id | id of the corresponding bone |
Returns:
node corresponding to the spine bone
staticget_spine_cursor(node:GuiNode):Float
Gets the normalized cursor of the animation on a spine node.
This is only useful for spine nodes. Gets the normalized cursor of the animation on a spine node.
Parameters:
node | spine node to get the cursor for |
|---|
Returns:
cursor value
staticget_spine_playback_rate(node:GuiNode):Float
Gets the playback rate of the animation on a spine node.
This is only useful for spine nodes. Gets the playback rate of the animation on a spine node.
Parameters:
node | spine node to set the cursor for |
|---|
Returns:
playack rate
staticget_spine_scene(node:GuiNode):Hash
Gets the spine scene of a node.
This is currently only useful for spine nodes. The spine scene must be mapped to the gui scene in the gui editor.
Parameters:
node | node to get spine scene from |
|---|
Returns:
spine scene id
staticget_spine_skin(node:GuiNode):Hash
Gets the spine skin of a spine node.
Parameters:
node | node to get spine skin from |
|---|
Returns:
spine skin id, 0 if no explicit skin is set
staticget_text(node:GuiNode):String
Gets the node text.
This is only useful for text nodes.
Parameters:
node | node from which to get the text |
|---|
Returns:
text value
staticget_text_metrics(font:HashOrString, text:String, ?width:Float, ?line_break:Bool, ?leading:Float, ?tracking:Float):GuiTextMetrics
Get text metrics
Parameters:
font | font id |
|---|---|
text | text to measure |
width | max-width. use for line-breaks (default=FLT_MAX) |
line_break | true to break lines accordingly to width (default=false) |
leading | scale value for line spacing (default=1) |
tracking | scale value for letter spacing (default=0) |
staticget_text_metrics_from_node(node:GuiNode):GuiTextMetrics
Get text metrics from node.
Parameters:
node | text node to measure text from |
|---|
staticget_texture(node:GuiNode):Hash
Gets the node texture.
This is currently only useful for box or pie nodes. The texture must be mapped to the gui scene in the gui editor.
Parameters:
node | node to get texture from |
|---|
Returns:
texture id
staticget_tracking(node:GuiNode):Float
Gets the tracking of the text node.
Parameters:
node | node from where to get the tracking |
|---|
Returns:
scaling number (default=0)
staticget_xanchor(node:GuiNode):GuiXAnchor
Gets the x-anchor of a node.
The x-anchor specifies how the node is moved when the game is run in a different resolution.
Parameters:
node | node to get x-anchor from |
|---|
Returns:
anchor anchor constant
staticget_yanchor(node:GuiNode):GuiYAnchor
Gets the y-anchor of a node.
The y-anchor specifies how the node is moved when the game is run in a different resolution.
Parameters:
node | node to get y-anchor from |
|---|
Returns:
anchor anchor constant
staticis_enabled(node:GuiNode):Bool
Retrieves if a node is enabled or not.
Disabled nodes are not rendered and animations acting on them are not evaluated.
Parameters:
node | node to query |
|---|
Returns:
whether the node is enabled or not
staticmove_above(node:GuiNode, ref:Null<GuiNode>):Void
Moves the first node above the second.
Supply null as the second argument to move the first node to the top.
Parameters:
node | to move |
|---|---|
ref | reference node above which the first node should be moved |
staticmove_below(node:GuiNode, ref:Null<GuiNode>):Void
Moves the first node below the second.
Supply null as the second argument to move the first node to the bottom.
Parameters:
node | to move |
|---|---|
ref | reference node below which the first node should be moved |
staticnew_box_node(pos:EitherType<Vector3, Vector4>, size:Vector3):GuiNode
Creates a new box node.
Parameters:
pos | node position |
|---|---|
size | node size |
Returns:
new box node
staticnew_particlefx_node(pos:EitherType<Vector4, Vector3>, particlefx:HashOrString):GuiNode
Dynamically create a particle fx node.
Parameters:
pos | node position |
|---|---|
particlefx | particle fx resource name |
Returns:
new particle fx node
staticnew_pie_node(pos:EitherType<Vector3, Vector4>, size:Vector3):GuiNode
Creates a new pie node.
Parameters:
pos | node position |
|---|---|
size | node size |
Returns:
new box node
staticnew_spine_node(pos:EitherType<Vector3, Vector4>, spine_scene:HashOrString):GuiNode
Creates a new spine node.
Parameters:
pos | node position |
|---|---|
spine_scene | spine scene id |
Returns:
new spine node
staticnew_text_node(pos:EitherType<Vector3, Vector4>, text:String):GuiNode
Creates a new text node.
Parameters:
pos | node position |
|---|---|
text | node text |
Returns:
new text node
staticnew_texture(texture:HashOrString, width:Float, height:Float, type:String, buffer:String, ?flip:Bool):Bool
Create new texture.
Dynamically create a new texture.
Parameters:
texture | texture id |
|---|---|
width | texture width |
height | texture height |
type | texture type
|
buffer | texture data |
flip | flip texture vertically |
Returns:
texture creation was successful
staticpick_node(node:GuiNode, x:Float, y:Float):Bool
Determines if the node is pickable by the supplied coordinates.
Parameters:
node | node to be tested for picking |
|---|---|
x | x-coordinate |
y | y-coordinate |
Returns:
pick result
staticplay_flipbook(node:GuiNode, animation:HashOrString, ?complete_function:() ‑> Void, ?play_properties:GuiPlayFlipbookProperties):Void
Play node flipbook animation.
Play flipbook animation on a box or pie node. The current node texture must contain the animation.
Parameters:
node | node to set animation for |
|---|---|
animation | animation id |
complete_function | function to call when the animation has completed |
play_properties | optional table with properties |
staticplay_particlefx<T>(node:GuiNode, ?emitter_state_function:(T, Hash, Hash, ParticlefxEmitterState) ‑> Void):Void
Plays the paricle fx for a gui node
Parameters:
node | node to play particle fx for |
|---|---|
emitter_state_function | optional callback function that will be called when an emitter attached to this particlefx changes state. callback arguments: self The current object id The id of the particle fx component emitter The id of the emitter state the new state of the emitter |
staticplay_spine_anim(node:GuiNode, animation_id:HashOrString, playback:GuiPlayback, ?play_properties:GuiPlaySpineProperties, ?complete_function:() ‑> Void):Void
Play a spine animation.
Parameters:
node | spine node that should play the animation |
|---|---|
animation_id | id of the animation to play |
playback | playback mode |
play_properties | optional table with properties |
complete_function | function to call when the animation has completed |
staticreset_keyboard():Void
Reset on-display keyboard if available.
Reset input context of keyboard. This will clear marked text.
staticreset_nodes():Void
Reset all nodes to initial state.
reset only applies to static node loaded from the scene. Nodes created dynamically from script are not affected
staticset_adjust_mode(node:GuiNode, adjust_mode:GuiAdjustMode):Void
Sets node adjust mode.
Adjust mode defines how the node will adjust itself to a screen resolution which differs from the project settings.
Parameters:
node | node to set adjust mode for |
|---|---|
adjust_mode | adjust mode to set |
staticset_blend_mode(node:GuiNode, blend_mode:GuiBlendMode):Void
Sets node blend mode.
Blend mode defines how the node will be blended with the background.
Parameters:
node | node to set blend mode for |
|---|---|
blend_mode | blend mode to set |
staticset_clipping_inverted(node:GuiNode, visible:Bool):Void
Sets node clipping visibility.
If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
Parameters:
node | node to set clipping inverted state for |
|---|---|
visible | true or false |
staticset_clipping_mode(node:GuiNode, clipping_mode:GuiClippingMode):Void
Sets node clipping mode state.
Clipping mode defines how the node will clipping it's children nodes
Parameters:
node | node to set clipping mode for |
|---|---|
clipping_mode | clipping mode to set |
staticset_clipping_visible(node:GuiNode, visible:Bool):Void
Sets node clipping visibility.
If node is set as an visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
Parameters:
node | node to set clipping visibility for |
|---|---|
visible | true or false |
staticset_color(node:GuiNode, color:EitherType<Vector3, Vector4>):Void
Sets the node color.
Parameters:
node | node to set the color for |
|---|---|
color | new color |
staticset_enabled(node:GuiNode, enabled:Bool):Void
Enables/disables a node.
Disabled nodes are not rendered and animations acting on them are not evaluated.
Parameters:
node | node to be enabled/disabled |
|---|---|
enabled | whether the node should be enabled or not |
staticset_fill_angle(node:GuiNode, angle:Float):Void
Sets the angle for the filled pie sector.
Parameters:
node | node to set the fill angle for |
|---|---|
sector | angle |
staticset_flipbook_cursor(node:GuiNode, cursor:Float):Void
Sets the normalized cursor of the animation on a node with flipbook animation.
This is only useful nodes with flipbook animations. The cursor is normalized.
Parameters:
node | node to set the cursor for |
|---|---|
cursor | cursor value |
staticset_flipbook_playback_rate(node:GuiNode, playback_rate:Float):Void
Sets the playback rate of the flipbook animation on a node.
This is only useful nodes with flipbook animations. Sets the playback rate of the flipbook animation on a node. Must be positive.
Parameters:
node | node to set the cursor for |
|---|---|
playback_rate | playback rate |
staticset_font(node:GuiNode, font:HashOrString):Void
Sets the node font.
This is only useful for text nodes. The font must be mapped to the gui scene in the gui editor.
Parameters:
node | node for which to set the font |
|---|---|
font | font id |
staticset_id(node:GuiNode, id:HashOrString):Void
Sets the id of the specified node.
Nodes created with the Gui.new_*_node() functions get
an empty id. This function allows you to give dynamically
created nodes an id.
No checking is done on the uniqueness of supplied ids. It is up to you to make sure you use unique ids.
Parameters:
node | node to set the id for |
|---|---|
id | id to set |
staticset_inherit_alpha(node:GuiNode, inherit_alpha:Bool):Void
Sets the node inherit alpha state.
Parameters:
node | node from which to set the inherit alpha state |
|---|---|
inherit_alpha | true or false |
staticset_inner_radius(node:GuiNode, inner:Float):Void
Sets the pie inner radius (defined along the x dimension).
Parameters:
node | node to set the inner radius for |
|---|---|
inner | radius |
staticset_layer(node:GuiNode, layer:HashOrString):Void
Sets the node layer.
The layer must be mapped to the gui scene in the gui editor.
Parameters:
node | node for which to set the layer |
|---|---|
layer | layer id |
staticset_leading(node:GuiNode, leading:Float):Void
Sets the leading of the text node.
Parameters:
node | node for which to set the leading |
|---|---|
leading | a scaling number for the line spacing (default=1) |
staticset_line_break(node:GuiNode, line_break:Bool):Void
Set line-break mode.
This is only useful for text nodes.
Parameters:
node | node to set line-break for |
|---|---|
line_break | true or false |
staticset_outer_bounds(node:GuiNode, bounds:GuiPieBounds):Void
Sets the pie outer bounds mode.
Parameters:
node | node for which to set the outer bounds mode |
|---|---|
bounds | PIEBOUNDS_RECTANGLE or PIEBOUNDS_ELLIPSE |
staticset_outline(node:GuiNode, color:EitherType<Vector3, Vector4>):Void
Sets the node outline color.
Parameters:
node | node to set the outline color for |
|---|---|
color | new outline color |
staticset_parent(node:GuiNode, parent:GuiNode, ?keep_scene_transform:Bool):Void
Set the parent of the node.
Parameters:
node | node for which to set its parent |
|---|---|
parent | parent node to set |
keep_scene_transform | optional flag to make the scene position being perserved |
staticset_particlefx(node:GuiNode, particlefx:HashOrString):Void
Set the paricle fx for a gui node
Parameters:
node | node to set particle fx for |
|---|---|
particlefx | particle fx id |
staticset_perimeter_vertices(vertex:Int):Void
Sets the number of generarted vertices around the perimeter.
Parameters:
vertex | count |
|---|
staticset_pivot(node:GuiNode, pivot:GuiPivot):Void
Sets the pivot of a node.
The pivot specifies how the node is drawn and rotated from its position.
Parameters:
node | node to set pivot for |
|---|---|
pivot | pivot constant |
staticset_position(node:GuiNode, position:EitherType<Vector3, Vector4>):Void
Sets the node position.
Parameters:
node | node to set the position for |
|---|---|
position | new position |
staticset_render_order(order:Int):Void
Set the order number for the current GUI scene. The number dictates the sorting of the "gui" render predicate, in other words in which order the scene will be rendered in relation to other currently rendered GUI scenes.
The number must be in the range 0 to 15.
Parameters:
order | rendering order |
|---|
staticset_rotation(node:GuiNode, rotation:EitherType<Vector3, Vector4>):Void
Sets the node rotation.
Parameters:
node | node to set the rotation for |
|---|---|
rotation | new rotation |
staticset_scale(node:GuiNode, scale:EitherType<Vector3, Vector4>):Void
Sets the node scale.
Parameters:
node | node to set the scale for |
|---|---|
scale | new scale |
staticset_shadow(node:GuiNode, color:EitherType<Vector3, Vector4>):Void
Sets the node shadow color.
Parameters:
node | node to set the shadow color for |
|---|---|
color | new shadow color |
staticset_size(node:GuiNode, size:EitherType<Vector3, Vector4>):Void
Sets the node size.
NOTE! You can only set size on nodes with size mode set to SIZE_MODE_MANUAL
Parameters:
node | node to set the size for |
|---|---|
size | new size |
staticset_size_mode(node:GuiNode, size_mode:GuiSizeMode):Void
Sets node size mode.
Size mode defines how the node will adjust itself in size according to mode.
Parameters:
node | node to set size mode for |
|---|---|
size_mode | size mode to set |
staticset_slice9(node:GuiNode, params:Vector4):Void
Set the slice9 configuration for the node.
Parameters:
node | node to manipulate |
|---|---|
params | new value |
staticset_spine_cursor(node:GuiNode, cursor:Float):Void
Sets the normalized cursor of the animation on a spine node.
This is only useful for spine nodes. The cursor is normalized.
Parameters:
node | spine node to set the cursor for (node) |
|---|---|
cursor | cursor value (number) |
staticset_spine_playback_rate(node:GuiNode, playback_rate:Float):Void
Sets the playback rate of the animation on a spine node.
This is only useful for spine nodes. Sets the playback rate of the animation on a spine node. Must be positive.
Parameters:
node | spine node to set the cursor for |
|---|---|
playback_rate | playback rate |
staticset_spine_scene(node:GuiNode, spine_scene:HashOrString):Void
Sets the spine scene of a node.
Set the spine scene on a spine node. The spine scene must be mapped to the gui scene in the gui editor.
Parameters:
node | node to set spine scene for |
|---|---|
spine_scene | spine scene id |
staticset_spine_skin(node:GuiNode, spine_skin:HashOrString, ?spine_slot:HashOrString):Void
Sets the spine skin on a spine node.
Parameters:
node | node to set the spine skin on |
|---|---|
spine_skin | spine skin id |
spine_slot | optional slot id to only change a specific slot |
staticset_text(node:GuiNode, text:String):Void
Sets the node text.
This is only useful for text nodes.
Parameters:
node | node to set text for |
|---|---|
text | text to set |
staticset_texture(node:GuiNode, texture:HashOrString):Void
Sets the node texture.
Set the texture on a box or pie node. The texture must be mapped to the gui scene in the gui editor.
Parameters:
node | node to set texture for |
|---|---|
texture | texture id |
staticset_texture_data(texture:HashOrString, width:Float, height:Float, type:String, buffer:String, ?flip:Bool):Bool
Set the buffer data for a texture.
Set the texture buffer data for a dynamically created texture.
Parameters:
texture | texture id |
|---|---|
width | texture width |
height | texture height |
type | texture type
|
buffer | texture data |
flip | flip texture vertically |
Returns:
setting the data was successful
staticset_tracking(node:GuiNode, tracking:Float):Void
Sets the tracking of the text node.
Parameters:
node | node for which to set the tracking |
|---|---|
tracking | a scaling number for the letter spacing (default=0) |
staticset_xanchor(node:GuiNode, anchor:GuiXAnchor):Void
Sets the x-anchor of a node.
The x-anchor specifies how the node is moved when the game is run in a different resolution.
Parameters:
node | node to set x-anchor for |
|---|---|
anchor | anchor constant |
staticset_yanchor(node:GuiNode, anchor:GuiYAnchor):Void
Sets the y-anchor of a node.
The y-anchor specifies how the node is moved when the game is run in a different resolution.
Parameters:
node | node to set y-anchor for |
|---|---|
anchor | anchor constant |
staticshow_keyboard(type:GuiKeyboardType, autoclose:Bool):Void
Shows the on-display keyboard if available.
The specified type of keyboard is displayed, if it is available on the device.
This function is only available on iOS and Android.
Parameters:
type | keyboard type |
|---|---|
autoclose | close keyboard automatically when clicking outside |
staticstop_particlefx(node:GuiNode):Void
Stops the particle fx for a gui node
Parameters:
node | node to stop particle fx for |
|---|