Difference between revisions of "Osiris/Shared/DB TriggerSendsSpotEvents"
From Divinity Engine Wiki
(Documented DB_TriggerSendsSpotEvents) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
* '''DB_TriggerSendsSpotEvents'''(''(TIGGERGUID)'''''_Trigger''') | * '''DB_TriggerSendsSpotEvents'''(''(TIGGERGUID)'''''_Trigger''') | ||
| − | * '''DB_Event_CharacterDisappearedInSpotTrigger'''(''(CHARACTERGUID)'''''_Player''', ''(TRIGGERGUID)'''''_Trigger'') | + | * '''DB_Event_CharacterAppearedInSpotTrigger'''(''(CHARACTERGUID)'''''_Player''', ''(TRIGGERGUID)'''''_Trigger''') |
| + | * '''DB_Event_CharacterDisappearedInSpotTrigger'''(''(CHARACTERGUID)'''''_Player''', ''(TRIGGERGUID)'''''_Trigger''') | ||
===== Description ===== | ===== Description ===== | ||
| − | '''DB_TriggerSendsSpotEvents''' [[Osiris/Shared/ProcTriggerRegisterForPlayers|registers]] '''_Trigger''' for all players. Whenever a player enters such a trigger and they do not have the '''INVISIBLE''' status and they are not sneaking, a ''' | + | '''DB_TriggerSendsSpotEvents''' [[Osiris/Shared/ProcTriggerRegisterForPlayers|registers]] '''_Trigger''' for all players. |
| + | |||
| + | Whenever a player enters such a trigger and they do not have the '''INVISIBLE''' status and they are not sneaking, or they lose the invisible/sneaking status while inside such a trigger, a '''DB_Event_CharacterAppearedInSpotTrigger''' fact will be defined with this '''_Player''' and the '''_Trigger'''. | ||
| + | |||
| + | Similarly, when a player leaves such a trigger while not invisible/sneaking, or becomes invisible/starts sneaking while inside such a trigger, a '''DB_Event_CharacterDisappearedInSpotTrigger''' fact will be defined with this '''_Player''' and '''_Trigger'''. | ||
| + | |||
===== Notes ===== | ===== Notes ===== | ||
| − | * | + | * The '''DB_Event_CharacterAppearedInSpotTrigger''' and '''DB_Event_CharacterDisappearedInSpotTrigger''' facts are immediately undefined after they have been defined, so that the next such event can be caught as well (redefining an existing database fact would not throw a new event). |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | * [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]] | ||
* [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] | * [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]] | ||
* [[Osiris/API/TriggerRegisterForPlayers|TriggerRegisterForPlayers]] | * [[Osiris/API/TriggerRegisterForPlayers|TriggerRegisterForPlayers]] | ||
| − | * | + | * Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]] |
| − | * | + | * Helper [[Osiris/Shared/ProcTriggerRegisterForPlayers|ProcTriggerRegisterForPlayers]] |
[[Category:Osiris Shared Mod Helpers|TriggerSendsSpotEvents]] | [[Category:Osiris Shared Mod Helpers|TriggerSendsSpotEvents]] | ||
Latest revision as of 22:33, 7 February 2018
Full Definition(s)
- DB_TriggerSendsSpotEvents((TIGGERGUID)_Trigger)
- DB_Event_CharacterAppearedInSpotTrigger((CHARACTERGUID)_Player, (TRIGGERGUID)_Trigger)
- DB_Event_CharacterDisappearedInSpotTrigger((CHARACTERGUID)_Player, (TRIGGERGUID)_Trigger)
Description
DB_TriggerSendsSpotEvents registers _Trigger for all players.
Whenever a player enters such a trigger and they do not have the INVISIBLE status and they are not sneaking, or they lose the invisible/sneaking status while inside such a trigger, a DB_Event_CharacterAppearedInSpotTrigger fact will be defined with this _Player and the _Trigger.
Similarly, when a player leaves such a trigger while not invisible/sneaking, or becomes invisible/starts sneaking while inside such a trigger, a DB_Event_CharacterDisappearedInSpotTrigger fact will be defined with this _Player and _Trigger.
Notes
- The DB_Event_CharacterAppearedInSpotTrigger and DB_Event_CharacterDisappearedInSpotTrigger facts are immediately undefined after they have been defined, so that the next such event can be caught as well (redefining an existing database fact would not throw a new event).
