VoidExpanse/scope-actions - Revision history

Damonwall: /* List of functions */

2014-02-14T10:37:43Z

List of functions

← Older revision		Revision as of 10:37, 14 February 2014
Line 14:		Line 14:
	* string: event_name		* string: event_name
	* string: function_name\|		* string: function_name\|
	~~bool - returns whether function was hooked to event, or not (due to some errors)~~\|		void\|
	<pre style="margin:0px">actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");</pre> \|		<pre style="margin:0px">actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");</pre> \|
	Binds script's function to some in-game event. This function will be called every time event		Binds script's function to some in-game event. This function will be called every time event

Damonwall at 09:03, 14 February 2014

2014-02-14T09:03:07Z

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

	= ~~Config~~ actions =		= Scope actions =
	Used to work with events, such as triggers and events.		Used to work with events, such as triggers and events.
	More info about events in [[VoidExpanse/events]].		More info about events in [[VoidExpanse/events\|Events]].

	'''Visibility:''' Global.		'''Visibility:''' Global.

Atomic-admin at 04:04, 13 February 2014

2014-02-13T04:04:25Z

@@ Line 23: / Line 23: @@
 }}
 {{Scripting_api|BindToTrigger|
@@ Line 33: / Line 61: @@
       tags_class: "alien_hive",
       killer_ship_id: topic.GetCurrentShipId()
-});</pre> |
+});</pre>|
-Binds script's function to specific trigger (triggers are almost the same as events, but
+<nowiki>Binds script's function to specific trigger (triggers are almost the same as events, but
 they also can have parameters, that'll be filtered on C# level, thus making script to work faster).
 Parameters, specified as third argument, must furfill following requirements:
 * parameter names must be exactly the same as those, with which trigger is invoked
-* parameter can also use special forms, like this one: we can filter all npc-related triggers also by npc's tags, like this: tags_VARNAME_IN_TAGS. Like it was done in an example above - function will be called only when npc with tags.class == "alien_hive" is killed.
+* parameter can also use special forms, like this one: we can filter all npc-related triggers also by npc's tags, like this: tags_VARNAME_IN_TAGS. Like it was done in an example above - function will be called only when npc with tags.class == "alien_hive" is killed.</nowiki>
 }}
 {{Scripting_api|InvokeTrigger|
@@ Line 63: / Line 76: @@
 Invokes trigger with parameters. As trigger name you can use any string you like, if no one
 was subscribed to this trigger - it'll simply be ignored. The same goes to parameters.
 }}

Damonwall: /* List of functions */

2014-02-13T03:46:17Z

List of functions

← Older revision		Revision as of 03:46, 13 February 2014
Line 15:		Line 15:
	* string: function_name\|		* string: function_name\|
	bool - returns whether function was hooked to event, or not (due to some errors)\|		bool - returns whether function was hooked to event, or not (due to some errors)\|
	<~~nowiki~~>actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");</~~nowiki~~> \|		<pre style="margin:0px">actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");</pre> \|
	Binds script's function to some in-game event. This function will be called every time event		Binds script's function to some in-game event. This function will be called every time event
	occurs, for example, if function was bound to "OnShipDestroyed" event, it'll be called every time		occurs, for example, if function was bound to "OnShipDestroyed" event, it'll be called every time
Line 29:		Line 29:
	* object: parameters\|		* object: parameters\|
	void\|		void\|
	<~~nowiki~~>topic.Bind("onNpcDie", "OnHiveKilled",		<pre style="margin:0px">topic.Bind("onNpcDie", "OnHiveKilled",
	{		{
	tags_class: "alien_hive",		tags_class: "alien_hive",
	killer_ship_id: topic.GetCurrentShipId()		killer_ship_id: topic.GetCurrentShipId()
	});</~~nowiki~~> \|		});</pre> \|
	Binds script's function to specific trigger (triggers are almost the same as events, but		Binds script's function to specific trigger (triggers are almost the same as events, but
	they also can have parameters, that'll be filtered on C# level, thus making script to work faster).		they also can have parameters, that'll be filtered on C# level, thus making script to work faster).
Line 44:		Line 44:
	* string: event_name\|		* string: event_name\|
	void\|		void\|
	<~~nowiki~~>actions.Clear("OnNpcDie");</~~nowiki~~> \|		<pre style="margin:0px">actions.Clear("OnNpcDie");</pre> \|
	Removes all subscriptions to specified event. Also includes subscriptions made from another scripts.		Removes all subscriptions to specified event. Also includes subscriptions made from another scripts.
	}}		}}
Line 51:		Line 51:
	* string: event_name\|		* string: event_name\|
	void\|		void\|
	<~~nowiki~~>actions.Create("MyEvent");</~~nowiki~~> \|		<pre style="margin:0px">actions.Create("MyEvent");</pre> \|
	Creates custom event, to which other scripts can bind their functions. Later can be invoked using function Start (see below)		Creates custom event, to which other scripts can bind their functions. Later can be invoked using function Start (see below)
	}}		}}
Line 60:		Line 60:
	* object: args \|		* object: args \|
	void\|		void\|
	<~~nowiki~~>actions.InvokeTrigger("onSystemLiberated", {system_id: sys_id});</~~nowiki~~> \|		<pre style="margin:0px">actions.InvokeTrigger("onSystemLiberated", {system_id: sys_id});</pre> \|
	Invokes trigger with parameters. As trigger name you can use any string you like, if no one		Invokes trigger with parameters. As trigger name you can use any string you like, if no one
	was subscribed to this trigger - it'll simply be ignored. The same goes to parameters.		was subscribed to this trigger - it'll simply be ignored. The same goes to parameters.
Line 69:		Line 69:
	* string: event_name\|		* string: event_name\|
	void\|		void\|
	<~~nowiki~~>actions.Remove("MyEvent");</~~nowiki~~> \|		<pre style="margin:0px">actions.Remove("MyEvent");</pre> \|
	Removes custom event, that was created with actions.Create method.		Removes custom event, that was created with actions.Create method.
	}}		}}
Line 78:		Line 78:
	* object: args\|		* object: args\|
	void\|		void\|
	<~~nowiki~~>actions.Start("MyEvent", {my_name: "dlirry"})</~~nowiki~~> \|		<pre style="margin:0px">actions.Start("MyEvent", {my_name: "dlirry"})</pre> \|
	Invokes event with specified parameters, that'll force all subscribed functions to be called.		Invokes event with specified parameters, that'll force all subscribed functions to be called.
	}}		}}
Line 86:		Line 86:
	* string: function_name\|		* string: function_name\|
	void\|		void\|
	<~~nowiki~~>actions.UnbindFromTrigger("myTrigger", "MyTriggerHandler")</~~nowiki~~> \|		<pre style="margin:0px">actions.UnbindFromTrigger("myTrigger", "MyTriggerHandler")</pre> \|
	Unbinds specified function from trigger.		Unbinds specified function from trigger.
	}}		}}
Line 93:		Line 93:
	void\|		void\|
	void\|		void\|
	<~~nowiki~~>actions.UnbindFromTriggers();</~~nowiki~~> \|		<pre style="margin:0px">actions.UnbindFromTriggers();</pre> \|
	Unbinds all script's function from triggers. Useful, when you want to destroy script or do not want to use it anymore,		Unbinds all script's function from triggers. Useful, when you want to destroy script or do not want to use it anymore,
	and you want to quickly get rid of all script's trigger dependencies and subscriptions.		and you want to quickly get rid of all script's trigger dependencies and subscriptions.
	}}		}}

Damonwall: /* Config actions */

2014-02-13T03:14:13Z

Config actions

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

	= Config actions =		= Config actions =
	Used to work with events, such as triggers and events.		Used to work with events, such as triggers and events.

Damonwall: Created page with "= Config actions = Used to work with events, such as triggers and events. More info about events in VoidExpanse/events. '''Visibility:''' Global. == List of functions ==..."

2014-02-13T03:12:20Z

Created page with "= Config actions = Used to work with events, such as triggers and events. More info about events in VoidExpanse/events. '''Visibility:''' Global. == List of functions ==..."

New page

= Config actions =
Used to work with events, such as triggers and events.
More info about events in [[VoidExpanse/events]].

'''Visibility:''' Global.

== List of functions ==

{{Scripting_api|Bind|
* string: event_name
* string: function_name|
bool - returns whether function was hooked to event, or not (due to some errors)|
<nowiki>actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");</nowiki> |
Binds script's function to some in-game event. This function will be called every time event
occurs, for example, if function was bound to "OnShipDestroyed" event, it'll be called every time
any ship is destroyed.
Note: you can bind not only to standard events, but also to events you've created. To know, how to create
your own event, look into Create & Start functions of actions scope.
}}

{{Scripting_api|BindToTrigger|
* string: trigger_name
* string: function_name
* object: parameters|
void|
<nowiki>topic.Bind("onNpcDie", "OnHiveKilled",
{
tags_class: "alien_hive",
killer_ship_id: topic.GetCurrentShipId()
});</nowiki> |
Binds script's function to specific trigger (triggers are almost the same as events, but
they also can have parameters, that'll be filtered on C# level, thus making script to work faster).
Parameters, specified as third argument, must furfill following requirements:
* parameter names must be exactly the same as those, with which trigger is invoked
* parameter can also use special forms, like this one: we can filter all npc-related triggers also by npc's tags, like this: tags_VARNAME_IN_TAGS. Like it was done in an example above - function will be called only when npc with tags.class == "alien_hive" is killed.
}}

{{Scripting_api|Clear|
* string: event_name|
void|
<nowiki>actions.Clear("OnNpcDie");</nowiki> |
Removes all subscriptions to specified event. Also includes subscriptions made from another scripts.
}}

{{Scripting_api|Create|
* string: event_name|
void|
<nowiki>actions.Create("MyEvent");</nowiki> |
Creates custom event, to which other scripts can bind their functions. Later can be invoked using function Start (see below)
}}

{{Scripting_api|InvokeTrigger|
* string: trigger_name
* object: args |
void|
<nowiki>actions.InvokeTrigger("onSystemLiberated", {system_id: sys_id});</nowiki> |
Invokes trigger with parameters. As trigger name you can use any string you like, if no one
was subscribed to this trigger - it'll simply be ignored. The same goes to parameters.
}}

{{Scripting_api|Remove|
* string: event_name|
void|
<nowiki>actions.Remove("MyEvent");</nowiki> |
Removes custom event, that was created with actions.Create method.
}}

{{Scripting_api|Start|
* string: event_name
* object: args|
void|
<nowiki>actions.Start("MyEvent", {my_name: "dlirry"})</nowiki> |
Invokes event with specified parameters, that'll force all subscribed functions to be called.
}}

{{Scripting_api|UnbindFromTrigger|
* string: trigger_name
* string: function_name|
void|
<nowiki>actions.UnbindFromTrigger("myTrigger", "MyTriggerHandler")</nowiki> |
Unbinds specified function from trigger.
}}

{{Scripting_api|UnbindFromTriggers|
void|
void|
<nowiki>actions.UnbindFromTriggers();</nowiki> |
Unbinds all script's function from triggers. Useful, when you want to destroy script or do not want to use it anymore,
and you want to quickly get rid of all script's trigger dependencies and subscriptions.
}}