Editing Trigger event

Jump to: navigation, search

Warning: You are not logged in.

Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{TOCRIGHT}}
+
Trigger event (verb ''to trigger'') is most useful event. It allows interaction between many game aspects.
Trigger event (verb '''''to trigger''''') is most useful event. It allows interaction between game objects.
+
  
Many entities can trigger other entities, or be triggered. For example you could open and close a door with a button, so here the button triggers the door. Not only buttons can trigger things, for example enemy could trigger a door when dies.
+
It happens when trigger get touched, on monster dies, each object can have it's own behavior and launch trigger event under it's own circumstances.
  
In Blood Omnicide, trigger event can have custom instructions which is used to control the way entities react to the event.  
+
But structure of event is same all the time.
  
===Event input===
+
=== Event input ===
  
 
* self - entity trigger event is being processed on
 
* self - entity trigger event is being processed on
Line 12: Line 11:
 
* parameters - instructions for trigger event, fetched from "targetparm" field of self.
 
* parameters - instructions for trigger event, fetched from "targetparm" field of self.
  
===Event rules===
+
=== Event rules ===
  
 
* Instructions are case insensative
 
* Instructions are case insensative
* Instruction keywords are separated by space and TAB (except for braces)
 
 
* ';' is the separator between instructions
 
* ';' is the separator between instructions
* If trigger instructions not begin with "SELECT ", scripts automatically executes "SELECT TARGETS" at beginning.
+
* If trigger instructions not begin with "SELECT ", "SELECT TARGETS;" is automatically added
 
* Empty instructions defaults to "SELECT TARGETS;CALL"
 
* Empty instructions defaults to "SELECT TARGETS;CALL"
  
==Instructions==
+
= Instructions =
  
'''SELECT/ADD'''
+
{| width=85% cellspacing=0 cellpadding=4 border=1 style="border-collapse: collapse"
:Starts (select) or expands (add) selection of [[Entity | entities]].
+
! width=2% | Order
:* SELECT TARGETS - select entity to which i'm targeted
+
! width=10% | Syntax
:* SELECT TARGETERS - select entities which are targeted to me
+
! width=88% | Description
:* SELECT BYID ''<id1> <id2> <id3> ... <idX>'' - select entities by their save id's
+
|-
:* SELECT BYTARGETNAME ''<targetname1> <targetname2> ... <targetnameX>'' - select entities by their targetnames
+
| align=center | 1
 +
| SELECT/ADD
 +
| Starts (select) and expands (add) selection of [[Entity | entities]], which will be called.
  
'''INFOPORTION ''OPERATOR'''''
+
* SELECT TARGETS - select entity to which i'm targeted
:Manipulate [[Infoportions | infoportions]] on activator:
+
* SELECT TARGETERS - select entities which are targeted to me
:* '''INFO SET''' ''infoportion'' - add/update infoportion
+
* SELECT BYID ''<id1> <id2> <id3> ... <idX>'' - select entities by their save id's
:* '''INFO DEL''' ''infoportion'' - delete infoportion
+
* SELECT BYTARGETNAME ''<targetname1> <targetname2> ... <targetnameX>'' - select entities by their save id's
:* '''INFO INC''' ''infoportion'' ''increase_by'' - increase infoportion value by 1 or by custom value (of presented)
+
|-
:* '''INFO DEC''' ''infoportion'' ''decrease_by'' - increase infoportion value by 1 or by custom value (of presented)
+
| align=center | 2
 +
| INFOPORTION <OPERATOR>
 +
| Manipulate [[Infoportion | infoportions]] on activator.
  
'''CALL'''
+
* INFOPORTION SET ''infoportion'' - add/update infoportion
:This triggers all selected entities with their default action.
+
* INFOPORTION DEL ''infoportion'' - delete infoportion
:Can prefix this instruction with <classname:>. In this case trigger event will only be processed on entities with matching class name.
+
* INFOPORTION INC ''infoportion'' ''[increase_by]'' - increase infoportion value by 1 or by custom value (of presented)
:Examples:
+
* INFOPORTION DEC ''infoportion'' ''[decrease_by]'' - increase infoportion value by 1 or by custom value (of presented)
::select targets;effect_light:call
+
|-
::select byid 145;call
+
| align=center | 3
 +
| CALL
 +
| This triggers all selected entities with their default action.
  
'''''CUSTOM ACTION'''''
+
Can prefix this instruction with <classname:>. In this case trigger event will only be processed on entities with matching class name.
:One of object's supported custom trigger actions. Classname filter is supported.
+
:Examples:
+
::select targets;effect_light:on
+
::select byid 145;trigger_puzzle:toggle 2 1 3
+
  
'''BREAK or NOCALL'''
+
Examples:
:Immediately exit trigger event.
+
  
==Event keys==
+
select targets;effect_light:call
  
Trigger event have general keys that is used for it.
+
select byid 145;call
 +
|-
 +
| align=center | 4
 +
| <CUSTOM ACTION>
 +
| One of object's supported custom trigger actions. Classname filter is supported.
  
Sometimes this keys are used by other kind of events too. This special behavior (if presented) is defined in particular class reference.
+
Examples:
  
{{entity fields}}
+
select targets;effect_light:on
 +
 
 +
select byid 145;trigger_puzzle:toggle 2 1 3
 +
|-
 +
| align=center | 5
 +
| BREAK or NOCALL
 +
| Immediately exit trigger event.
 +
|}
 +
 
 +
= Event keys =
 +
 
 +
Trigger event have general keys that is used for it, sometimes this keys are used by other kind of events too. This special behavior is defined in particular class reference.
 +
 
 +
{| cellspacing=0 cellpadding=5 border=1 style="border-collapse: collapse"
 +
! width=10% | Name
 +
! width=10% | Key
 +
! width=70% | Description
 +
! width=10% | Default value
 +
|-
 +
| colspan=3 | '''Common item keys'''
 
|-
 
|-
 
| Target
 
| Target
 
| target
 
| target
| All entities with matching targetname will be triggered.
+
| This entity till be triggered when item is picked.
 
|-
 
|-
 
| Target parameters
 
| Target parameters
 
| targetparm
 
| targetparm
| When entity is triggered, this is instructions for trigger event (see instructions above);
+
| Instructions for trigger event; Type "nocall" here to disable trigger event.
 
|-
 
|-
 
| Targetname
 
| Targetname
 
| targetname
 
| targetname
| Entities with matching target will trigger this entity.
+
| If set, item becomes hidden and got spawned when triggered. If target is set, item will perform spawn move from the center of it's targeter.
{{entity fields end}}
+
|}
 
+
== See also ==
+
* [[Pattern script]]
+
 
+
{{finished}}
+

Please note that all contributions to Blood Wiki are considered to be released under the Creative Commons Attribution Share Alike (see BloodWiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

This page is a member of 1 hidden category:

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox