Difference between revisions of "Osiris/API/TriggerRegisterForPlayers"
From Divinity Engine Wiki
m |
|||
| Line 2: | Line 2: | ||
* call '''TriggerRegisterForPlayers'''(''(TRIGGERGUID)'''''_Trigger''') | * call '''TriggerRegisterForPlayers'''(''(TRIGGERGUID)'''''_Trigger''') | ||
===== Description ===== | ===== Description ===== | ||
| − | + | Registers the '''_Trigger''' for all current player characters, to 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 ===== | ===== Return Values ===== | ||
* None | * None | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters by the engine and | + | * [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters by the engine and can not be unregistered. |
| + | * [[Osiris/Shared/ProcTriggerRegisterForPlayers|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 ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | * [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | ||
Revision as of 17:15, 8 January 2018
Full Definition(s)
- call TriggerRegisterForPlayers((TRIGGERGUID)_Trigger)
Description
Registers the _Trigger for all current player characters, to that that whenever one of them enters or leaves the _Trigger, a CharacterEnteredTrigger resp. CharacterLeftTrigger event will be thrown for this trigger/character combination.
Return Values
- None
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.
