(→Members) |
|||
| Line 6: | Line 6: | ||
{{ScriptFunction|SGameObject|ExecutingObject|{ get; }|Returns the SGameObject this script is attached to}} | {{ScriptFunction|SGameObject|ExecutingObject|{ get; }|Returns the SGameObject this script is attached to}} | ||
{{ScriptFunction|string|Language|{ get; }|Returns the English name for the users language, e.g. 'English', 'French', 'Chinese'}} | {{ScriptFunction|string|Language|{ get; }|Returns the English name for the users language, e.g. 'English', 'French', 'Chinese'}} | ||
| − | + | {{ScriptFunction|void|StartCoroutine|(DynValue func);|Executes the specified function as a coroutine.| | |
| + | local function myCoroutine() | ||
| + | <br> -- The yield statement is a special kind of return, that ensures that the function will continue from the line once the coroutine resumes. | ||
| + | <br> -- Placing a float value inside of the yield will result in a delayed execution. | ||
| + | <br> -- Example: coroutine.yield(0.5) will wait 0.5 seconds before continuing the execution of the coroutine. | ||
| + | <br> | ||
| + | <br> -- This will print the current players active time. | ||
| + | <br> Space.Log(Space.Time); | ||
| + | <br> | ||
| + | <br> -- Execution of this coroutine will halted for 10 seconds. | ||
| + | <br> coroutine.yield(10); | ||
| + | <br> | ||
| + | <br> -- This will print the current players active time, which will be 10 seconds greater then the previous as a result of the yield | ||
| + | <br> Space.Log(Space.Time); | ||
| + | <br>end | ||
| + | <br> | ||
| + | <br>Space.Host.StartCoroutine(myCoroutine); | ||
| + | <br> | ||
| + | }} | ||
{{Scripting Navbox}} | {{Scripting Navbox}} | ||
The SHost class represents the scripting runtime.
Invokes a UnityEvent attached to the Scripting Runtime component this script is executing in.
Pauses the current script until it is manually restarted, at the end of the current function/method; consider using return as well
Returns the SGameObject this script is attached to
Returns the English name for the users language, e.g. 'English', 'French', 'Chinese'
Executes the specified function as a coroutine.
local function myCoroutine()
-- The yield statement is a special kind of return, that ensures that the function will continue from the line once the coroutine resumes.
-- Placing a float value inside of the yield will result in a delayed execution.
-- Example: coroutine.yield(0.5) will wait 0.5 seconds before continuing the execution of the coroutine.
-- This will print the current players active time.
Space.Log(Space.Time);
-- Execution of this coroutine will halted for 10 seconds.
coroutine.yield(10);
-- This will print the current players active time, which will be 10 seconds greater then the previous as a result of the yield
Space.Log(Space.Time);
end
Space.Host.StartCoroutine(myCoroutine);
| ||||||||||||||