Difference between revisions of "Osiris/API/TriggerUnregisterForPlayers"
From Divinity Engine Wiki
(Documented TriggerUnregisterForPlayers) |
m (→Notes) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
===== Notes ===== | ===== Notes ===== | ||
* If you unregister a trigger for a character while the character was inside the trigger and the trigger was previously registered for that character, a [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] event will be thrown. | * If you unregister a trigger for a character while the character was inside the trigger and the trigger was previously registered for that character, a [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] event will be thrown. | ||
| + | * [[Triggers#Event_Trigger|Event triggers]] are automatically registered for all characters by the engine and should not be manually registered/unregistered. | ||
| + | |||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | * [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | ||
| Line 16: | Line 18: | ||
* Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | * Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|TriggerUnregisterForPlayers]] |
Latest revision as of 11:41, 1 November 2018
Full Definition(s)
- call TriggerUnregisterForPlayers((TRIGGERGUID)_Trigger)
Description
Stops CharacterEnteredTrigger events from being thrown whenever a player character enters _Trigger.
Return Values
- None
Notes
- If you unregister a trigger for a character while the character was inside the trigger and the trigger was previously registered for that character, a CharacterLeftTrigger event will be thrown.
- Event triggers are automatically registered for all characters by the engine and should not be manually registered/unregistered.
