Divinity Engine Wiki - User contributions [en]

Osiris/API/DialogEnded

2018-09-18T23:21:21Z

DerCapac:

===== Full Definition(s) =====
* event '''DialogEnded'''(''(STRING)'''''_Dialog''', ''(INTEGER)'''''_InstanceID''')
===== Description =====
Thrown once an interactive dialog has ended.
===== Parameters =====
* '''_Dialog''': The name of the dialog.
* '''_InstanceID''': Unique identifier for this interactive dialog.
===== Notes =====
* Automated dialogs with throw an [[Osiris/API/AutomatedDialogEnded|AutomatedDialogEnded]] event instead.
* Even if the attempt to start an interactive dialog failed and a [[Osiris/API/DialogRequestFailed|DialogRequestFailed]] event was thrown, you will still also get a '''DialogEnded''' event as well.
===== See Also =====
* [[Osiris/API/AutomatedDialogEnded|AutomatedDialogEnded]]
* [[Osiris/API/DialogRequestFailed|DialogRequestFailed]]
* [[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|DialogEnded]]

Talk:Triggers

2018-09-17T19:18:36Z

DerCapac: Created page with "The section for event triggers should be updated, the description should include items as event triggers also generate item events: === File:TemplateType_Trigger_Event.png|..."

The section for event triggers should be updated, the description should include items as event triggers also generate item events:

=== [[File:TemplateType_Trigger_Event.png|32px]] Event Trigger ===
A trigger that broadcasts an event entered or exited. These triggers are automatically [[Osiris/API/TriggerRegisterForCharacter|registered]] for all characters (player or not) and items in the game.

User:DerCapac/Definitive Edition: Osiris changes

2018-09-07T22:38:20Z

DerCapac:

== Removed ==

* call CharacterLaunchIteratorAroundCharacter((CHARACTERGUID)_Character, (REAL)_Radius, (STRING)_Event)
* call NotifyGameProgress((REAL)_Progress)

== Renamed ==

* <strike>call DialogAddCharacter((INTEGER)_InstanceID, (CHARACTERGUID)_Player)</strike> call DialogAddActor((INTEGER)_InstanceID, (GUIDSTRING)_Actor)
* <strike>call DialogAddCharacterAt((INTEGER)_InstanceID, (CHARACTERGUID)_Player, (INTEGER)_Index)</strike> call DialogAddActorAt((INTEGER)_InstanceID, (GUIDSTRING)_Actor, (INTEGER)_Index)
* <strike>event ItemTransformed((ITEMGUID)_Item, (STRING)_ItemTemplate)</strike> event ObjectTransformed((GUIDSTRING)_Object, (GUIDSTRING)_ToTemplate)
* <strike>query DialogRemoveCharacter([in](INTEGER)_InstanceID, [in](CHARACTERGUID)_Player, [out](INTEGER)_success)</strike> query DialogRemoveActorFromDialog([in](INTEGER)_InstanceID, [in](GUIDSTRING)_Actor, [out](INTEGER)_success)
* <strike>event DLCUnlocked((INTEGER)_DLCId)</strike> event DLCUpdated((STRING)_DLCName, (INTEGER)_UserID, (INTEGER)_Installed)

== Changed ==

* query CrimeIsAnyNPCGoingToReact([in](GUIDSTRING)_Criminal, [in](STRING)_CrimeType, [in](GUIDSTRING)_Victim, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER)_Bool) New parameter `_Victim`
* event CharacterUsedSkill((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillAtPosition((CHARACTERGUID)_Character, (REAL)_X, (REAL)_Y, (REAL)_Z, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillInTrigger((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement, (TRIGGERGUID)_Trigger) New parameter `_SkillElement`
* event CharacterUsedSkillOnTarget((CHARACTERGUID)_Character, (GUIDSTRING)_Target, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillOnZoneWithTarget((CHARACTERGUID)_Character, (GUIDSTRING)_Target, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event SkillCast((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterReservedUserIDChanged((CHARACTERGUID)_Character, (INTEGER)_OldUserID, (INTEGER)_NewUserID) New parameter `_OldUserID`
* call TeleportTo((GUIDSTRING)_SourceObject, (GUIDSTRING)_TargetObject, (STRING)_Event, (INTEGER)_TeleportLinkedCharacters, (INTEGER)_ExcludePartyFollowers, (INTEGER)_LeaveCombat) New parameter `_LeaveCombat`
* query CharacterGetArmorPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is now a real value
* call CharacterSetArmorPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is now a real value
* query CharacterGetHitpointsPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is now a real value
* call CharacterSetHitpointsPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is now a real value
* query CharacterGetMagicArmorPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is now a real value
* call CharacterSetMagicArmorPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is now a real value
* call ShowNotification((CHARACTERGUID)_Character, (STRING)_Text) New parameter `_Character`

== New ==

=== Combat ===

* call CreateProjectileStrikeAt((GUIDSTRING)_Target, (STRING)_SkillID, (INTEGER)_CasterLevel)
* call CreateProjectileStrikeAtPosition((REAL)_X, (REAL)_Y, (REAL)_Z, (STRING)_SkillID, (INTEGER)_CasterLevel)
* event OnMutatorEnabledAtTurn((STRING)_Mutator, (INTEGER)_Turn)

=== Stats ===

* query AttributeGetDifficultyLevelMappedValue([in](STRING)_Difficulty, [in](INTEGER)_Level, [out](INTEGER)_AttributeValue)
* event CharacterBaseAbilityChanged((CHARACTERGUID)_Character, (STRING)_Ability, (INTEGER)_OldBaseValue, (INTEGER)_NewBaseValue)

=== Death ===

* event CharacterPrecogDying((CHARACTERGUID)_Character)

=== Transform ===

* call CharacterCloneSkillsTo((CHARACTERGUID)_From, (CHARACTERGUID)_To, (INTEGER)_MemorizedOnly)
* call CharacterTransformFromCharacter((CHARACTERGUID)_Target, (CHARACTERGUID)_Source, (INTEGER)_ReplaceScripts, (INTEGER)_ReplaceScale, (INTEGER)_ReplaceStats, (INTEGER)_ReplaceEquipment, (INTEGER)_ReplaceSkills, (INTEGER)_UseCustomLooks, (INTEGER)_ReleasePlayerData)

=== Items ===

* query ItemGetUseRemotely([in](ITEMGUID)_Item, [out](INTEGER)_bool)
* query ItemIsDestructible([in](ITEMGUID)_Item, [out](INTEGER)_Bool)
* call ItemSetUseRemotely((ITEMGUID)_Item, (INTEGER)_bool)

=== On Stage ===

* event OnStageChanged((GUIDSTRING)_Object, (INTEGER)_Bool)

=== Position ===

* query FindValidPosition([in](REAL)_SourceX, [in](REAL)_SourceY, [in](REAL)_SourceZ, [in](REAL)_Radius, [in](GUIDSTRING)_Object, [out](REAL)_ValidPositionX, [out](REAL)_ValidPositionY, [out](REAL)_ValidPositionZ)
* query GetWorldTransformFromLocal([in](GUIDSTRING)_Object, [in](REAL)_LocX, [in](REAL)_LocY, [in](REAL)_LocZ, [in](REAL)_LocRotX, [in](REAL)_LocRotY, [in](REAL)_LocRotZ, [out](REAL)_WorldX, [out](REAL)_WorldY, [out](REAL)_WorldZ, [out](REAL)_WorldRotX, [out](REAL)_WorldRotY, [out](REAL)_WorldRotZ)
* query HasLineOfSight([in](GUIDSTRING)_Source, [in](GUIDSTRING)_Target, [out](INTEGER)_Bool)

=== Iterators ===

* call CharacterLaunchIteratorAroundObject((GUIDSTRING)_Center, (REAL)_Radius, (STRING)_Event)
* call CharacterLaunchOsirisOnlyIterator((STRING)_Event)

=== Sound ===

* call CharacterPlayHUDSoundResource((CHARACTERGUID)_Character, (GUIDSTRING)_SoundResource)
* call PlaySoundResource((GUIDSTRING)_Object, (GUIDSTRING)_SoundResource)

=== Effects ===

* query PlayLoopEffectAtPosition([in](STRING)_FxName, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_FxHandle)
* query PlayScaledLoopEffectAtPosition([in](STRING)_FxName, [in](REAL)_Scale, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_FxHandle)

=== Surfaces ===

* call RemoveSurfaceLayer((GUIDSTRING)_Source, (INTEGER)_SurfaceLayer, (REAL)_Radius)
* call RemoveSurfaceLayerAtPosition((REAL)_x, (REAL)_Y, (REAL)_Z, (INTEGER)_SurfaceLayer, (REAL)_Radius)

=== Camera ===

* call SetSelectorCameraMode((CHARACTERGUID)_Character, (INTEGER)_Bool)

=== Crimes ===

* query CharacterCanIgnoreActiveCrimes([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
* query CharacterCanReactToCrime([in](CHARACTERGUID)_Character, [in](STRING)_CrimeType, [out](INTEGER)_Bool)
* query CharacterIgnoreActiveCrimes([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
* event CharacterStoppedLockpickingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
* query DialogIsCrimeDialog([in](INTEGER)_InstanceID, [out](INTEGER)_IsCrimeDialog)

=== Recipes ===

* query CharacterHasRecipeUnlocked([in](CHARACTERGUID)_Character, [in](STRING)_RecipeID, [out](INTEGER)_Bool)
* event CharacterUnlockedRecipe((CHARACTERGUID)_Character, (STRING)_Recipe)

=== Quest ===

* call CloseJournalMystery((CHARACTERGUID)_Character, (STRING)_MysteryID)
* call MapMarkerChangeLevel((STRING)_MarkerID, (STRING)_NewRegionID)
* event MysteryUnlocked((CHARACTERGUID)_Character, (STRING)_MysteryID)
* call QuestAddSubquest((CHARACTERGUID)_Character, (STRING)_SubquestID, (STRING)_ParentQuestID)
* query QuestIsMysteryEntry([in](STRING)_QuestID, [in](STRING)_StateID, [out](INTEGER)_Bool)
* query QuestIsSubquestEntry([in](STRING)_QuestID, [in](STRING)_StateID, [out](INTEGER)_Bool)
* call UnlockJournalMystery((CHARACTERGUID)_Character, (STRING)_MysteryID)

=== Arena ===

* call SendArenaNotification((INTEGER)_NotificationType, (STRING)_StringParam, (INTEGER)_InNumberOfRounds)

=== UI ===

* event MessageBoxChoiceClosed((CHARACTERGUID)_Character, (STRING)_Message, (STRING)_ResultChoice)
* event MessageBoxYesNoClosed((CHARACTERGUID)_Character, (STRING)_Message, (INTEGER)_Result)
* call OpenMessageBoxChoice((CHARACTERGUID)_Character, (STRING)_Message, (STRING)_Choice_1, (STRING)_Choice_2)
* call OpenMessageBoxYesNo((CHARACTERGUID)_Character, (STRING)_Message)

=== Internal ===

* call AddFeedbackString((CHARACTERGUID)_Character, (STRING)_Location, (STRING)_Question, (STRING)_Answer)
* call SaveFeedback()
* call SonyRealtimeMultiplayerEvent((CHARACTERGUID)_Character, (STRING)_EventName)

User:DerCapac/Definitive Edition: Osiris changes

2018-09-07T22:28:08Z

DerCapac:

== Removed ==

* call CharacterLaunchIteratorAroundCharacter((CHARACTERGUID)_Character, (REAL)_Radius, (STRING)_Event)
* call NotifyGameProgress((REAL)_Progress)

== Renamed ==

* <strike>call DialogAddCharacter((INTEGER)_InstanceID, (CHARACTERGUID)_Player)</strike> call DialogAddActor((INTEGER)_InstanceID, (GUIDSTRING)_Actor)
* <strike>call DialogAddCharacterAt((INTEGER)_InstanceID, (CHARACTERGUID)_Player, (INTEGER)_Index)</strike> call DialogAddActorAt((INTEGER)_InstanceID, (GUIDSTRING)_Actor, (INTEGER)_Index)
* <strike>event ItemTransformed((ITEMGUID)_Item, (STRING)_ItemTemplate)</strike> event ObjectTransformed((GUIDSTRING)_Object, (GUIDSTRING)_ToTemplate)
* <strike>query DialogRemoveCharacter([in](INTEGER)_InstanceID, [in](CHARACTERGUID)_Player, [out](INTEGER)_success)</strike> query DialogRemoveActorFromDialog([in](INTEGER)_InstanceID, [in](GUIDSTRING)_Actor, [out](INTEGER)_success)
* <strike>event DLCUnlocked((INTEGER)_DLCId)</strike> event DLCUpdated((STRING)_DLCName, (INTEGER)_UserID, (INTEGER)_Installed)

== Changed ==

* query CrimeIsAnyNPCGoingToReact([in](GUIDSTRING)_Criminal, [in](STRING)_CrimeType, [in](GUIDSTRING)_Victim, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER)_Bool) New parameter `_Victim`
* event CharacterUsedSkill((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillAtPosition((CHARACTERGUID)_Character, (REAL)_X, (REAL)_Y, (REAL)_Z, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillInTrigger((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement, (TRIGGERGUID)_Trigger) New parameter `_SkillElement`
* event CharacterUsedSkillOnTarget((CHARACTERGUID)_Character, (GUIDSTRING)_Target, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterUsedSkillOnZoneWithTarget((CHARACTERGUID)_Character, (GUIDSTRING)_Target, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event SkillCast((CHARACTERGUID)_Character, (STRING)_Skill, (STRING)_SkillType, (STRING)_SkillElement) New parameter `_SkillElement`
* event CharacterReservedUserIDChanged((CHARACTERGUID)_Character, (INTEGER)_OldUserID, (INTEGER)_NewUserID) New parameter `_OldUserID`
* call TeleportTo((GUIDSTRING)_SourceObject, (GUIDSTRING)_TargetObject, (STRING)_Event, (INTEGER)_TeleportLinkedCharacters, (INTEGER)_ExcludePartyFollowers, (INTEGER)_LeaveCombat) New parameter `_LeaveCombat`
* query CharacterGetArmorPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is no a real value
* call CharacterSetArmorPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is no a real value
* query CharacterGetHitpointsPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is no a real value
* call CharacterSetHitpointsPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is no a real value
* query CharacterGetMagicArmorPercentage([in](CHARACTERGUID)_Character, [out](REAL)_Percentage) Parameter `_Percentage` is no a real value
* call CharacterSetMagicArmorPercentage((CHARACTERGUID)_Character, (REAL)_Percentage) Parameter `_Percentage` is no a real value
* call ShowNotification((CHARACTERGUID)_Character, (STRING)_Text) New parameter `_Character`

== New ==

=== Combat ===

* call CreateProjectileStrikeAt((GUIDSTRING)_Target, (STRING)_SkillID, (INTEGER)_CasterLevel)
* call CreateProjectileStrikeAtPosition((REAL)_X, (REAL)_Y, (REAL)_Z, (STRING)_SkillID, (INTEGER)_CasterLevel)
* event OnMutatorEnabledAtTurn((STRING)_Mutator, (INTEGER)_Turn)

=== Stats ===

* query AttributeGetDifficultyLevelMappedValue([in](STRING)_Difficulty, [in](INTEGER)_Level, [out](INTEGER)_AttributeValue)
* event CharacterBaseAbilityChanged((CHARACTERGUID)_Character, (STRING)_Ability, (INTEGER)_OldBaseValue, (INTEGER)_NewBaseValue)

=== Death ===

* event CharacterPrecogDying((CHARACTERGUID)_Character)

=== Transform ===

* call CharacterCloneSkillsTo((CHARACTERGUID)_From, (CHARACTERGUID)_To, (INTEGER)_MemorizedOnly)
* call CharacterTransformFromCharacter((CHARACTERGUID)_Target, (CHARACTERGUID)_Source, (INTEGER)_ReplaceScripts, (INTEGER)_ReplaceScale, (INTEGER)_ReplaceStats, (INTEGER)_ReplaceEquipment, (INTEGER)_ReplaceSkills, (INTEGER)_UseCustomLooks, (INTEGER)_ReleasePlayerData)

=== Items ===

* query ItemGetUseRemotely([in](ITEMGUID)_Item, [out](INTEGER)_bool)
* query ItemIsDestructible([in](ITEMGUID)_Item, [out](INTEGER)_Bool)
* call ItemSetUseRemotely((ITEMGUID)_Item, (INTEGER)_bool)

=== On Stage ===

* event OnStageChanged((GUIDSTRING)_Object, (INTEGER)_Bool)

=== Position ===

* query FindValidPosition([in](REAL)_SourceX, [in](REAL)_SourceY, [in](REAL)_SourceZ, [in](REAL)_Radius, [in](GUIDSTRING)_Object, [out](REAL)_ValidPositionX, [out](REAL)_ValidPositionY, [out](REAL)_ValidPositionZ)
* query GetWorldTransformFromLocal([in](GUIDSTRING)_Object, [in](REAL)_LocX, [in](REAL)_LocY, [in](REAL)_LocZ, [in](REAL)_LocRotX, [in](REAL)_LocRotY, [in](REAL)_LocRotZ, [out](REAL)_WorldX, [out](REAL)_WorldY, [out](REAL)_WorldZ, [out](REAL)_WorldRotX, [out](REAL)_WorldRotY, [out](REAL)_WorldRotZ)
* query HasLineOfSight([in](GUIDSTRING)_Source, [in](GUIDSTRING)_Target, [out](INTEGER)_Bool)

=== Iterators ===

* call CharacterLaunchIteratorAroundObject((GUIDSTRING)_Center, (REAL)_Radius, (STRING)_Event)
* call CharacterLaunchOsirisOnlyIterator((STRING)_Event)

=== Sound ===

* call CharacterPlayHUDSoundResource((CHARACTERGUID)_Character, (GUIDSTRING)_SoundResource)
* call PlaySoundResource((GUIDSTRING)_Object, (GUIDSTRING)_SoundResource)

=== Effects ===

* query PlayLoopEffectAtPosition([in](STRING)_FxName, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_FxHandle)
* query PlayScaledLoopEffectAtPosition([in](STRING)_FxName, [in](REAL)_Scale, [in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [out](INTEGER64)_FxHandle)

=== Surfaces ===

* call RemoveSurfaceLayer((GUIDSTRING)_Source, (INTEGER)_SurfaceLayer, (REAL)_Radius)
* call RemoveSurfaceLayerAtPosition((REAL)_x, (REAL)_Y, (REAL)_Z, (INTEGER)_SurfaceLayer, (REAL)_Radius)

=== Camera ===

* call SetSelectorCameraMode((CHARACTERGUID)_Character, (INTEGER)_Bool)

=== Crimes ===

* query CharacterCanIgnoreActiveCrimes([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
* query CharacterCanReactToCrime([in](CHARACTERGUID)_Character, [in](STRING)_CrimeType, [out](INTEGER)_Bool)
* query CharacterIgnoreActiveCrimes([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)
* event CharacterStoppedLockpickingItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
* query DialogIsCrimeDialog([in](INTEGER)_InstanceID, [out](INTEGER)_IsCrimeDialog)

=== Recipes ===

* query CharacterHasRecipeUnlocked([in](CHARACTERGUID)_Character, [in](STRING)_RecipeID, [out](INTEGER)_Bool)
* event CharacterUnlockedRecipe((CHARACTERGUID)_Character, (STRING)_Recipe)

=== Quest ===

* call CloseJournalMystery((CHARACTERGUID)_Character, (STRING)_MysteryID)
* call MapMarkerChangeLevel((STRING)_MarkerID, (STRING)_NewRegionID)
* event MysteryUnlocked((CHARACTERGUID)_Character, (STRING)_MysteryID)
* call QuestAddSubquest((CHARACTERGUID)_Character, (STRING)_SubquestID, (STRING)_ParentQuestID)
* query QuestIsMysteryEntry([in](STRING)_QuestID, [in](STRING)_StateID, [out](INTEGER)_Bool)
* query QuestIsSubquestEntry([in](STRING)_QuestID, [in](STRING)_StateID, [out](INTEGER)_Bool)
* call UnlockJournalMystery((CHARACTERGUID)_Character, (STRING)_MysteryID)

=== Arena ===

* call SendArenaNotification((INTEGER)_NotificationType, (STRING)_StringParam, (INTEGER)_InNumberOfRounds)

=== UI ===

* event MessageBoxChoiceClosed((CHARACTERGUID)_Character, (STRING)_Message, (STRING)_ResultChoice)
* event MessageBoxYesNoClosed((CHARACTERGUID)_Character, (STRING)_Message, (INTEGER)_Result)
* call OpenMessageBoxChoice((CHARACTERGUID)_Character, (STRING)_Message, (STRING)_Choice_1, (STRING)_Choice_2)
* call OpenMessageBoxYesNo((CHARACTERGUID)_Character, (STRING)_Message)

=== Internal ===

* call AddFeedbackString((CHARACTERGUID)_Character, (STRING)_Location, (STRING)_Question, (STRING)_Answer)
* call SaveFeedback()
* call SonyRealtimeMultiplayerEvent((CHARACTERGUID)_Character, (STRING)_EventName)

User:DerCapac/Definitive Edition: Osiris changes

2018-09-07T22:17:27Z

DerCapac: Created page with "# Definitive Edition: Osiris changes ## Removed - call CharacterLaunchIteratorAroundCharacter((CHARACTERGUID)\_Character, (REAL)\_Radius, (STRING)\_Event) - call NotifyGameP..."

# Definitive Edition: Osiris changes

## Removed

- call CharacterLaunchIteratorAroundCharacter((CHARACTERGUID)\_Character, (REAL)\_Radius, (STRING)\_Event)
- call NotifyGameProgress((REAL)\_Progress)

## Renamed

- ~~call DialogAddCharacter((INTEGER)\_InstanceID, (CHARACTERGUID)\_Player)~~
call DialogAddActor((INTEGER)\_InstanceID, (GUIDSTRING)\_Actor)
- ~~call DialogAddCharacterAt((INTEGER)\_InstanceID, (CHARACTERGUID)\_Player, (INTEGER)\_Index)~~
call DialogAddActorAt((INTEGER)\_InstanceID, (GUIDSTRING)\_Actor, (INTEGER)\_Index)
- ~~event ItemTransformed((ITEMGUID)\_Item, (STRING)\_ItemTemplate)~~
event ObjectTransformed((GUIDSTRING)\_Object, (GUIDSTRING)\_ToTemplate)
- ~~query DialogRemoveCharacter([in](INTEGER)\_InstanceID, [in](CHARACTERGUID)\_Player, [out](INTEGER)\_success)~~
query DialogRemoveActorFromDialog([in](INTEGER)\_InstanceID, [in](GUIDSTRING)\_Actor, [out](INTEGER)\_success)
- ~~event DLCUnlocked((INTEGER)\_DLCId)~~
event DLCUpdated((STRING)\_DLCName, (INTEGER)\_UserID, (INTEGER)\_Installed)

## Changed

- query CrimeIsAnyNPCGoingToReact([in](GUIDSTRING)\_Criminal, [in](STRING)\_CrimeType, [in](GUIDSTRING)\_Victim, [in](REAL)\_X, [in](REAL)\_Y, [in](REAL)\_Z, [out](INTEGER)\_Bool)
New parameter `_Victim`
- event CharacterUsedSkill((CHARACTERGUID)\_Character, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement)
New parameter `_SkillElement`
- event CharacterUsedSkillAtPosition((CHARACTERGUID)\_Character, (REAL)\_X, (REAL)\_Y, (REAL)\_Z, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement)
New parameter `_SkillElement`
- event CharacterUsedSkillInTrigger((CHARACTERGUID)\_Character, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement, (TRIGGERGUID)\_Trigger)
New parameter `_SkillElement`
- event CharacterUsedSkillOnTarget((CHARACTERGUID)\_Character, (GUIDSTRING)\_Target, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement)
New parameter `_SkillElement`
- event CharacterUsedSkillOnZoneWithTarget((CHARACTERGUID)\_Character, (GUIDSTRING)\_Target, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement)
New parameter `_SkillElement`
- event SkillCast((CHARACTERGUID)\_Character, (STRING)\_Skill, (STRING)\_SkillType, (STRING)\_SkillElement)
New parameter `_SkillElement`
- event CharacterReservedUserIDChanged((CHARACTERGUID)\_Character, (INTEGER)\_OldUserID, (INTEGER)\_NewUserID)
New parameter `_OldUserID`
- call TeleportTo((GUIDSTRING)\_SourceObject, (GUIDSTRING)\_TargetObject, (STRING)\_Event, (INTEGER)\_TeleportLinkedCharacters, (INTEGER)\_ExcludePartyFollowers, (INTEGER)\_LeaveCombat)
New parameter `_LeaveCombat`
- query CharacterGetArmorPercentage([in](CHARACTERGUID)\_Character, [out](REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- call CharacterSetArmorPercentage((CHARACTERGUID)\_Character, (REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- query CharacterGetHitpointsPercentage([in](CHARACTERGUID)\_Character, [out](REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- call CharacterSetHitpointsPercentage((CHARACTERGUID)\_Character, (REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- query CharacterGetMagicArmorPercentage([in](CHARACTERGUID)\_Character, [out](REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- call CharacterSetMagicArmorPercentage((CHARACTERGUID)\_Character, (REAL)\_Percentage)
Parameter `_Percentage` is no a real value
- call ShowNotification((CHARACTERGUID)\_Character, (STRING)\_Text)
New parameter `_Character`

## New

### Combat

- call CreateProjectileStrikeAt((GUIDSTRING)\_Target, (STRING)\_SkillID, (INTEGER)\_CasterLevel)
- call CreateProjectileStrikeAtPosition((REAL)\_X, (REAL)\_Y, (REAL)\_Z, (STRING)\_SkillID, (INTEGER)\_CasterLevel)
- event OnMutatorEnabledAtTurn((STRING)\_Mutator, (INTEGER)\_Turn)

### Stats

- query AttributeGetDifficultyLevelMappedValue([in](STRING)\_Difficulty, [in](INTEGER)\_Level, [out](INTEGER)\_AttributeValue)
- event CharacterBaseAbilityChanged((CHARACTERGUID)\_Character, (STRING)\_Ability, (INTEGER)\_OldBaseValue, (INTEGER)\_NewBaseValue)

### Death

- event CharacterPrecogDying((CHARACTERGUID)\_Character)

### Transform

- call CharacterCloneSkillsTo((CHARACTERGUID)\_From, (CHARACTERGUID)\_To, (INTEGER)\_MemorizedOnly)
- call CharacterTransformFromCharacter((CHARACTERGUID)\_Target, (CHARACTERGUID)\_Source, (INTEGER)\_ReplaceScripts, (INTEGER)\_ReplaceScale, (INTEGER)\_ReplaceStats, (INTEGER)\_ReplaceEquipment, (INTEGER)\_ReplaceSkills, (INTEGER)\_UseCustomLooks, (INTEGER)\_ReleasePlayerData)

### Items

- query ItemGetUseRemotely([in](ITEMGUID)\_Item, [out](INTEGER)\_bool)
- query ItemIsDestructible([in](ITEMGUID)\_Item, [out](INTEGER)\_Bool)
- call ItemSetUseRemotely((ITEMGUID)\_Item, (INTEGER)\_bool)

### On Stage

- event OnStageChanged((GUIDSTRING)\_Object, (INTEGER)\_Bool)

### Position

- query FindValidPosition([in](REAL)\_SourceX, [in](REAL)\_SourceY, [in](REAL)\_SourceZ, [in](REAL)\_Radius, [in](GUIDSTRING)\_Object, [out](REAL)\_ValidPositionX, [out](REAL)\_ValidPositionY,
[out](REAL)\_ValidPositionZ)
- query GetWorldTransformFromLocal([in](GUIDSTRING)\_Object, [in](REAL)\_LocX, [in](REAL)\_LocY, [in](REAL)\_LocZ, [in](REAL)\_LocRotX, [in](REAL)\_LocRotY, [in](REAL)\_LocRotZ, [out](REAL)\_WorldX,
[out](REAL)\_WorldY, [out](REAL)\_WorldZ, [out](REAL)\_WorldRotX, [out](REAL)\_WorldRotY, [out](REAL)\_WorldRotZ)
- query HasLineOfSight([in](GUIDSTRING)\_Source, [in](GUIDSTRING)\_Target, [out](INTEGER)\_Bool)

### Iterators

- call CharacterLaunchIteratorAroundObject((GUIDSTRING)\_Center, (REAL)\_Radius, (STRING)\_Event)
- call CharacterLaunchOsirisOnlyIterator((STRING)\_Event)

### Sound

- call CharacterPlayHUDSoundResource((CHARACTERGUID)\_Character, (GUIDSTRING)\_SoundResource)
- call PlaySoundResource((GUIDSTRING)\_Object, (GUIDSTRING)\_SoundResource)

### Effects

- query PlayLoopEffectAtPosition([in](STRING)\_FxName, [in](REAL)\_X, [in](REAL)\_Y, [in](REAL)\_Z, [out](INTEGER64)\_FxHandle)
- query PlayScaledLoopEffectAtPosition([in](STRING)\_FxName, [in](REAL)\_Scale, [in](REAL)\_X, [in](REAL)\_Y, [in](REAL)\_Z, [out](INTEGER64)\_FxHandle)

### Surfaces

- call RemoveSurfaceLayer((GUIDSTRING)\_Source, (INTEGER)\_SurfaceLayer, (REAL)\_Radius)
- call RemoveSurfaceLayerAtPosition((REAL)\_x, (REAL)\_Y, (REAL)\_Z, (INTEGER)\_SurfaceLayer, (REAL)\_Radius)

### Camera

- call SetSelectorCameraMode((CHARACTERGUID)\_Character, (INTEGER)\_Bool)

### Crimes

- query CharacterCanIgnoreActiveCrimes([in](CHARACTERGUID)\_Character, [out](INTEGER)\_Bool)
- query CharacterCanReactToCrime([in](CHARACTERGUID)\_Character, [in](STRING)\_CrimeType, [out](INTEGER)\_Bool)
- query CharacterIgnoreActiveCrimes([in](CHARACTERGUID)\_Character, [out](INTEGER)\_Bool)
- event CharacterStoppedLockpickingItem((CHARACTERGUID)\_Character, (ITEMGUID)\_Item)
- query DialogIsCrimeDialog([in](INTEGER)\_InstanceID, [out](INTEGER)\_IsCrimeDialog)

### Recipes

- query CharacterHasRecipeUnlocked([in](CHARACTERGUID)\_Character, [in](STRING)\_RecipeID, [out](INTEGER)\_Bool)
- event CharacterUnlockedRecipe((CHARACTERGUID)\_Character, (STRING)\_Recipe)

### Quest

- call CloseJournalMystery((CHARACTERGUID)\_Character, (STRING)\_MysteryID)
- call MapMarkerChangeLevel((STRING)\_MarkerID, (STRING)\_NewRegionID)
- event MysteryUnlocked((CHARACTERGUID)\_Character, (STRING)\_MysteryID)
- call QuestAddSubquest((CHARACTERGUID)\_Character, (STRING)\_SubquestID, (STRING)\_ParentQuestID)
- query QuestIsMysteryEntry([in](STRING)\_QuestID, [in](STRING)\_StateID, [out](INTEGER)\_Bool)
- query QuestIsSubquestEntry([in](STRING)\_QuestID, [in](STRING)\_StateID, [out](INTEGER)\_Bool)
- call UnlockJournalMystery((CHARACTERGUID)\_Character, (STRING)\_MysteryID)

### Arena

- call SendArenaNotification((INTEGER)\_NotificationType, (STRING)\_StringParam, (INTEGER)\_InNumberOfRounds)

### UI

- event MessageBoxChoiceClosed((CHARACTERGUID)\_Character, (STRING)\_Message, (STRING)\_ResultChoice)
- event MessageBoxYesNoClosed((CHARACTERGUID)\_Character, (STRING)\_Message, (INTEGER)\_Result)
- call OpenMessageBoxChoice((CHARACTERGUID)\_Character, (STRING)\_Message, (STRING)\_Choice_1, (STRING)\_Choice_2)
- call OpenMessageBoxYesNo((CHARACTERGUID)\_Character, (STRING)\_Message)

### Internal

- call AddFeedbackString((CHARACTERGUID)\_Character, (STRING)\_Location, (STRING)\_Question, (STRING)\_Answer)
- call SaveFeedback()
- call SonyRealtimeMultiplayerEvent((CHARACTERGUID)\_Character, (STRING)\_EventName)

Osiris/API/StopFollow

2018-08-15T00:35:43Z

DerCapac:

===== 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/PlayAnimation

2018-08-14T18:35:30Z

DerCapac:

===== Full Definition(s) =====
* call '''PlayAnimation'''(''(GUIDSTRING)'''''_SourceObject''', ''(STRING)'''''_Animation''', ''(STRING)'''''_Event''')
===== Description =====
Plays the animation with [[Visual_resource_panel|simple name]] '''_Animation''' on '''_SourceObject'''. Once the animation has finished playing, the event '''_Event''' will be thrown.
===== Notes =====
* We have a [[Standard_Character_Animations|list]] of simple names of character animations and the playable races for which they are available.
* After a character animation has played, the character will return to its default idle position/state. This cannot be prevented from Osiris. If you use the [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|behaviour script]] '''CharacterPlayAnimation''' call, you can avoid this by specifying '''0''' as the '''exitOnFinish''' parameter.
* This call work for both looping and non-looping animations. Animations set through this call override looping animations set via [[Osiris/API/CharacterSetAnimationOverride|CharacterSetAnimationOverride]].
* While not officially supported, you can abort an ongoing animation by playing an invalid animation on an object (e.g., specify "" as '''_Animation'''). In fact, this is the only way to stop an ongoing animation.

===== See Also =====
* [[Osiris/API/SetAnimationOverride|SetAnimationOverride]]
* [[Osiris/API/StoryEvent|StoryEvent]]

[[Category:Osiris Calls|PlayAnimation]]

Osiris/API/ItemToTransform

2018-07-20T22:29:42Z

DerCapac:

===== Full Definition(s) =====
* call '''ItemToTransform'''(''(GUIDSTRING)'''''_UUID''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''', ''(REAL)'''''_Pitch''', ''(REAL)'''''_Yaw''', ''(REAL)'''''_Roll''', ''(INTEGER)'''''_Amount''', ''(CHARACTERGUID)'''''_Owner''')

===== Description =====
Moves, rotates and changes the amount and ownership of the item with the '''_UUID'''. The position and rotation are updated instantly and without animation.

===== Notes =====
* This call requires '''_Pitch''', '''_Yaw''' and '''_Roll''' to be given in radians while all other calls and queries use degrees to measure angles. Degrees can be converted to radians by multiplying them by 0.0174533.
* This is the only call that can change the amount of an existing item in the world (e.g. a gold pile).
* To clear the ownership of an item '''NULL_00000000-0000-0000-0000-000000000000''' may be passed as '''_Owner'''.

===== Example =====

This example creates an overload that only requires '''_X''', '''_Y''' and '''_Z''' to be set.

<pre>
PROC
ItemToTransform((ITEMGUID)_Item, (REAL)_X, (REAL)_Y, (REAL)_Z)
AND
GetRotation(_Item, (REAL)_PitchDegree, (REAL)_YawDegree, (REAL)_RollDegree)
AND
RealProduct(_PitchDegree, 0.0174533, (REAL)_Pitch)
AND
RealProduct(_YawDegree, 0.0174533, (REAL)_Yaw)
AND
RealProduct(_RollDegree, 0.0174533, (REAL)_Roll)
AND
ItemGetAmount(_Item, (INTEGER)_Amount)
AND
ItemGetOwner(_Item, (CHARACTERGUID)_Owner)
THEN
ItemToTransform(_Item, _X, _Y, _Z, _Pitch, _Yaw, _Roll, _Amount, _Owner);
</pre>

===== See Also =====
* [[Osiris/API/GetPosition|GetPosition]]
* [[Osiris/API/GetRotation|GetRotation]]
* [[Osiris/API/ItemDragToPosition|ItemDragToPosition]]
* [[Osiris/API/ItemDragToTrigger|ItemDragToTrigger]]
* [[Osiris/API/ItemMoveToPosition|ItemMoveToPosition]]
* [[Osiris/API/ItemMoveToTrigger|ItemMoveToTrigger]]
* [[Osiris/API/ItemRotateY|ItemRotateY]]
* [[Osiris/API/ItemRotateToAngleY|ItemRotateToAngleY]]
* [[Osiris/API/ItemSetOwner|ItemSetOwner]]
* [[Osiris/API/TeleportTo|TeleportTo]]
* [[Osiris/API/TeleportToPosition|TeleportToPosition]]

[[Category:Osiris Calls|ItemToTransform]]

Osiris/API/ItemToTransform

2018-07-20T22:25:28Z

DerCapac: Add docs for ItemToTransform

===== Full Definition(s) =====
* call '''ItemToTransform'''(''(GUIDSTRING)'''''_UUID''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''', ''(REAL)'''''_Pitch''', ''(REAL)'''''_Yaw''', ''(REAL)'''''_Roll''', ''(INTEGER)'''''_Amount''', ''(CHARACTERGUID)'''''_Owner''')

===== Description =====
Moves, rotates and changes the amount and ownership of the item with the '''_UUID'''. The position and rotation are updated instantly and without animation.

===== Notes =====
* This call requires '''_Pitch''', '''_Yaw''' and '''_Roll''' to be given in radians while all other calls and queries use degrees to measure angles. Degrees can be converted to radians by multiplying them by 0.0174533.
* This is the only call that can change the amount of an existing item in the world (e.g. a gold pile).
* To clear the ownership of an item '''NULL_00000000-0000-0000-0000-000000000000''' may be passed as '''_Owner'''.

===== Example =====

This example creates an overload that only requires '''_X''', '''_Y''' and '''_Z''' to be set.

<pre>
PROC
ItemToTransform((ITEMGUID)_Item, (REAL)_X, (REAL)_Y, (REAL)_Z)
AND
GetRotation(_Item, (REAL)_PitchDegree, (REAL)_YawDegree, (REAL)_RollDegree)
AND
RealProduct(_PitchDegree, 0.0174533, (REAL)_Pitch)
AND
RealProduct(_YawDegree, 0.0174533, (REAL)_Yaw)
AND
RealProduct(_RollDegree, 0.0174533, (REAL)_Roll)
AND
ItemGetAmount(_Item, (INTEGER)_Amount)
AND
ItemGetOwner(_Item, (CHARACTERGUID)_Owner)
THEN
ItemToTransform(_Item, _X, _Y, _Z, _Pitch, _Yaw, _Roll, _Amount, _Owner);
</pre>

===== See Also =====
* [[Osiris/API/ItemDragToPosition|ItemDragToPosition]]
* [[Osiris/API/ItemDragToTrigger|ItemDragToTrigger]]
* [[Osiris/API/ItemMoveToPosition|ItemMoveToPosition]]
* [[Osiris/API/ItemMoveToTrigger|ItemMoveToTrigger]]
* [[Osiris/API/ItemRotateY|ItemRotateY]]
* [[Osiris/API/ItemRotateToAngleY|ItemRotateToAngleY]]
* [[Osiris/API/ItemSetOwner|ItemSetOwner]]
* [[Osiris/API/TeleportTo|TeleportTo]]
* [[Osiris/API/TeleportToPosition|TeleportToPosition]]

[[Category:Osiris Calls|ItemToTransform]]

Osiris/Shared/ProcCharacterMoveToAndTalk

2018-07-09T22:23:57Z

DerCapac:

===== Full Definition(s) =====
* PROC '''ProcCharacterMoveToAndTalk'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(STRING)'''''_Dialog''', ''(INTEGER)'''''_IsAutomated''', ''(STRING)'''''_MoveEvent''', ''(INTEGER)'''''_Running''', ''(REAL)'''''_TimeOut''')
* PROC '''ProcCharacterMoveToAndTalk'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(STRING)'''''_Dialog''', ''(INTEGER)'''''_IsAutomated''', ''(STRING)'''''_MoveEvent''', ''(INTEGER)'''''_Running''', ''(REAL)'''''_TimeOut''', ''(INTEGER)'''''_CheckForFallBackPlayers''', ''(INTEGER)'''''_ForcePartyCheck''')
===== Description =====
Moves the character '''_Character''' to '''_Target''' and starts the dialog '''_Dialog''' once '''_Character''' is close enough to '''_Target'''.

===== Notes =====
* This is a wrapper around the Osiris call [[Osiris/API/CharacterMoveToAndTalk|CharacterMoveToAndTalk]]. It takes care of possible events that may occur while the character walks to the target (e.g. the character might die or another level might be loaded).

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

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

Osiris/Shared/PROC StopLoopEffect

2018-07-09T22:23:39Z

DerCapac:

===== Full Definition(s) =====
* PROC '''PROC_StopLoopEffect'''(''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_ID''')

===== Description =====
Stops the loop effect with '''_ID''' on '''_Source'''. Only works with loop effects created through [[Osiris/Shared/PROC_LoopEffect|PROC_LoopEffect]].

===== See Also =====
* [[Osiris/Shared/PROC_LoopEffect|PROC_LoopEffect]]

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

Osiris/Shared/PROC LoopEffect

2018-07-09T22:23:31Z

DerCapac:

===== Full Definition(s) =====
* PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_ID''', ''(STRING)'''''_Region''', ''(STRING)'''''_BoneName''')

===== Description =====
Plays the looping effect '''_Effect''' on the bone '''_BoneName''' of '''_Source'''. If '''_BoneName''' is set to an empty string, the loop effect will be attached to the root of '''_Source'''.

The effect will only be played if the player is in the level '''_Region'''. If the effect should be played in any region (e.g. cause the loop effect is attached to the player itself), the region must be set to '''"__ANY__"'''.

The '''_ID''' is used to stop the loop effect through [[Osiris/Shared/PROC_StopLoopEffect|PROC_StopLoopEffect]].

===== Notes =====
* This is a wrapper around the Osiris call [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]. It takes care of starting/stopping loop effects when entering or leaving regions.

===== See Also =====
* [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]
* [[Osiris/Shared/PROC_StopLoopEffect|PROC_StopLoopEffect]]

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

Osiris/Shared/PROC StopLoopEffect

2018-07-09T22:20:47Z

DerCapac: Created page with "===== Full Definition(s) ===== * PROC '''PROC_StopLoopEffect'''(''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_ID''') ===== Description ===== Stops the loop effect with '''_I..."

Osiris/Shared/PROC LoopEffect

2018-07-09T22:19:38Z

DerCapac:

Osiris/Shared/PROC LoopEffect

2018-07-09T22:16:34Z

DerCapac: Created page with "===== Full Definition(s) ===== * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(STRING)'''''_Region''', '..."

===== Full Definition(s) =====
* PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(STRING)'''''_Region''', ''(STRING)'''''_BoneName''')

===== Description =====
Plays the looping effect '''_Effect''' on the bone '''_BoneName''' of '''_Source'''. If '''_BoneName''' is set to an empty string, the loop effect will be attached to the root of '''_Source'''.

The effect will only be played if the player is in the level '''_Region'''. If the effect should be played in any region (e.g. cause the loop effect is attached to the player itself), the region must be set to '''"__ANY__"'''.

The '''_FXHandle''' is used to stop the loop effect through [[Osiris/Shared/ProcStopLoopEffect|ProcStopLoopEffect]].

===== Notes =====
* This is a wrapper around the Osiris call [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]. It takes care of starting/stopping loop effects when entering or leaving regions.

===== See Also =====
* [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]
* [[Osiris/Shared/ProcStopLoopEffect|ProcStopLoopEffect]]

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

Osiris/Shared/ProcCharacterMoveToAndTalk

2018-07-08T18:41:52Z

DerCapac: Created page with "===== Full Definition(s) ===== * PROC '''ProcCharacterMoveToAndTalk'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(STRING)'''''_Dialog''', ''(INTEGE..."

Category:Osiris

2018-07-08T18:36:48Z

DerCapac: Created blank page

Osiris/API/CharacterUseSkillAtPosition

2018-07-06T18:01:08Z

DerCapac:

===== Full Definition(s) =====
* call '''CharacterUseSkillAtPosition'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''', ''(INTEGER)'''''_ForceResetCooldown''', ''(INTEGER)'''''_IgnoreHasSkill''')
===== Description =====
Makes '''_Character''' cast/use the skill with stats ID '''_SkillID''' on the position specified by '''_X''', '''_Y''' and '''_Z'''.

===== Notes =====
* See [[Osiris/API/CharacterUseSkillAtPosition|CharacterUseSkill]] for more information on the parameters '''_ForceResetCooldown''' and '''_IgnoreHasSkill'''.
* Unlike '''CharacterUseSkill''' this call did not receive the parameter '''IgnoreChecks''' with DOS2 Patch 5.

===== See Also =====
* [[Osiris/API/ApplyStatus|ApplyStatus]]
* [[Osiris/API/CharacterAddSkill|CharacterAddSkill]]
* [[Osiris/API/CharacterUseSkill|CharacterUseSkill]]

[[Category:Osiris Calls|CharacterUseSkillAtPosition]]

Osiris/API/CharacterUseSkillAtPosition

2018-07-06T18:00:39Z

DerCapac: Created page with "===== Full Definition(s) ===== * call '''CharacterUseSkillAtPosition'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(REAL)'''''_X''', ''(REAL)'''''_Y'''..."

===== Full Definition(s) =====
* call '''CharacterUseSkillAtPosition'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(REAL)'''''_X''', ''(REAL)'''''_Y''', ''(REAL)'''''_Z''', ''(INTEGER)'''''_ForceResetCooldown''', ''(INTEGER)'''''_IgnoreHasSkill''')
===== Description =====
Makes '''_Character''' cast/use the skill with stats ID '''_SkillID''' on the position specified by '''_X''', '''_Y''' and '''_Z'''.

===== Notes =====
* See [[Osiris/API/CharacterUseSkillAtPosition|CharacterUseSkill]] for more information on the parameters '''_ForceResetCooldown''' and '''_IgnoreHasSkill'''.
* Unlike '''CharacterUseSkill''' this call did not receive the parameter '''IgnoreChecks''' with DOS2 Patch 5.

===== See Also =====
* [[Osiris/API/ApplyStatus|ApplyStatus]]
* [[Osiris/API/CharacterAddSkill|CharacterAddSkill]]
* [[Osiris/API/CharacterUseSkillAtPosition|CharacterUseSkill]]

[[Category:Osiris Calls|CharacterUseSkillAtPosition]]

Osiris/API/CharacterUseSkill

2018-07-06T17:51:07Z

DerCapac:

===== Full Definition(s) =====
* (Shared mod) call '''CharacterUseSkill'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(GUIDSTRING)'''''_Target''')
* (Shared mod) call '''CharacterUseSkill'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_ForceResetCooldown''')
* (Shared mod) call '''CharacterUseSkill'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_ForceResetCooldown''', ''(INTEGER)'''''_IgnoreHasSkill''')
* call '''CharacterUseSkill'''(''(CHARACTERGUID)'''''_Character''', ''(STRING)'''''_SkillID''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_ForceResetCooldown''', ''(INTEGER)'''''_IgnoreHasSkill''', ''(INTEGER)'''''_IgnoreChecks''')
===== Description =====
Makes '''_Character''' cast/use the skill with stats ID '''_SkillID''' on '''_Target'''. The skill ID consists of the columns "SkillType" and "Name" one may find in the stats editor separated by an underscore (e.g. the skill ID of the skill "IceSkin" with the type "Shout" would be "Shout_IceSkin").

If '''_ForceResetCooldown''' is '''1''', the skill will be cast regardless of whether the skill is still in cool-down from a previous use by the same character. If it is '''0''', the skill will not be cast if it is still in cool-down mode.

If '''_IgnoreHasSkill''' is '''0''', this skill must have been assigned to '''_Character''' either via the sidebar in the editor or using [[Osiris/API/CharacterAddSkill|CharacterAddSkill]], or this call will not do anything. If it is '''1''', the skill will be cast regardless of whether '''_Character''' currently knows the skill.

''(New parameter in DOS2 Patch 5)'' If '''IgnoreChecks''' is '''1''', the skill will be cast even if '''_Character''' does not fullfil the skill requirements (e.g., you can use weapon-specific skills while having no weapon equipped). If '''IgnoreChecks''' is '''0''', nothing will happen if '''_Character''' does not fulfil the skill requirements.

===== Notes =====
* The Shared mod overloads pass '''0''' as the unspecified parameters.

===== See Also =====
* [[Osiris/API/ApplyStatus|ApplyStatus]]
* [[Osiris/API/CharacterAddSkill|CharacterAddSkill]]
* [[Osiris/API/CharacterUseSkillAtPosition|CharacterUseSkillAtPosition]]

[[Category:Osiris Calls|CharacterUseSkill]]

Osiris/API/EndTurn

2018-07-05T19:14:28Z

DerCapac:

===== Full Definition(s) =====
* call '''EndTurn'''(''(GUIDSTRING)'''''_Target''')
===== Description =====
Immediately ends the turn of '''_Target'''.
===== Notes =====
* If you want to skip the next turn of a certain item (or character), add it to the '''DB_CharacterSkipTurn''' database. You can add the item directly to the database or set the flag '''GEN_EndTurn''' on the item.
===== See Also =====
* [[Osiris/API/CombatStarted|CombatStarted]]
* [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]]
* [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]]
* [[Osiris/API/ObjectTurnEnded|ObjectTurnEnded]]
* Helper [[Osiris/Shared/DB_CharacterSkipTurn|DB_CharacterSkipTurn]]
* Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]]
* Helper [[Osiris/Shared/DB_SkipToCharactersTurn|DB_SkipToCharactersTurn]]

[[Category:Osiris Calls|EndTurn]]

Osiris/API/EndTurn

2018-07-05T19:10:55Z

DerCapac: Created page with "===== Full Definition(s) ===== * call '''EndTurn'''(''(GUIDSTRING)'''''_Target''') ===== Description ===== Immediately ends the turn of '''_Target'''. ===== See Also ===== * [..."

===== Full Definition(s) =====
* call '''EndTurn'''(''(GUIDSTRING)'''''_Target''')
===== Description =====
Immediately ends the turn of '''_Target'''.
===== See Also =====
* [[Osiris/API/CombatStarted|CombatStarted]]
* [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]]
* [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]]
* [[Osiris/API/ObjectTurnEnded|ObjectTurnEnded]]
* Helper [[Osiris/Shared/DB_CharacterSkipTurn|DB_CharacterSkipTurn]]
* Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]]
* Helper [[Osiris/Shared/DB_SkipToCharactersTurn|DB_SkipToCharactersTurn]]

[[Category:Osiris Calls|EndTurn]]

Osiris/API/JumpToTurn

2018-07-05T18:41:28Z

DerCapac:

===== Full Definition(s) =====
* call '''JumpToTurn'''(''(GUIDSTRING)'''''_Target''')
===== Description =====
Switches the current combat turn to '''_Target''', so that it can act immediately.
===== Notes =====
* '''_Target''' must be in a combat.
* '''_Target''''s combat information needs to have been fully initialised before this API can be used. See [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] for more information.
* In current versions of DOS2, the turn of the character currently active in combat is terminated when this call is used. In a future version, the currently active character will be shuffled to a different position in the same turn.
===== See Also =====
* [[Osiris/API/CombatStarted|CombatStarted]]
* [[Osiris/API/EndTurn|EndTurn]]
* [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]]
* [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]]
* [[Osiris/API/ObjectTurnEnded|ObjectTurnEnded]]
* Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]]

[[Category:Osiris Calls|JumpToTurn]]

Osiris/API/CharacterTeleportPartiesToTrigger

2018-06-25T22:48:27Z

DerCapac: Created page with "===== Full Definition(s) ===== * call '''CharacterTeleportPartiesToTrigger'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_Event''') ===== Description ===== Teleports all..."

===== Full Definition(s) =====
* call '''CharacterTeleportPartiesToTrigger'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_Event''')
===== Description =====
Teleports all player characters to '''_Trigger'''.
===== Notes =====
* '''_Trigger''' must be global if you want to teleport between levels.
* Use [[Osiris/API/TeleportTo|TeleportTo]] if you want to teleport individual characters.
===== See Also =====
* [[Osiris/API/TeleportTo|TeleportTo]]

[[Category:Osiris Calls|CharacterTeleportPartiesToTrigger]]

Osiris/API/TeleportTo

2018-06-25T22:43:17Z

DerCapac:

===== Full Definition(s) =====
* call '''TeleportTo'''(''(GUIDSTRING)'''''_SourceObject''', ''(GUIDSTRING)'''''_TargetObject''', ''(STRING)'''''_Event''', ''(INTEGER)'''''_TeleportLinkedCharacters''')
===== Description =====
Teleports the object '''_SourceObject''' to the location of '''_TargetObject'''. Once the object arrives there, the [[Osiris/API/StoryEvent|event]] '''_Event''' will be sent to '''_SourceObject'''. If '''_SourceObject''' is a player character and '''_TeleportLinkedCharacters''' is '''1''', then all characters currently chained to '''_SourceObject''' will also be teleported.
===== Notes =====
* '''_SourceObject''' can be a character or an item. There is also limited, experimental support for triggers, as long as you do not teleport them out of their original level.
* You can teleport objects from other levels (except for triggers) if they are global.
* You can teleport objects that are [[Osiris/API/SetOnStage|off-stage]].
* You cannot use this command to telport players to another level, use [[Osiris/API/CharacterTeleportPartiesToTrigger|CharacterTeleportPartiesToTrigger]] instead.
===== See Also =====
* [[Osiris/API/TeleportToPosition|TeleportToPosition]]

[[Category:Osiris Calls|TeleportTo]]

Osiris/Shared/PROC GLOBAL DialogStartRequested

2018-02-07T22:00:53Z

DerCapac:

===== Full Definition(s) =====
* PROC '''PROC_GLOBAL_DialogStartRequested'''(''(GUIDSTRING)'''''_Target''', ''(GUIDSTRING)'''''_Source''')
===== Description =====
This routine is called by the Shared mod for every '''DialogStartRequested''' Osiris event. It does this after checking that the characters can hold a conversation (are not in combat, are not henchmen, ...), but before any checks regarding the generics system (such as low attitude).
===== Return Values =====
* You can set '''DB_FoundDialog'''('''_Target''','''_Source''') in this procedure if you want the rest of the standard logic to find a suitable dialog to start to abort. If you do not do this, the standard logic will continue. However, if you started a dialog involving target and/or source yourself inside this routine, the generic code will still fail to start a dialog once it has found one. After all, characters can only be involved in one dialog at a time.
===== Notes =====
* If you only want to set or clear certain flags before a particular dialog starts, use [[Osiris/Shared/Proc_DialogFlagSetup|Proc_DialogFlagSetup]]
* '''_Target''' is usually the NPC while '''_Source''' is the player character.
===== See Also =====
* [[Osiris/API/DialogStartRequested|DialogStartRequested]]
* Helper [[Osiris/Shared/Proc_DialogFlagSetup|Proc_DialogFlagSetup]]
* Helper [[Osiris/Shared/PROC_GLOBAL_DialogStartRequested_AfterGenerics|PROC_GLOBAL_DialogStartRequested_AfterGenerics]]
* Helper [[Osiris/Shared/Proc_StartDialog|Proc_StartDialog]]

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