- Select manual -


A GUI box node with an image texture and a script to make it act as a button.


The “gui” game object contains a GUI component stored in the file button.gui. The GUI contains the setup with the “button” box node for the button image and the “text” text node for the button label text.

button.gui has a script attached to it, called button.gui_script, which contains the button logic.

button gui


function init(self)
    msg.post(".", "acquire_input_focus") 

function on_input(self, action_id, action)
    if action_id == hash("click") and action.pressed then 
        local button = gui.get_node("button") 
        local text = gui.get_node("text") 
        if gui.pick_node(button, action.x, action.y) then 
            gui.set_text(text, "HELLO!") 
            gui.set_text(text, "CLICK ME!") 
  1. Tell the engine that this game object wants to receive input.
  2. If the user clicks.
  3. Get the instance for the node named “button” (the button box).
  4. Get the instance for the node named “text” (the button label).
  5. Check if the click position (action.x and action.y) is within the boundaries of the button node.
  6. If the user clicks on the button, change the label text.
  7. If the user clicks elsewhere, change the label text to something else.

If you want to play with these examples, you can get the project on Github.

Do you want to see more examples? Why not write a few yourself and submit a pull request? We love contributions.