VoidExpanse/scope-script
Scope script
Used to get access to a specific script-related functions.
Visibility: Global.
List of functions
RestrictFunctionByTime | ||
---|---|---|
Arguments | Returns | Example |
|
void |
script.RestrictFunctionByTime("some_function", 10); |
Description | ||
It can be useful, when you want to subscribe to every-frame event, like OnEnterFrame, but you don't want your function to be called every frame. In this case one of possible solutions would be to use function pair : RestrictFunctionByTime/RestrictFunctionFPS. In such functions, in case you need an interval since it was last called, you'd call script.GetSecondsMultiplier instead of standard game.GetSecondsMultipler. |
RestrictFunctionFPS | ||
---|---|---|
Arguments | Returns | Example |
|
void |
script.RestrictFunctionFPS("some_function", 10); |
Description | ||
It can be useful, when you want to subscribe to every-frame event, like OnEnterFrame, but you don't want your function to be called every frame. In this case one of possible solutions would be to use function pair : RestrictFunctionByTime/RestrictFunctionFPS. In such functions, in case you need an interval since it was last called, you'd call script.GetSecondsMultiplier instead of standard game.GetSecondsMultipler. |
GetSecondsMultiplier | ||
---|---|---|
Arguments | Returns | Example |
void |
Double |
var time = script.GetSecondsMultiplier(); |
Description | ||
Returns time since this function was called last time. Works properly only if function was restricted with RestrictFunctionByTime/RestrictFunctionFPS |