Difference between revisions of "Osiris/API/TriggerUnregisterForCharacter"
From Divinity Engine Wiki
m (Updated event trigger link) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
* call '''TriggerUnregisterForCharacter'''(''(TRIGGERGUID)'''''_Trigger''', ''(CHARACTERGUID)'''''_Character''') | * call '''TriggerUnregisterForCharacter'''(''(TRIGGERGUID)'''''_Trigger''', ''(CHARACTERGUID)'''''_Character''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Stops [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] events from being thrown whenever '''_Character''' enters '''_Trigger'''. | + | Stops [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] and [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] events from being thrown whenever '''_Character''' enters/leaves '''_Trigger'''. |
===== Return Values ===== | ===== Return Values ===== | ||
* None | * None | ||
===== 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. | + | * [[Triggers#Event_Trigger|Event]] triggers are automatically registered for all characters (and items) by the engine and should not be manually registered/unregistered. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | * [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | ||
| Line 17: | Line 17: | ||
* Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | * Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|TriggerUnregisterForCharacter]] |
Latest revision as of 06:30, 23 October 2018
Full Definition(s)
- call TriggerUnregisterForCharacter((TRIGGERGUID)_Trigger, (CHARACTERGUID)_Character)
Description
Stops CharacterEnteredTrigger and CharacterLeftTrigger events from being thrown whenever _Character enters/leaves _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 (and items) by the engine and should not be manually registered/unregistered.
