Difference between revisions of "Osiris/API/TriggerRegisterForPlayers"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
Line 3: Line 3:
 
===== Description =====
 
===== Description =====
 
Registers the '''_Trigger''' for all '''''current''''' player characters, so that that whenever one of them enters or leaves the '''_Trigger''', a [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] resp. [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] event will be thrown for this trigger/character combination.
 
Registers the '''_Trigger''' for all '''''current''''' player characters, so that that whenever one of them enters or leaves the '''_Trigger''', a [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] resp. [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] event will be thrown for this trigger/character combination.
===== Return Values =====
 
* None
 
 
===== Notes =====
 
===== Notes =====
 
* [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters by the engine and can not be unregistered.
 
* [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters by the engine and can not be unregistered.

Revision as of 12:39, 1 November 2018

Full Definition(s)
  • call TriggerRegisterForPlayers((TRIGGERGUID)_Trigger)
Description

Registers the _Trigger for all current player characters, so that that whenever one of them enters or leaves the _Trigger, a CharacterEnteredTrigger resp. CharacterLeftTrigger event will be thrown for this trigger/character combination.

Notes
  • Event triggers are automatically registered for all characters by the engine and can not be unregistered.
  • ProcTriggerRegisterForPlayers ensures that the _Trigger is also registerd for characters who become players at a later point (i.e. characters recruited into the party). Use this procedure rather than the TriggerRegisterForPlayers call directly.
See Also