Trigger event

From Blood Wiki
Revision as of 08:14, 12 July 2012 by VorteX (Talk | contribs)

Jump to: navigation, search

Trigger event (verb to trigger) is most useful event. It allows interaction between many game aspects.

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.

But structure of event is same all the time.

Contents

Event input

  • self - entity trigger event is being processed on
  • activator - who lets event go (usually player)
  • parameters - instructions for trigger event, fetched from "targetparm" field of self.

Event rules

  • Instructions are case insensative
  • ';' is the separator between instructions
  • If trigger instructions not begin with "SELECT ", "SELECT TARGETS;" is automatically added
  • Empty instructions defaults to "SELECT TARGETS;CALL"


Instructions

Order Syntax Description
1 SELECT/ADD Starts (select) and expands (add) selection of entities, which will be called.
  • SELECT TARGETS - select entity to which i'm targeted
  • SELECT TARGETERS - select entities which are targeted to me
  • SELECT BYID <id1> <id2> <id3> ... <idX> - select entities by their save id's
  • SELECT BYTARGETNAME <targetname1> <targetname2> ... <targetnameX> - select entities by their save id's
2 INFOPORTION <OPERATOR> Manipulate infoportions on activator.
  • INFOPORTION SET infoportion - add/update infoportion
  • INFOPORTION DEL infoportion - delete infoportion
  • INFOPORTION INC infoportion [increase_by] - increase infoportion value by 1 or by custom value (of presented)
  • INFOPORTION DEC infoportion [decrease_by] - increase infoportion value by 1 or by custom value (of presented)
3 CALL This triggers all selected entities with their default action.

Can prefix this instruction with <classname:>. In this case trigger event will only be processed on entities with matching class name.

Examples:

select targets;effect_light:call
select byid 145;call
4 <CUSTOM ACTION> 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
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.

Name Key Description Default value
Common item keys
Target target This entity till be triggered when item is picked.
Target parameters targetparm Instructions for trigger event; Type "nocall" here to disable trigger event.
Targetname targetname 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.
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox