Difference between revisions of "Osiris/API/CharacterEnteredTrigger"
From Divinity Engine Wiki
m (Removed gremlin |) |
m |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* event '''CharacterEnteredTrigger'''(''(CHARACTERGUID)'''''_Character''', ''(TRIGGERGUID)'''''__Trigger''') | * event '''CharacterEnteredTrigger'''(''(CHARACTERGUID)'''''_Character''', ''(TRIGGERGUID)'''''__Trigger''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Thrown when a character enters a trigger that was | + | Thrown when a character enters a trigger that was registered for it previously. |
===== Parameters ===== | ===== Parameters ===== | ||
* '''_Character''': the character that entered the trigger. | * '''_Character''': the character that entered the trigger. | ||
* '''_Trigger''': the trigger in which the character entered. | * '''_Trigger''': the trigger in which the character entered. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * If you | + | * If you register a trigger for a character while the character is currently inside the trigger, this event will also be thrown. This even holds for characters placed in the editor and triggers registered in the INIT section of a story goal that gets initialised once the [[Osiris/API/RegionStarted|RegionStarted]] event for its containing level has executed. |
* If a trigger has been registered for several characters and you wish to check which of those characters are currently in it, use the [[Osiris/Shared/DB_InRegion|DB_InRegion()]] database. | * If a trigger has been registered for several characters and you wish to check which of those characters are currently in it, use the [[Osiris/Shared/DB_InRegion|DB_InRegion()]] database. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] | * [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] | ||
| + | * [[Osiris/API/ObjectIsInTrigger|ObjectIsInTrigger]] | ||
* [[Osiris/API/TriggerRegisterForCharacter|TriggerRegisterForCharacter]] | * [[Osiris/API/TriggerRegisterForCharacter|TriggerRegisterForCharacter]] | ||
* [[Osiris/API/TriggerUnregisterForCharacter|TriggerUnregisterForCharacter]] | * [[Osiris/API/TriggerUnregisterForCharacter|TriggerUnregisterForCharacter]] | ||
| Line 18: | Line 19: | ||
* Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | * Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] | ||
| − | [[Category:Osiris Events]] | + | [[Category:Osiris Events|CharacterEnteredTrigger]] |
Latest revision as of 10:49, 15 May 2019
Full Definition(s)
- event CharacterEnteredTrigger((CHARACTERGUID)_Character, (TRIGGERGUID)__Trigger)
Description
Thrown when a character enters a trigger that was registered for it previously.
Parameters
- _Character: the character that entered the trigger.
- _Trigger: the trigger in which the character entered.
Notes
- If you register a trigger for a character while the character is currently inside the trigger, this event will also be thrown. This even holds for characters placed in the editor and triggers registered in the INIT section of a story goal that gets initialised once the RegionStarted event for its containing level has executed.
- If a trigger has been registered for several characters and you wish to check which of those characters are currently in it, use the DB_InRegion() database.
