VoidExpanse/scope-actions: Difference between revisions
| 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)| | ||
< | <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| | ||
< | <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() | ||
});</ | });</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| | ||
< | <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| | ||
< | <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| | ||
< | <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| | ||
< | <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| | ||
< | <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| | ||
< | <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| | ||
< | <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. | ||
}} | }} | ||
Revision as of 03:46, 13 February 2014
Config actions
Used to work with events, such as triggers and events. More info about events in VoidExpanse/events.
Visibility: Global.
List of functions
| Bind | ||
|---|---|---|
| Arguments | Returns | Example |
|
bool - returns whether function was hooked to event, or not (due to some errors) |
actions.Bind("OnShipDestroyed", "OnShipDestroyedHandler");
|
| Description | ||
|
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. | ||
| BindToTrigger | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
topic.Bind("onNpcDie", "OnHiveKilled",
{
tags_class: "alien_hive",
killer_ship_id: topic.GetCurrentShipId()
});
|
| Description | ||
| {{{5}}} | ||
| Clear | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.Clear("OnNpcDie");
|
| Description | ||
|
Removes all subscriptions to specified event. Also includes subscriptions made from another scripts. | ||
| Create | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.Create("MyEvent");
|
| Description | ||
|
Creates custom event, to which other scripts can bind their functions. Later can be invoked using function Start (see below) | ||
| InvokeTrigger | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.InvokeTrigger("onSystemLiberated", {system_id: sys_id});
|
| Description | ||
|
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. | ||
| Remove | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.Remove("MyEvent");
|
| Description | ||
|
Removes custom event, that was created with actions.Create method. | ||
| Start | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.Start("MyEvent", {my_name: "dlirry"})
|
| Description | ||
|
Invokes event with specified parameters, that'll force all subscribed functions to be called. | ||
| UnbindFromTrigger | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
actions.UnbindFromTrigger("myTrigger", "MyTriggerHandler")
|
| Description | ||
|
Unbinds specified function from trigger. | ||
| UnbindFromTriggers | ||
|---|---|---|
| Arguments | Returns | Example |
|
void |
void |
actions.UnbindFromTriggers(); |
| Description | ||
|
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. | ||