Line 2: | Line 2: | ||
==Properties== | ==Properties== | ||
− | {{ScriptFunction|bool|Enabled|{get;set;}|Enable or disable the clickable component from a GameObject.|5= | + | {{ScriptFunction|bool|Enabled|{get;set;}|Enable or disable the clickable component from a GameObject.|5=<pre>Space.Host.ExecutingObject.Clickable.Enabled = false</pre> |6=<pre>--Clicking the object will disable the component, making it only clickable once |
− | + | thisGameObject = Space.Host.ExecutingObject | |
− | + | ||
− | Clickable= | + | |
− | Clickable. | + | OnClick = function() |
− | + | thisGameObject.Clickable.Enabled = false | |
+ | end | ||
+ | |||
+ | |||
+ | thisGameObject.AddClickable() | ||
+ | thisGameObject.Clickable.Tooltip = "Click to activate" | ||
+ | thisGameObject.Clickable.OnClick(OnClick)</pre>}} | ||
{{ScriptFunction|string|Tooltip|{get;set;}|A hint that pops up when the mouse is hovering over the GameObject.|5= | {{ScriptFunction|string|Tooltip|{get;set;}|A hint that pops up when the mouse is hovering over the GameObject.|5= |
The SClickable class provides tools to work with the Clickable component, which is responsible for interacting with the object through clicking on it.
Enable or disable the clickable component from a GameObject.
Space.Host.ExecutingObject.Clickable.Enabled = false
--Clicking the object will disable the component, making it only clickable once thisGameObject = Space.Host.ExecutingObject OnClick = function() thisGameObject.Clickable.Enabled = false end thisGameObject.AddClickable() thisGameObject.Clickable.Tooltip = "Click to activate" thisGameObject.Clickable.OnClick(OnClick)
A hint that pops up when the mouse is hovering over the GameObject.
hostObject.AddClickable();
Space.Log(hostObject.Clickable.Tooltip);
-- Prints an empty string to the console - Tooltip is empty upon initializing.
hostObject.Clickable.Tooltip = "I am clickable!";
--Clicking the object will toggle between two different tooltips thisGameObject = Space.Host.ExecutingObject OnClick = function() if thisGameObject.Clickable.Tooltip == "Turn On" then thisGameObject.Clickable.Tooltip = "Turn Off" else thisGameObject.Clickable.Tooltip = "Turn On" end end thisGameObject.AddClickable() thisGameObject.Clickable.Tooltip = "Turn On" thisGameObject.Clickable.OnClick(OnClick)
Add a new action for the object to perform when clicked. Can be useful for providing miltuple choice of an action on click.
hostObject.AddClickable();
function ClickMe ()
end
Add a new action for the object to perform when clicked. Can be useful for providing miltuple choice of an action on click.
hostObject.AddClickable();
function ClickMeAndCount ()
end
local f = ClickMeAndCount ();
hostObject.Clickable.AddExtraAction ("Click me and count", "Prints to the console how many times I was clicked", f);
Removes all actions from the clickable GameObject.
hostObject.AddClickable();
function ClickMe ()
end
function ClickAndClear ()
end
hostObject.Clickable.AddExtraAction ("Click me", "Prints I was clicked! to the console", ClickMe);
hostObject.Clickable.AddExtraAction ("Click And Clear", "Clears all actions", ClickAndClear);
When clicked, the GameObject performs the required action.
hostObject.AddClickable();
local deltaPos = Vector.New(0,0,1);
function MakeMeMove ()
end
hostObject.Clickable.OnClick (MakeMeMove);
When clicked, the GameObject performs the required action.
hostObject.AddClickable();
function ClickAndCount ()
end
local f = ClickAndCount ();
|