VoidExpanse/scope-script - Revision history

Atomic-admin at 04:05, 13 February 2014

2014-02-13T04:05:49Z

← Older revision		Revision as of 04:05, 13 February 2014
Line 36:		Line 36:
	{{Scripting_api\|GetSecondsMultiplier\|		{{Scripting_api\|GetSecondsMultiplier\|
	void\|		void\|
	~~void~~ \|		Double\|
	<pre style="margin:0px;">var time = script.GetSecondsMultiplier();</pre> \|		<pre style="margin:0px;">var time = script.GetSecondsMultiplier();</pre> \|
	Returns time since this function was called last time. Works properly only if function		Returns time since this function was called last time. Works properly only if function
	was restricted with RestrictFunctionByTime/RestrictFunctionFPS		was restricted with RestrictFunctionByTime/RestrictFunctionFPS
	}}		}}

Atomic-admin at 04:05, 13 February 2014

2014-02-13T04:05:07Z

← Older revision		Revision as of 04:05, 13 February 2014
Line 35:		Line 35:

	{{Scripting_api\|GetSecondsMultiplier\|		{{Scripting_api\|GetSecondsMultiplier\|
	\|		void\|
	void \|		void \|
	<pre style="margin:0px;">var time = script.GetSecondsMultiplier();</pre> \|		<pre style="margin:0px;">var time = script.GetSecondsMultiplier();</pre> \|

Damonwall at 03:49, 13 February 2014

2014-02-13T03:49:54Z

← Older revision		Revision as of 03:49, 13 February 2014
Line 3:		Line 3:
	</noinclude>		</noinclude>

	= ~~Config~~ script =		= Scope script =
	Used to get access to a specific script-related functions.		Used to get access to a specific script-related functions.

Damonwall at 03:47, 13 February 2014

2014-02-13T03:47:38Z

← Older revision		Revision as of 03:47, 13 February 2014
Line 1:		Line 1:
			<noinclude>
			[[Category:VoidExpanse/api_scopes]]
			</noinclude>

	= Config script =		= Config script =
	Used to get access to a specific script-related functions.		Used to get access to a specific script-related functions.
Line 10:		Line 14:
	* float: seconds\|		* float: seconds\|
	void \|		void \|
	<~~nowiki~~>script.RestrictFunctionByTime("some_function", 10);</~~nowiki~~> \|		<pre style="margin:0px;">script.RestrictFunctionByTime("some_function", 10);</pre> \|
	It can be useful, when you want to subscribe to every-frame event, like OnEnterFrame,		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		but you don't want your function to be called every frame. In this case one of possible
Line 22:		Line 26:
	* int: fps\|		* int: fps\|
	void \|		void \|
	<~~nowiki~~>script.RestrictFunctionFPS("some_function", 10);</~~nowiki~~> \|		<pre style="margin:0px;">script.RestrictFunctionFPS("some_function", 10);</pre> \|
	It can be useful, when you want to subscribe to every-frame event, like OnEnterFrame,		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		but you don't want your function to be called every frame. In this case one of possible
Line 33:		Line 37:
	\|		\|
	void \|		void \|
	<~~nowiki~~>var time = script.GetSecondsMultiplier();</~~nowiki~~> \|		<pre style="margin:0px;">var time = script.GetSecondsMultiplier();</pre> \|
	Returns time since this function was called last time. Works properly only if function		Returns time since this function was called last time. Works properly only if function
	was restricted with RestrictFunctionByTime/RestrictFunctionFPS		was restricted with RestrictFunctionByTime/RestrictFunctionFPS
	}}		}}

Damonwall: /* List of functions */

2014-02-13T02:35:14Z

List of functions

← Older revision		Revision as of 02:35, 13 February 2014
Line 7:		Line 7:

	{{Scripting_api\|RestrictFunctionByTime\|		{{Scripting_api\|RestrictFunctionByTime\|
	* string: name * float: seconds\|		* string: name
			* float: seconds\|
	void \|		void \|
	<nowiki>script.RestrictFunctionByTime("some_function", 10);</nowiki> \|		<nowiki>script.RestrictFunctionByTime("some_function", 10);</nowiki> \|
Line 18:		Line 19:

	{{Scripting_api\|RestrictFunctionFPS\|		{{Scripting_api\|RestrictFunctionFPS\|
	* string: name * int: fps\|		* string: name
			* int: fps\|
	void \|		void \|
	<nowiki>script.RestrictFunctionFPS("some_function", 10);</nowiki> \|		<nowiki>script.RestrictFunctionFPS("some_function", 10);</nowiki> \|

Damonwall: Created page with "= Config script = Used to get access to a specific script-related functions. '''Visibility:''' Global. == List of functions == {{Scripting_api|RestrictFunctionByTime| * str..."

2014-02-13T02:34:41Z

Created page with "= Config script = Used to get access to a specific script-related functions. '''Visibility:''' Global. == List of functions == {{Scripting_api|RestrictFunctionByTime| * str..."

New page

= Config script =
Used to get access to a specific script-related functions.

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|RestrictFunctionByTime|
* string: name * float: seconds|
void |
<nowiki>script.RestrictFunctionByTime("some_function", 10);</nowiki> |
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.
}}

{{Scripting_api|RestrictFunctionFPS|
* string: name * int: fps|
void |
<nowiki>script.RestrictFunctionFPS("some_function", 10);</nowiki> |
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.
}}

{{Scripting_api|GetSecondsMultiplier|
|
void |
<nowiki>var time = script.GetSecondsMultiplier();</nowiki> |
Returns time since this function was called last time. Works properly only if function
was restricted with RestrictFunctionByTime/RestrictFunctionFPS
}}