Divinity Engine Wiki - User contributions [en]

Osiris

2023-10-10T10:36:08Z

Tinkerer:

{{warning|In general, you '''''cannot''''' use Osiris scripting in Game Master mode. The reason is that when a Game Master mode savegame is loaded, all database facts from the savegame are deleted and the story is reinitialised from scratch. This was a conscious design decision of Game master Mode, because everything should be under direct control of the game master. You can use [[Scripting|behaviour scripts]], though.}}

* [[Osiris_Overview|Osiris Overview]]
* [[Osiris_Design_Patterns|Osiris Design Patterns]]
* [[Osiris_Gotchas|Osiris Gotchas]]
* [[:Category:Osiris_APIs|Osiris API]]

* [https://www.youtube.com/watch?v=6CNcQz7j5KY&list=PLE13woN-fNgu6IuHZguk-VJE6xWCHh9bJ&index=12 Osiris tutorial videos from DOS1] (the language has changed a little, but the base concepts are still the same and these videos are still 99% relevant; you can ignore the last one about dialogs, as the dialog system has changed completely)

[[Category:Osiris]]

Osiris/API/ObjectReadyInCombat

2021-08-13T13:32:16Z

Tinkerer:

===== Full Definition(s) =====
* event '''ObjectReadyInCombat'''(''(GUIDSTRING)'''''_Object''', ''(INTEGER)'''''_CombatID''')
===== Description =====
Thrown when an object (character or item) has entered a combat and all combat initialisation related to this object has finished.
===== Parameters =====
* '''_Object''': The object that has entered the combat
* '''_CombatID''': A handle that identifies the combat. Should always be > 0.
===== Notes =====
* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
* If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as [[Osiris/API/JumpToTurn|JumpToTurn]] yet. If you wish to perform some action when a combat has completely started, use [[Osiris/API/CombatStarted|CombatStarted]] instead. Note that if the combat had already been fully setup before (i.e., a [[Osiris/API/CombatStarted|CombatStarted]] event was already thrown for this combat in the past), no new [[Osiris/API/CombatStarted|CombatStarted]] event will be thrown due to this object entering.
* In practice, this event is useful to determine when you can use [[Osiris/API/JumpToTurn|JumpToTurn]] for objects joining an already ongoing combat. If you wish to use that API on objects joining a combat that has not yet started, you must wait until after the [[Osiris/API/CombatStarted|CombatStarted]] event.
===== See Also =====
* [[Osiris/API/CombatStarted|CombatStarted]]
* [[Osiris/API/ObjectEnteredCombat|ObjectEnteredCombat]]
* [[Osiris/API/ObjectLeftCombat|ObjectLeftCombat]]

[[Category:Osiris Events|ObjectReadyInCombat]]

Osiris/API/ItemSetStoryItem

2021-07-12T09:51:26Z

Tinkerer: /* Full Definition(s) */

===== Full Definition(s) =====
* call '''ItemSetStoryItem'''(''(ITEMGUID)'''''_Item''', ''(INTEGER)'''''_Bool''')

===== Description =====
Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:
* it cannot be marked as wares, nor can any container that contains it be marked as wares, nor can it be added to the wares when picking it up
* it is marked as a quest item in the UI
* it cannot be traded to an NPC, and NPCs won't sell it either
* NPCs will never consume the item (e.g. in combat)
* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.
* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, but not in DOS2
===== Notes =====
* An item can also be marked as a story item in the properties of the item via the editor's sidebar.
* The [[Osiris/API/TransferItemsToCharacter|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser|TransferItemsToUser]] APIs will only transfer story items
===== See Also =====
* [[Osiris/API/ItemIsStoryItem|ItemIsStoryItem]]
* [[Osiris/API/TransferItemsToCharacter|TransferItemsToCharacter]]
* [[Osiris/API/TransferItemsToParty|TransferItemsToParty]]
* [[Osiris/API/TransferItemsToUser|TransferItemsToUser]]

[[Category:Osiris Calls|ItemSetStoryItem]]

Osiris/Shared/PROC StopFollow

2021-03-19T14:40:36Z

Tinkerer: Blanked the page

Osiris/Shared/ProcCharacterStopFollow

2021-03-19T14:40:28Z

Tinkerer:

===== Full Definition(s) =====
* PROC '''ProcCharacterStopFollow'''(''(CHARACTERGUID)'''''_Char''')
===== Description =====
Counterpart of [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]].
===== Return Values =====
* /<u> </u>
===== Notes =====
* /
===== See Also =====
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]

[[Category:Osiris Shared Mod Helpers|CharacterStopFollow]]

Osiris/Shared/PROC Follow

2021-03-19T14:39:40Z

Tinkerer: Blanked the page

Osiris/Shared/ProcCharacterFollowCharacter

2021-03-19T14:39:37Z

Tinkerer:

===== Full Definition(s) =====
* PROC '''ProcCharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Char''',''(CHARACTERGUID)'''''_Target''')
===== Description =====
Same as the Osiris call [[Osiris/API/CharacterFollowCharacter|CharacterFollowCharacter]], except that it also first automatically cancels '''_Char''' from following if it was already following someone else. Additionally, it stops the following behaviour when '''_Char''' gets involved in combat and resumes it afterwards.

===== Notes =====
* Stop following through [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]].

===== See Also =====
* [[Osiris/API/CharacterFollowCharacter|CharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]

[[Category:Osiris Shared Mod Helpers|CharacterFollowCharacter]]

Osiris/Shared/PROC Follow

2021-03-19T12:34:36Z

Tinkerer:

Osiris/Shared/PROC Follow

2021-03-19T12:34:20Z

Tinkerer: Blanked the page

Osiris/Shared/PROC StopFollow

2021-03-19T12:33:19Z

Tinkerer:

Osiris/Shared/PROC StopFollow

2021-03-19T12:32:31Z

Tinkerer: Blanked the page

Osiris/API/CharacterStopFollow

2021-03-19T12:31:29Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterStopFollow'''(''(CHARACTERGUID)'''''_Character''')
===== Description =====
Stop '''_Character''' from following another character, if it currently was following anyone.
===== Notes =====
* See [[Osiris/API/CharacterFollowCharacter]]
===== See Also =====
* [[Osiris/API/CharacterFollowCharacter|CharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]

[[Category:Osiris Calls|CharacterStopFollow]]

Osiris/API/StopFollow

2021-03-19T12:31:17Z

Tinkerer: Blanked the page

Osiris/API/CharacterFollowCharacter

2021-03-19T12:29:44Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterFollowCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID'')'''''_ToCharacter''')

===== Description =====
Makes '''_Character''' start following '''_ToCharacter'''.

===== Notes =====
* Preferably use [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]] from the Shared mod. This will ensure that '''_Character''''s following behaviour gets suspended when it enters combat, and resumed afterwards.
* Use [[Osiris/API/CharacterStopFollow|CharacterStopFollow]] to stop the following behaviour (or [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]] if you used [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]).
* Make sure to stop following a previous character before starting to follow a new one. [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]] will automatically take care of this.
* Note that this call does ''not'' turn '''_Character''' in a so-called "party follower" or minion, which is done via [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]. The difference between "regular followers" (as created by this routine) and party followers/minions is that regular followers simply follow any other character around (you can have one NPC follow another one, if you want), while party followers/minions always follow a player-controlled character and can be partially controlled by the [[Osiris/API/CharacterGetReservedUserID|user]] that controls this player character.

===== See Also =====
* [[Osiris/API/CharacterAddToPlayerCharacter|CharacterAddToPlayerCharacter]]
* [[Osiris/API/CharacterStopFollow|CharacterStopFollow]]
* Helper [[Osiris/Shared/ProcCharacterFollowCharacter|ProcCharacterFollowCharacter]]
* Helper [[Osiris/Shared/ProcCharacterStopFollow|ProcCharacterStopFollow]]

[[Category:Osiris Calls|CharacterFollowCharacter]]

Osiris/API/Follow

2021-03-19T12:29:33Z

Tinkerer: Blanked the page

Osiris/Shared/PROC StopFollow

2021-03-19T12:26:05Z

Tinkerer: Updated for bg3

===== Full Definition(s) =====
* PROC '''PROC_StopFollow'''(''(CHARACTER)'''''_Char''')
===== Description =====
Counterpart of [[Osiris/Shared/PROC_Follow|PROC_Follow]].
===== Notes =====

===== See Also =====
* [[Osiris/API/StopFollow|StopFollow]]
* Helper [[Osiris/Shared/PROC_Follow|PROC_Follow]]

[[Category:Osiris Shared Mod Helpers|StopFollow]]

Osiris/Shared/ProcCharacterStopFollow

2021-03-19T12:24:50Z

Tinkerer: Tinkerer moved page Osiris/Shared/ProcCharacterStopFollow to Osiris/Shared/PROC StopFollow: bg3 renames

#REDIRECT [[Osiris/Shared/PROC StopFollow]]

Osiris/Shared/PROC StopFollow

2021-03-19T12:24:50Z

Tinkerer: Tinkerer moved page Osiris/Shared/ProcCharacterStopFollow to Osiris/Shared/PROC StopFollow: bg3 renames

Osiris/Shared/PROC Follow

2021-03-19T12:24:36Z

Tinkerer: Updated for bg3

===== Full Definition(s) =====
* PROC '''PROC_Follow'''(''(CHARACTER)'''''_Char''',''(CHARACTER)'''''_Target''')
===== Description =====
Same as the Osiris call [[Osiris/API/Follow|Follow]], except that it also first automatically cancels '''_Char''' from following if it was already following someone else. Additionally, it stops the following behaviour when '''_Char''' gets involved in combat and resumes it afterwards.

===== Notes =====
* Stop following through [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]].

===== See Also =====
* [[Osiris/API/Follow|Follow]]
* Helper [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]]

[[Category:Osiris Shared Mod Helpers|Follow]]

Osiris/Shared/ProcCharacterFollowCharacter

2021-03-19T12:23:28Z

Tinkerer: typo fix

#REDIRECT [[Osiris/Shared/PROC Follow]]

Osiris/Shared/PROC Followe

2021-03-19T12:22:55Z

Tinkerer: Tinkerer moved page Osiris/Shared/PROC Followe to Osiris/Shared/PROC Follow: typo fix

#REDIRECT [[Osiris/Shared/PROC Follow]]

Osiris/Shared/PROC Follow

2021-03-19T12:22:55Z

Tinkerer: Tinkerer moved page Osiris/Shared/PROC Followe to Osiris/Shared/PROC Follow: typo fix

Osiris/Shared/ProcCharacterFollowCharacter

2021-03-19T12:22:43Z

Tinkerer: Tinkerer moved page Osiris/Shared/ProcCharacterFollowCharacter to Osiris/Shared/PROC Followe: bg3 renames

#REDIRECT [[Osiris/Shared/PROC Followe]]

Osiris/Shared/PROC Follow

2021-03-19T12:22:43Z

Tinkerer: Tinkerer moved page Osiris/Shared/ProcCharacterFollowCharacter to Osiris/Shared/PROC Followe: bg3 renames

Osiris/API/StopFollow

2021-03-19T12:22:30Z

Tinkerer:

===== Full Definition(s) =====
* call '''StopFollow'''(''(CHARACTERGUID)'''''_Follower''')
===== Description =====
Stop '''_Follower''' from following another character, if it currently was following anyone.
===== Notes =====
* See [[Osiris/API/Follow]]
===== See Also =====
* [[Osiris/API/Follow|Follow]]
* Helper [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]]

[[Category:Osiris Calls|StopFollow]]

Osiris/API/CharacterStopFollow

2021-03-19T12:22:22Z

Tinkerer: Tinkerer moved page Osiris/API/CharacterStopFollow to Osiris/API/StopFollow: bg3 renames

#REDIRECT [[Osiris/API/StopFollow]]

Osiris/API/StopFollow

2021-03-19T12:22:22Z

Tinkerer: Tinkerer moved page Osiris/API/CharacterStopFollow to Osiris/API/StopFollow: bg3 renames

Osiris/API/Follow

2021-03-19T12:17:10Z

Tinkerer: Updated for bg3

===== Full Definition(s) =====
* call '''Follow'''(''(CHARACTER)'''''_Follower''', ''(CHARACTER)'''''_Leader''')

===== Description =====
Makes '''_Follower''' start following '''_Leader'''.

===== Notes =====
* Preferably use [[Osiris/Shared/PROC_Follow|PROC_Follow]] from the Shared mod. This will ensure that '''_Follower''''s following behaviour gets suspended when it enters combat, and resumed afterwards.
* Use [[Osiris/API/StopFollow|StopFollow]] to stop the following behaviour (or [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]] if you used [[Osiris/Shared/PROC_Follow|PROC_Follow]]).
* Make sure to stop following a previous character before starting to follow a new one. [[Osiris/Shared/PROC_Follow|PROC_Follow]] will automatically take care of this.
* Note that this call does ''not'' turn '''_Character''' in a so-called [[Party_Followers|party follower]] or minion, which is done via [[Osiris/API/AddPartyFollower|AddPartyFollower]]. The difference between "regular followers" (as created by this routine) and party followers/minions is that regular followers simply follow any other character around (you can have one NPC follow another one, if you want), while party followers/minions always follow a player-controlled character and can be partially controlled by the [[Osiris/API/GetReservedUserID|user]] that controls this player character.

===== See Also =====
* [[Osiris/API/AddPartyFollower|AddPartyFollower]]
* [[Osiris/API/StopFollow|StopFollow]]
* Helper [[Osiris/Shared/PROC_Follow|PROC_Follow]]
* Helper [[Osiris/Shared/PROC_StopFollow|PROC_StopFollow]]

[[Category:Osiris Calls|Follow]]

Osiris/API/CharacterFollowCharacter

2021-03-19T12:13:33Z

Tinkerer: Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames

#REDIRECT [[Osiris/API/Follow]]

Osiris/API/Follow

2021-03-19T12:13:33Z

Tinkerer: Tinkerer moved page Osiris/API/CharacterFollowCharacter to Osiris/API/Follow: bg3 renames

Osiris/Shared/Proc DialogFlagSetup

2020-08-08T09:01:49Z

Tinkerer:

===== Full Definition(s) =====
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker2''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker3''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker3''',''(GUIDSTRING)'''''_Speaker4''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker3''',''(GUIDSTRING)'''''_Speaker4''',''(GUIDSTRING)'''''_Speaker5''')
* PROC '''Proc_DialogFlagSetup'''(''(STRING)'''''_Dialog''',''(GUIDSTRING)'''''_Speaker1''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker2''',''(GUIDSTRING)'''''_Speaker3''',''(GUIDSTRING)'''''_Speaker4''',''(GUIDSTRING)'''''_Speaker5''',''(GUIDSTRING)'''''_Speaker6''')
===== Description =====
This routine is called by the Shared mod every time '''_Dialog''' gets started with the listed number of speakers through [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]], which should virtually always be the case. As its name implies, you can overload this routine to set or clear flags right before the dialog gets started. Flags set in this routine are visible already in the greeting nodes (i.e., no need to worry about [[Osiris_Overview#Osiris_Frames|frame delays]]).
===== Return Values =====
* /
===== Notes =====
* /
===== See Also =====
* [[Osiris/API/DialogStartRequested|DialogStartRequested]]
* Helper [[Osiris/Shared/PROC_GLOBAL_DialogStartRequested|PROC_GLOBAL_DialogStartRequested]]
* Helper [[Osiris/Shared/PROC_GLOBAL_DialogStartRequested_AfterGenerics|PROC_GLOBAL_DialogStartRequested_AfterGenerics]]
* Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]]

[[Category:Osiris Shared Mod Helpers|DialogFlagSetup]]

Osiris/API/DrawSurfaceOnPath

2020-07-13T14:11:47Z

Tinkerer: /* See Also = */

===== Full Definition(s) =====
* query '''DrawSurfaceOnPath'''('''''[in]'''(GUIDSTRING)'''''_OwnerObject''', '''''[in]'''(GUIDSTRING)'''''_FollowObject''', '''''[in]'''(STRING)'''''_SurfaceType''', '''''[in]'''(REAL)'''''_Radius''', '''''[in]'''(REAL)'''''_Lifetime''', '''''[out]'''(INTEGER64)'''''_SurfaceActionHandle''')
===== Description =====
Draws a continuous line of width '''_Radius''' of surface type '''_SurfaceType''' behind the '''_FollowObject''' as it moves, with lifetime '''_Lifetime'''. The '''_OwnerObject''' parameter can be used to set the owner of this surface.
===== Return Values =====
* '''Success/Failure''': Fails if the '''_OwnerObject''' or the '''_FollowObject''' don't exist or are null, or if the '''_SurfaceType''' doesn't exist.
* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to [[Osiris/API/StopDrawSurfaceOnPath|stop drawing]] the surface again.
===== Notes =====
* This routine currently does not work correctly if _Radius is >= 2.0
* The '''_Lifetime''' only starts ticking after [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]] has been called for the '''_SurfaceActionHandle'''. It can be '''''-1.0''''' to make the surface permanent.
===== See Also =====
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]]
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]]
* [[Osiris/API/CreatePuddle|CreatePuddle]]
* [[Osiris/API/CreateSurface|CreateSurface]]
* [[Osiris/API/CreateSurfaceAtPosition|CreateSurfaceAtPosition]]
* [[Osiris/API/GetSurfaceCloudAt|GetSurfaceCloudAt]]
* [[Osiris/API/GetSurfaceCloudOwnerAt|GetSurfaceCloudOwnerAt]]
* [[Osiris/API/GetSurfaceGroundAt|GetSurfaceGroundAt]]
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]
* [[Osiris/API/TransformSurface|TransformSurface]]
* [[Osiris/API/TransformSurfaceAtPosition|TransformSurfaceAtPosition]]
* [[Scripting_surface_types|List of surface types]]

[[Category:Osiris Queries|DrawSurfaceOnPath]]

Osiris/API/CharacterIsSummon

2020-06-24T13:53:22Z

Tinkerer: /* See Also */

===== Full Definition(s) =====
* query '''CharacterIsSummon'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_Bool''')
===== Description =====
Returns whether '''_Character''' is a summon. Summons can be [[Osiris/API/CharacterIsPlayer|player-controlled]] or not.
===== Return Values =====
* '''Success/Failure''': Fails if '''_Character''' does not exist.
* '''_Bool''': '''1''' if '''_Character''' is a summon, '''0''' if not.
===== Notes =====
* Summons can also be distinguished by the fact that hey have the '''SUMMON''' tag.
* If you wish to know whether a summon is ''player-controlled'', also check [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]].
===== See Also =====
* [[Osiris/API/CharacterGetOwner|CharacterGetOwner]]
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]]

[[Category:Osiris Queries|CharacterIsSummon]]

Osiris/API/SysClear

2020-02-15T10:09:51Z

Tinkerer:

===== Full Definition(s) =====
* call '''SysClear'''(''(STRING)'''''__Predicate''', ''(INTEGER)'''''__Arity''')
===== Description =====
Deletes all facts from the database with name '''_Predicate''' and with '''_Arity''' as number of columns/parameters.
===== Notes =====
* It will ''not'' automatically trigger any rules that check whether a database fact has been cleared.
===== See Also =====
* /

[[Category:Osiris Calls|SysClear]]

Osiris/API/CharacterReceivedDamage

2020-02-15T09:56:29Z

Tinkerer:

===== Full Definition(s) =====
* event '''CharacterReceivedDamage'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Percentage''', ''(GUIDSTRING)'''''_Source''')
===== Description =====
Thrown when a character receives damage from an attack or an environmental effect such as a surface.
===== Parameters =====
* '''_Character''': The character that was damaged.
* ''(new in DOS2 Patch 5)'' '''_Percentage''': The percentage of vitality/hit points that was removed by this damage event.
* ''(new in DOS2 Patch 5)'' '''_Source''': The GUID of the character or item that caused the damage. In case the damage is caused by a surface, this will be the creator of said surface (can be NULL if the game cannot determine the party responsible, e.g. if you are damaged by a static fire surface that was painted in the editor).
===== Notes =====
* This event is thrown even when '''_Percentage''' is 0.0, i.e., all damage was blocked by armor or '''_Character''' was immune to the damage type.
* This event is ''not'' thrown if the "damage" healed '''_Character''' (e.g. poison damage to a zombie); in that case, a corresponding HEAL status will be applied to '''_Character''' instead.
* One such event gets thrown per "hit", so if a hit does e.g. both physical and poison damage, the '''_Percentage''' parameter represents sum of the individual damages (or difference, in case of an undead). Conversely, [[Osiris/API/AttackedByObject|AttackedByObject]] will be called for each individual damage component.
===== See Also =====
* [[Osiris/API/AttackedByObject|AttackedByObject]]
* [[Osiris/API/CharacterStatusAttempt|CharacterStatusAttempt]]
* [[Osiris/API/CharacterStatusApplied|CharacterStatusApplied]]
* [[Osiris/API/CharacterVitalityChanged|CharacterVitalityChanged]]

[[Category:Osiris Events|CharacterReceivedDamage]]

Osiris/API/CharacterAttack

2020-02-15T09:55:22Z

Tinkerer: Documented CharacterAttack

===== Full Definition(s) =====
* call '''CharacterAttack'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''')
===== Description =====
Causes '''_Character''' to attack '''_Target'''.

===== Notes =====
* The attack is not guaranteed to hit.
===== See Also =====
* [[Osiris/API/AttackedByObject|AttackedByObject]]
* [[Osiris/API/CharacterBlockedBy|CharacterBlockedBy]]
* [[Osiris/API/CharacterCriticalHitBy|CharacterCriticalHitBy]]
* [[Osiris/API/CharacterDie|CharacterDie]]
* [[Osiris/API/CharacterDieImmediate|CharacterDieImmediate]]
* [[Osiris/API/CharacterKilledBy|CharacterKilledBy]]
* [[Osiris/API/CharacterMissedBy|CharacterMissedBy]]
* [[Osiris/API/CharacterReceivedDamage|CharacterReceivedDamage]]
* [[Osiris/API/CharacterTemplateKilledByCharacter|CharacterTemplateKilledByCharacter]]
* [[Osiris/API/CharacterVitalityChanged|CharacterVitalityChanged]]

[[Category:Osiris Calls|CharacterAttack]]

Osiris/API/CharacterAppearOnTrailOutOfSightToObject

2019-11-26T09:00:37Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterAppearOnTrailOutOfSightToObject'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(GUIDSTRING)'''''_Object''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
===== Description =====
Same as [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]], but '''_Character''' will select a position occupied by '''_Target''' over the last few seconds (so that if you then make '''_Character''' walk to '''_Target''' afterwards, it seems as if '''_Character''' was following '''_Target'''). It will select the furthest cached position of '''_Target''' in the direction '''_Object'''.
===== Notes =====
* This only works if '''_Target''' is a [[Osiris/API/AddToParty|party member]], as the last positions are not cached for regular NPCs.
===== See Also =====
* [[Osiris/API/CharacterAppear|CharacterAppear]]
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
* [[Osiris/API/CharacterAppearAtCustom|CharacterAppearAtCustom]]
* [[Osiris/API/CharacterAppearAtPosition|CharacterAppearAtPosition]]
* [[Osiris/API/CharacterAppearAtPositionCustom|CharacterAppearAtPositionCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightTo|CharacterAppearAtPositionOutOfSightTo]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToCustom|CharacterAppearAtPositionOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObject|CharacterAppearAtPositionOutOfSightToObject]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObjectCustom|CharacterAppearAtPositionOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearCustom|CharacterAppearCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightTo|CharacterAppearOnTrailOutOfSightTo]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToCustom|CharacterAppearOnTrailOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObjectCustom|CharacterAppearOnTrailOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearOutOfSightTo|CharacterAppearOutOfSightTo]]
* [[Osiris/API/CharacterAppearOutOfSightToCustom|CharacterAppearOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOutOfSightToObjectCustom|CharacterAppearOutOfSightToObjectCustom]]
* [[Osiris/API/SetOnStage|SetOnStage]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls|CharacterAppearOnTrailOutOfSightToObject]]

Osiris/API/CharacterAppearOnTrailOutOfSightTo

2019-11-26T08:59:13Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterAppearOnTrailOutOfSightTo'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_Angle''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
===== Description =====
Same as [[Osiris/API/CharacterAppearOutOfSightTo|CharacterAppearOutOfSightTo]], but '''_Character''' will select a position occupied by '''_Target''' over the last few seconds (so that if you then make '''_Character''' walk to '''_Target''' afterwards, it seems as if '''_Character''' was following '''_Target'''). It will select the furthest cached position of '''_Target''' at angle '''_Angle'''.
===== Notes =====
* This only works if '''_Target''' is a [[Osiris/API/AddToParty|party member]], as the last positions are not cached for regular NPCs.
* Getting the angle right is hard and error-prone. If possible, use [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject|CharacterAppearOnTrailOutOfSightToObject]] instead.
===== See Also =====
* [[Osiris/API/CharacterAppear|CharacterAppear]]
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
* [[Osiris/API/CharacterAppearAtCustom|CharacterAppearAtCustom]]
* [[Osiris/API/CharacterAppearAtPosition|CharacterAppearAtPosition]]
* [[Osiris/API/CharacterAppearAtPositionCustom|CharacterAppearAtPositionCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightTo|CharacterAppearAtPositionOutOfSightTo]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToCustom|CharacterAppearAtPositionOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObject|CharacterAppearAtPositionOutOfSightToObject]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObjectCustom|CharacterAppearAtPositionOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearCustom|CharacterAppearCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToCustom|CharacterAppearOnTrailOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject|CharacterAppearOnTrailOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObjectCustom|CharacterAppearOnTrailOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearOutOfSightTo|CharacterAppearOutOfSightTo]]
* [[Osiris/API/CharacterAppearOutOfSightToCustom|CharacterAppearOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOutOfSightToObjectCustom|CharacterAppearOutOfSightToObjectCustom]]
* [[Osiris/API/SetOnStage|SetOnStage]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls|CharacterAppearOnTrailOutOfSightTo]]

Osiris/API/CharacterAppearOutOfSightToObject

2019-11-26T08:55:22Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterAppearOutOfSightToObject'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(GUIDSTRING)'''''_Object''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
===== Description =====
'''_Character''' should be off-stage when calling this routine. This call will place '''_Character''' on-stage out of sight of '''_Target''' in the direction of '''_Object'''. If '''_PlaySpawn''' is 1, '''_Character''''s spawn animation is played. If '''_PlaySpawn''' is 0, '''_Character''' is simply placed on-stage. '''_Event''' is triggered on '''_Character''' once it is on stage.
===== Notes =====
* /
===== See Also =====
* [[Osiris/API/CharacterAppear|CharacterAppear]]
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
* [[Osiris/API/CharacterAppearAtCustom|CharacterAppearAtCustom]]
* [[Osiris/API/CharacterAppearAtPosition|CharacterAppearAtPosition]]
* [[Osiris/API/CharacterAppearAtPositionCustom|CharacterAppearAtPositionCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightTo|CharacterAppearAtPositionOutOfSightTo]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToCustom|CharacterAppearAtPositionOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObject|CharacterAppearAtPositionOutOfSightToObject]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObjectCustom|CharacterAppearAtPositionOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearCustom|CharacterAppearCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightTo|CharacterAppearOnTrailOutOfSightTo]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToCustom|CharacterAppearOnTrailOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject|CharacterAppearOnTrailOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObjectCustom|CharacterAppearOnTrailOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearOutOfSightTo|CharacterAppearOutOfSightTo]]
* [[Osiris/API/CharacterAppearOutOfSightToCustom|CharacterAppearOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOutOfSightToObjectCustom|CharacterAppearOutOfSightToObjectCustom]]
* [[Osiris/API/SetOnStage|SetOnStage]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls|CharacterAppearOutOfSightToObject]]

Osiris/API/CharacterAppearOutOfSightTo

2019-11-26T08:54:49Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterAppearOutOfSightTo'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_Angle''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
===== Description =====
'''_Character''' should be off-stage when calling this routine. This call will place '''_Character''' on-stage out of sight of '''_Target''' at '''_Angle''' degrees (0 = North). If '''_PlaySpawn''' is 1, '''_Character''''s spawn animation is played. If '''_PlaySpawn''' is 0, '''_Character''' is simply placed on-stage. '''_Event''' is triggered on '''_Character''' once it is on stage.
===== Notes =====
* Getting the angle right is hard and error-prone. If possible, use [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]] instead.
===== See Also =====
* [[Osiris/API/CharacterAppear|CharacterAppear]]
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
* [[Osiris/API/CharacterAppearAtCustom|CharacterAppearAtCustom]]
* [[Osiris/API/CharacterAppearAtPosition|CharacterAppearAtPosition]]
* [[Osiris/API/CharacterAppearAtPositionCustom|CharacterAppearAtPositionCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightTo|CharacterAppearAtPositionOutOfSightTo]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToCustom|CharacterAppearAtPositionOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObject|CharacterAppearAtPositionOutOfSightToObject]]
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObjectCustom|CharacterAppearAtPositionOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearCustom|CharacterAppearCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightTo|CharacterAppearOnTrailOutOfSightTo]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToCustom|CharacterAppearOnTrailOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject|CharacterAppearOnTrailOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObjectCustom|CharacterAppearOnTrailOutOfSightToObjectCustom]]
* [[Osiris/API/CharacterAppearOutOfSightToCustom|CharacterAppearOutOfSightToCustom]]
* [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]]
* [[Osiris/API/CharacterAppearOutOfSightToObjectCustom|CharacterAppearOutOfSightToObjectCustom]]
* [[Osiris/API/SetOnStage|SetOnStage]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls|CharacterAppearOutOfSightTo]]

Story editor

2019-11-25T10:49:39Z

Tinkerer: /* Known limitations */

[[File:StoryEditor.png|800px|center]]

== Description ==
The Story editor is used to browse, edit and build [[Osiris]] scripts.

== Building the story ==
There are multiple options to build the story under "File".

The most important one is '''''Generate Definitions, Build and Reload'''''. This will build all necessary files for your story to work, and reload the story so the new story becomes active.

Other options are:
* '''Build''': Only build story. This suffices if you know there have been no function definition changes, and if you only wish to check for errors.
* '''Build and reload''': To see your changes in the editor, you'll have to reload the level after building. This option does that auto-magically for you!
* '''Generate Definitions and Build''': Recreates definitions (required for the first story build after an editor update) and then builds the story, but does not reload it. Again, useful to check for errors.
* '''Generate Definitions, Build and Reload''': As mentioned, the most thorough option. Creates all necessary files and then reloads the story.
* '''Generate Definitions''': Only generate function definitions. This is useful to get code completion functionality without rebuilding story.

== Code editing helper functionality ==
* Code completion is available via ''ctrl-space''. Note that in case of user-defined queries, code completion will add a (wrong) "__DEF" suffix that you will have to delete again.
* When you are in the parameter list of a function call, the editor shows the parameter definitions at the top of the code editing window.

== Known limitations ==
* Every pane in the editor gets its own "Find" dialog box. However, if you press ctrl-f while a "Find" dialog box for this pane was already open, this "Find" dialog box will ''not'' regain focus. Either always close the Find dialog box after searching for something (e.g. by pressing ''Esc''), or click on it for it to regain focus. The global search (ctrl-shift-f) dialog does not suffer from this issue.
* The parameter list shown at the top of the window will always list the parameters of the last defined overload in Story. This means that other definitions of the same function with more parameters may exist.

Osiris/API/CharacterCreationFinished

2019-11-13T09:08:39Z

Tinkerer:

===== Full Definition(s) =====
* event '''CharacterCreationFinished'''(''(CHARACTERGUID)'''''_Character''')
===== Description =====
Whenever a player in [[Osiris/API/CharacterAddToCharacterCreation|respec]] mode clicks on the '''Ready''' button, this event is sent with as argument this character. It's also sent if respec is cancelled, or if the user controlling the character that was in respec mode disconnected.

If this is the initial character creation rather than a respec, then this event is only sent once all players have clicked on the '''Ready''' button, and it will have '''''NULL_00000000-0000-0000-0000-000000000000''''' as argument.

===== Parameters =====
* '''_Character''': The character selected in character creation by its owning user, or '''''NULL_00000000-0000-0000-0000-000000000000''''' in the case described above.
===== Notes =====
* /
===== See Also =====
* [[Osiris/API/CharacterAddToCharacterCreation|CharacterAddToCharacterCreation]]

[[Category:Osiris Events|CharacterCreationFinished]]

Osiris/API/StartVoiceBark

2019-10-17T14:18:36Z

Tinkerer:

===== Full Definition(s) =====
* call '''StartVoiceBark'''(''(STRING)'''''_Bark''', ''(CHARACTERGUID)'''''_Source''')
===== Description =====
Starts a [[Voice_Bark_editor|Voicebark]] named '''_Bark''' on the '''_Source''' character, selecting an automatic dialogue based on that character's nearby party members.
===== Notes =====
* See the [[Voice_Bark_editor|Voicebark editor]] for the specifics on how the voicebark selects the AD that will be played.
* In addition to the regular events for starting an automated dialogue, a [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]] will be sent if the voicebark succeeds in selecting a fitting dialogue, and [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] otherwise.
* '''_Source''' must be a [[Osiris/API/AddToParty|party member]], otherwise [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]] gets raised immediately.
===== See Also =====
* [[Osiris/API/VoiceBarkStarted|VoiceBarkStarted]]
* [[Osiris/API/VoiceBarkFailed|VoiceBarkFailed]]
* [[Osiris/API/VoiceBarkEnded|VoiceBarkEnded]]
* [[Voice_Bark_editor|Voicebark editor]]

[[Category:Osiris Calls|StartVoiceBark]]

Osiris/Shared/DB SceneManager

2019-10-16T09:12:41Z

Tinkerer:

===== Full Definition(s) =====
* '''DB_SceneManager(''(CHARACTERGUID)''_Npc,'''''(STRING)'''''_SceneName''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger,''(INTEGER)'''''_IgnoreItems''')
* PROC '''Proc_SceneInterrupted'''(''(GUIDSTRING)'''''_NPC''',''(CHARACTERGUID)'''''_Player''',''(STRING)'''''_SceneName''',''(STRING)'''''_InterruptType''')
* PROC '''Proc_SceneOver'''(''(STRING)'''''_SceneName''')
===== Description =====
The scene manager can be used to group a number of NPCs and areas into a scene that should normally run in an uninterrupted way. If a player nevertheless manages to interrupt it in some way, it offers a generic interface to detect any interruptions so they can be easily handled.

'''DB_SceneManager''' lists all '''_Npc'''s that take part in the scene with identifier '''_SceneName'''. All assault crimes will be disabled for such NPCs while the scene is ongoing. They will be re-enabled after the scene has finished if they were enabled before. '''DB_SceneTriggerManager''' lists box '''_Trigger'''s relevant to '''_SceneName'''. If '''_IgnoreItems''' is not specified, it is assumed to be '''1'''. These triggers are used to detect actions that interrupt scenes.

'''Proc_SceneInterrupted''' is called when scene '''_SceneName''' is interrupted by an action. Such an interruption does '''''not''''' automatically end the scene. '''_Player''' can be NULL if it the player that caused the interruption is unknown. '''_NPC''' can be an item in case '''_IgnoreItems''' for a '''DB_SceneTriggerManager''' definition was '''0''' and an item was involved. The possible '''_InterruptType''' causes are:
* '''LeftTrigger''': an '''_Npc''' listed via '''DB_SceneManager''' has left a trigger listed via '''SceneTriggerManager'''
* '''Attacked''': an '''_Npc''' listed via '''DB_SceneManager''' was attacked by another character (if a summon attacks the character, it will be reported as the '''_Player''' that interrupted the scene), or it was teleported
* '''StartedDialog''': a player or companion started a dialog with an '''_Npc''' listed via '''DB_SceneManager'''
* '''DestroyedItem''': a player or companion destroyed an item in a trigger listed in '''DB_SceneTriggerManager''' with '''_IgnoreItems''' == 0
* (new in Definitive Edition) '''PlayerTeleportInDialog''': a player was teleported more than 5 metres away from their original position while in dialog with one of the scene members
* (new in Definitive Edition) '''EnteredCombat''': one of the scene participants entered combat
* (new in Definitive Edition) '''Died''': one of the scene participants died

'''Proc_SceneOver''' must be called by you when the scene has finished (either normally, or because of an interruption that you deem fatal). This will clean up everything related to the scene with name '''_SceneName''':
* Restore assault crimes for NPCs for whom this was disabled on initialisation.
* For every NPC listed for this scene via '''DB_SceneManager''', all crimes will be enabled, except as excluded by the '''DB_CharacterAllCrimesDisabled''' or '''DB_CharacterCrimeDisabled''' databases (so that you can disable all crimes for such NPCs manually on initialisation if desired, and after the scene has finished they revert to the defaults).
* No further '''Proc_SceneInterrupted''' calls will happen for this scene.
===== Notes =====
* Adding characters to a scene does not by itself make these characters do something. Their actions in the scene still need to be scripted using either Osiris or behaviour script. This functionality only offers a generic interface to detecting interruptions affecting one or more characters/items that you defined as belonging to a partciular scene.

===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers|SceneManager]]

Osiris/Shared/DB SceneManager

2019-10-16T09:00:25Z

Tinkerer:

===== Full Definition(s) =====
* '''DB_SceneManager(''(CHARACTERGUID)''_Npc,'''''(STRING)'''''_SceneName''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger,''(INTEGER)'''''_IgnoreItems''')
* PROC '''Proc_SceneInterrupted'''(''(GUIDSTRING)'''''_NPC''',''(CHARACTERGUID)'''''_Player''',''(STRING)'''''_SceneName''',''(STRING)'''''_InterruptType''')
* PROC '''Proc_SceneOver'''(''(STRING)'''''_SceneName''')
===== Description =====
The scene manager can be used to group a number of NPCs and areas into a scene that should normally run in an uninterrupted way. If a player nevertheless manages to interrupt it in some way, it offers a generic interface to detect any interruptions so they can be easily handled.

'''DB_SceneManager''' lists all '''_Npc'''s that take part in the scene with identifier '''_SceneName'''. All assault crimes will be disabled for such NPCs while the scene is ongoing. They will be re-enabled after the scene has finished if they were enabled before. '''DB_SceneTriggerManager''' lists box '''_Trigger'''s relevant to '''_SceneName'''. If '''_IgnoreItems''' is not specified, it is assumed to be '''1'''. These triggers are used to detect actions that interrupt scenes.

'''Proc_SceneInterrupted''' is called when scene '''_SceneName''' is interrupted by an action. Such an interruption does '''''not''''' automatically end the scene. '''_Player''' can be NULL if it the player that caused the interruption is unknown. '''_NPC''' can be an item in case '''_IgnoreItems''' for a '''DB_SceneTriggerManager''' definition was '''0''' and an item was involved. The possible '''_InterruptType''' causes are:
* '''LeftTrigger''': an '''_Npc''' listed via '''DB_SceneManager''' has left a trigger listed via '''SceneTriggerManager'''
* '''Attacked''': an '''_Npc''' listed via '''DB_SceneManager''' was attacked by another character (if a summon attacks the character, it will be reported as the '''_Player''' that interrupted the scene)
* '''StartedDialog''': a player or companion started a dialog with an '''_Npc''' listed via '''DB_SceneManager'''
* '''DestroyedItem''': a player or companion destroyed an item in a trigger listed in '''DB_SceneTriggerManager''' with '''_IgnoreItems''' == 0
* (new in Definitive Edition) '''PlayerTeleportInDialog''': a player was teleported more than 5 metres away from their original position while in dialog with one of the scene members
* (new in Definitive Edition) '''EnteredCombat''': one of the scene participants entered combat
* (new in Definitive Edition) '''Died''': one of the scene participants died

'''Proc_SceneOver''' must be called by you when the scene has finished (either normally, or because of an interruption that you deem fatal). This will clean up everything related to the scene with name '''_SceneName''':
* Restore assault crimes for NPCs for whom this was disabled on initialisation.
* For every NPC listed for this scene via '''DB_SceneManager''', all crimes will be enabled, except as excluded by the '''DB_CharacterAllCrimesDisabled''' or '''DB_CharacterCrimeDisabled''' databases (so that you can disable all crimes for such NPCs manually on initialisation if desired, and after the scene has finished they revert to the defaults).
* No further '''Proc_SceneInterrupted''' calls will happen for this scene.
===== Notes =====
* Adding characters to a scene does not by itself make these characters do something. Their actions in the scene still need to be scripted using either Osiris or behaviour script. This functionality only offers a generic interface to detecting interruptions affecting one or more characters/items that you defined as belonging to a partciular scene.

===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers|SceneManager]]

Osiris/Shared/DB SceneManager

2019-10-16T09:00:14Z

Tinkerer:

===== Full Definition(s) =====
* '''DB_SceneManager(''(CHARACTERGUID)''_Npc,'''''(STRING)'''''_SceneName''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger,''(INTEGER)'''''_IgnoreItems''')
* PROC '''Proc_SceneInterrupted'''(''(GUIDSTRING)'''''_NPC''',''(CHARACTERGUID)'''''_Player''',''(STRING)'''''_SceneName''',''(STRING)'''''_InterruptType''')
* PROC '''Proc_SceneOver'''(''(STRING)'''''_SceneName''')
===== Description =====
The scene manager can be used to group a number of NPCs and areas into a scene that should normally run in an uninterrupted way. If a player nevertheless manages to interrupt it in some way, it offers a generic interface to detect any interruptions so they can be easily handled.

'''DB_SceneManager''' lists all '''_Npc'''s that take part in the scene with identifier '''_SceneName'''. All assault crimes will be disabled for such NPCs while the scene is ongoing. They will be re-enabled after the scene has finished if they were enabled before. '''DB_SceneTriggerManager''' lists box '''_Trigger'''s relevant to '''_SceneName'''. If '''_IgnoreItems''' is not specified, it is assumed to be '''1'''. These triggers are used to detect actions that interrupt scenes.

'''Proc_SceneInterrupted''' is called when scene '''_SceneName''' is interrupted by an action. Such an interruption does '''''not''''' automatically end the scene. '''_Player''' can be NULL if it the player that caused the interruption is unknown. '''_NPC''' can be an item in case '''_IgnoreItems''' for a '''DB_SceneTriggerManager''' definition was '''0''' and an item was involved. The possible '''_InterruptType''' causes are:
* '''LeftTrigger''': an '''_Npc''' listed via '''DB_SceneManager''' has left a trigger listed via '''SceneTriggerManager'''
* '''Attacked''': an '''_Npc''' listed via '''DB_SceneManager''' was attacked by another character (if a summon attacks the character, it will be reported as the '''_Player''' that interrupted the scene)
* '''StartedDialog''': a player or companion started a dialog with an '''_Npc''' listed via '''DB_SceneManager'''
* '''DestroyedItem''': a player or companion destroyed an item in a trigger listed in '''DB_SceneTriggerManager''' with '''_IgnoreItems''' == 0
* (new in Definitive Edition) '''PlayerTeleportInDialog''': a player was teleported more than 5 metres away from their original position while in dialog with one of the scene members
* (new in Definitive Edition)'''EnteredCombat''': one of the scene participants entered combat
* (new in Definitive Edition)'''Died''': one of the scene participants died

'''Proc_SceneOver''' must be called by you when the scene has finished (either normally, or because of an interruption that you deem fatal). This will clean up everything related to the scene with name '''_SceneName''':
* Restore assault crimes for NPCs for whom this was disabled on initialisation.
* For every NPC listed for this scene via '''DB_SceneManager''', all crimes will be enabled, except as excluded by the '''DB_CharacterAllCrimesDisabled''' or '''DB_CharacterCrimeDisabled''' databases (so that you can disable all crimes for such NPCs manually on initialisation if desired, and after the scene has finished they revert to the defaults).
* No further '''Proc_SceneInterrupted''' calls will happen for this scene.
===== Notes =====
* Adding characters to a scene does not by itself make these characters do something. Their actions in the scene still need to be scripted using either Osiris or behaviour script. This functionality only offers a generic interface to detecting interruptions affecting one or more characters/items that you defined as belonging to a partciular scene.

===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers|SceneManager]]

Osiris/Shared/DB SceneManager

2019-10-16T08:51:38Z

Tinkerer:

===== Full Definition(s) =====
* '''DB_SceneManager(''(CHARACTERGUID)''_Npc,'''''(STRING)'''''_SceneName''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger''')
* '''DB_SceneTriggerManager'''(''(STRING)'''''_SceneName''',''(TRIGGERGUID)'''''_Trigger,''(INTEGER)'''''_IgnoreItems''')
* PROC '''Proc_SceneInterrupted'''(''(GUIDSTRING)'''''_NPC''',''(CHARACTERGUID)'''''_Player''',''(STRING)'''''_SceneName''',''(STRING)'''''_InterruptType''')
* PROC '''Proc_SceneOver'''(''(STRING)'''''_SceneName''')
===== Description =====
The scene manager can be used to group a number of NPCs and areas into a scene that should normally run in an uninterrupted way. If a player nevertheless manages to interrupt it in some way, it offers a generic interface to detect any interruptions so they can be easily handled.

'''DB_SceneManager''' lists all '''_Npc'''s that take part in the scene with identifier '''_SceneName'''. All assault crimes will be disabled for such NPCs while the scene is ongoing. They will be re-enabled after the scene has finished if they were enabled before. '''DB_SceneTriggerManager''' lists box '''_Trigger'''s relevant to '''_SceneName'''. If '''_IgnoreItems''' is not specified, it is assumed to be '''1'''. These triggers are used to detect actions that interrupt scenes.

'''Proc_SceneInterrupted''' is called when scene '''_SceneName''' is interrupted by an action. Such an interruption does '''''not''''' automatically end the scene. '''_Player''' can be NULL if it the player that caused the interruption is unknown. '''_NPC''' can be an item in case '''_IgnoreItems''' for a '''DB_SceneTriggerManager''' definition was '''0''' and an item was involved. The possible '''_InterruptType''' causes are:
* '''LeftTrigger''': an '''_Npc''' listed via '''DB_SceneManager''' has left a trigger listed via '''SceneTriggerManager'''
* '''Attacked''': an '''_Npc''' listed via '''DB_SceneManager''' was attacked by another character (if a summon attacks the character, it will be reported as the '''_Player''' that interrupted the scene)
* '''StartedDialog''': a player or companion started a dialog with an '''_Npc''' listed via '''DB_SceneManager'''
* '''DestroyedItem''': a player or companion destroyed an item in a trigger listed in '''DB_SceneTriggerManager''' with '''_IgnoreItems''' == 0
* (new in Definitive Edition) '''PlayerTeleportInDialog''': a player was teleported more than 5 metres away from their original position while in dialog with one of the scene members

'''Proc_SceneOver''' must be called by you when the scene has finished (either normally, or because of an interruption that you deem fatal). This will clean up everything related to the scene with name '''_SceneName''':
* Restore assault crimes for NPCs for whom this was disabled on initialisation.
* For every NPC listed for this scene via '''DB_SceneManager''', all crimes will be enabled, except as excluded by the '''DB_CharacterAllCrimesDisabled''' or '''DB_CharacterCrimeDisabled''' databases (so that you can disable all crimes for such NPCs manually on initialisation if desired, and after the scene has finished they revert to the defaults).
* No further '''Proc_SceneInterrupted''' calls will happen for this scene.
===== Notes =====
* Adding characters to a scene does not by itself make these characters do something. Their actions in the scene still need to be scripted using either Osiris or behaviour script. This functionality only offers a generic interface to detecting interruptions affecting one or more characters/items that you defined as belonging to a partciular scene.

===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers|SceneManager]]

Osiris/API/DialogRequestFailed

2019-10-06T21:58:43Z

Tinkerer:

===== Full Definition(s) =====
* event '''DialogRequestFailed'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''')
===== Description =====
Thrown when an interactive dialog file was not found, or if an interactive dialog was [[Osiris/API/DialogRequestStop|stopped]] before the [[Osiris/API/DialogStarted|DialogStarted]] event was thrown.
===== Parameters =====
* '''_Dialog''': The name of the dialog.
* '''_InstanceID''': Unique identifier for this interactive dialog instance.

===== Notes =====
* Automated dialogs will throw an [[Osiris/API/AutomatedDialogRequestFailed|AutomatedDialogRequestFailed]] event instead.
* This event is not thrown if [[Osiris/API/StartDialog_Internal|StartDialog_Internal]] returned that it failed to start the dialog. It's only thrown if that routine returned success, but then the dialog did not start after all because of one of the reasons mentioned in the description.
* A [[Osiris/API/DialogEnded|DialogEnded]] event will always follow after a '''DialogRequestFailed''' event.

===== See Also =====
* [[Osiris/API/AutomatedDialogRequestFailed|AutomatedDialogRequestFailed]]
* [[Osiris/API/DialogEnded|DialogEnded]]
* [[Osiris/API/DialogStarted|DialogStarted]]
* Helper [[Osiris/Shared/DB_DialogNPCs|DB_DialogNPCs]]
* Helper [[Osiris/Shared/DB_DialogPlayers|DB_DialogPlayers]]
* Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]]

[[Category:Osiris Events|DialogRequestFailed]]

Osiris/API/CharacterPurgeQueue

2019-10-06T09:11:35Z

Tinkerer:

===== Full Definition(s) =====
* call '''CharacterPurgeQueue'''(''(CHARACTERGUID)'''''_Character''')

===== Description =====
This call will remove the currently executing '''Osiris''' task and all queued '''Osiris''' tasks for '''_Character''' instantaneously as if they were never queued in the first place.

See the description of [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] for information about the Osiris queuing system.
===== Notes =====
* This will only purge tasks queued from Osiris. It has no effect on tasks started from behaviour scripts.
* This call should virtually always be followed by a call to [[Osiris/Shared/ProcClearMovingFacts|ProcClearMovingFacts]]. This will reset any state stored by the Shared mod's [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]], and thereby prevent the character from resuming such movements afterwards (since this state is not part of Osiris itself and hence is not deleted by this call).
* If you wish to immediately complete the queued actions instead of removing them, use [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]] instead

===== See Also =====
* [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]]

[[Category:Osiris Calls|CharacterPurgeQueue|CharacterPurgeQueue]]

Osiris/Shared/DB DialogNPCs

2019-10-06T09:08:34Z

Tinkerer:

===== Full Definition(s) =====
* '''DB_DialogNPCs'''(''(INTEGER)'''''_Inst''', '''''(CHARACTERGUID)'''''_Actor, '''''(INTEGER)'''''_Slot''')
* '''DB_DialogPlayers'''(''(INTEGER)'''''_Inst''', '''''(CHARACTERGUID)'''''_Actor, '''''(INTEGER)'''''_Slot''')
===== Description =====
Whenever a [[Osiris/API/DialogStarted|dialog starts]], all NPCs and players involved in this dialog instance '''_Inst''' will be collected in these databases. '''_Slot''' counts separately for players and NPCs from 1 to the number of players resp. NPCs involved in the dialog.

Actors added via [[Osiris/API/DialogAddCharacter|DialogAddCharacter]] and [[Osiris/API/DialogAddCharacterAt|DialogAddCharacterAt]] will also be added to these databases.
===== Notes =====
* During the [[Osiris/API/DialogEnded|DialogEnded]] event, this database is still valid. The reason is that it gets removed in '''ZZZ_LastGoal''' story goal, and event handlers in goals get executed in the order corresponding to the [[Osiris_Overview#Rule_Order|alphabetical order of the goal names]].
===== See Also =====
* [[Osiris/API/DialogActorJoined|DialogActorJoined]]
* [[Osiris/API/DialogAddActor|DialogAddActor]]
* [[Osiris/API/DialogAddActorAt|DialogAddActorAt]]
* [[Osiris/API/DialogStarted|DialogStarted]]
* [[Osiris/API/DialogRequestFailed|DialogRequestFailed]]
* [[Osiris/API/DialogEnded|DialogEnded]]
* helper [[Osiris/Shared/DB_DialogName|DB_DialogName]]

[[Category:Osiris Shared Mod Helpers|DialogNPCs]]