Modding/Scripts

From Pillars of Eternity Wiki
Jump to: navigation, search

Script functions[edit | edit source]

List of all script functions (1.0.6) usable for "onEnterScripts" and "onExitscripts" in the Quests. With exception of getPlayerMoney none of them returns a value.

Some of them need a Guid parameter, which have a specific Component. OpenStore(Guid) for example is only possible with the Guid of a merchant NPC. The list of all npcs in Modding/Quest/ does not necessarily contain all merchants and of course not the Guids for container needed for the Lock(Guid) and UnLock(Guid) function.

xml description name category param0 param1 param2 param3 param4 param5 param6
Void AISetPackage(Guid, PackageType) Changes the Behavior of the given GUID. Set Package Scripts\\AI name: "Object", description: "Object to modify.", default = "", type: "ObjectGuid" name: "AI Package", description: "New package for the AI", default: "", type: "PackageType"
Void AISetPatrolling(Guid, Boolean) Enables or Disables the patrolling of this Character. Set Patrol State Scripts\\AI name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Should Patrol", description: "The new state of patrolling", default: "", type: ""
Void AISetPatrolPoint(Guid, Guid) Sets the basis around which the character patrols. Set Patrol Point Scripts\\AI name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Patrol Point", description: "New base patrol point", default: "", type: "ObjectGuid"
Void AIPathToPoint(Guid, Guid, MovementType) Clears the current Patrol waypoints of the NPC and sets a the waypoint as new one. Move to Point Scripts\\AI name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Point", description: "Object to path to", default: "", type: "ObjectGuid" name: "Movement Type", description: "How to get there", default: "", type: "MovementType"
Void AIForceAttack(Guid, Guid) The given character attacks the target with its primary attack. Force Attack Scripts\\AI name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Target", description: "Object to attack", default: "", type: "ObjectGuid"
Void AISetBusy(Guid, Boolean) Sets the busy state Set Busy State Scripts\\AI name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Is Busy", description: "The new state of busy", default: "", type: ""
Void KnockDown(Guid, Single) Knocks the character godly down. Min duration 0.1s. Knock Down Scripts\\AI name: "Target", description: "Character to knock down", default: "", type: "ObjectGuid" name: "Duration", description: "The time is seconds for the character to lie down", default: "1.0"
Void PlayerSafeMode(Boolean) Set the Game safe from any player input and clear all queued actions and close windows. Use this to play cutscenes or scripted movements. Player Safe Mode Scripts\\AI name: "Enabled", description: "True to disable party character AIs and Input, false to restore", default: "true", type: ""
Void ForceInCombatIdle(Guid, Boolean) Forces the chacter to do nothing in combat. Force In Combat Idle Scripts\\AI name: "NPC", description: "Set the combat idle stance for this character.", default: "", type: "ObjectGuid" name: "In Combat Idle", description: "Whether the character should be a combat idle stance.", default: "true"
Void ForceCombatPathing(Guid, Boolean) Call with true if the character should use the pathfinding for combat situations. Force Combat Pathing Scripts\\AI name: "NPC", description: "Set combat pathing for this character.", default: "", type: "ObjectGuid" name: "Use Combat Pathing", description: "Whether the character should be forced to use combat pathing.", default: "true"
Void PlaySound(Guid, String) Plays from this Object a named sound. Play Sound From Bank Scripts\\Audio name: "Object", description: "Object with audiobank", default: "", type: "ObjectGuid" name: "Sound Cue", description: "The name of the cue in the audio bank.", default: "", type: ""
Void PlaySound(Guid) Plays the audio from this Object. A clip must be set before. Play Sound From Source Scripts\\Audio name: "Object", description: "Object with AudioSource", default: "", type: "ObjectGuid"
Void PlaySoundFromSoundSet(Guid, SoundAction, Int32) Play a sound from the sound set of this character. Will use a fallback if the character does not have this sound. Play Sound From Sound Set Scripts\\Audio name: "Object", description: "Object with Sound Set", default: "", type: "ObjectGuid" name: "Sound Action", description: "Sound To Play", default: "Invalid", type: "" name: "Sound Variation", description: "Variation to play", default: "-1", type: ""
Void PlayCommentary(Guid) Plays the developer comentary for this object. Play Commentary Scripts\\Audio name: "Object", description: "Object with a developer commentary component", default: "", type: "ObjectGuid"
Void PlayMusic(String) Plays the audio file. Play Music Scripts\\Audio name: "Audio Clip Filename", description: "AudioClip path relative to the Resources folder.", default: "", type: ""
Void PlayScriptedMusic(String, Boolean, FadeType, Single, Single, Single, Boolean) Plays the audio file with the given fading configuration. Play Scripted Music Scripts\\Audio name: "Clip Name", description: "The scripted clip name specified in Area Music", default: "", type: "" name: "Block Combat Music", description: "Prevents game from playing normal combat music", default: "false", type: "" name: "Fade Type", description: "The type of fade to use when transitioning to new music.", default: "FadeOutPauseFadeIn", type: "" name: "Fade Out Duration", description: "The length in seconds to fade out new music.", default: "0.5", type: "" name: "Fade In Duration", description: "The length in seconds to fade in new music.", default: "0.5", type: "" name: "Pause Duration", description: "The length in seconds to fade in new music.", default: "0.5", type: "" name: "Loop", description: "Designates if the music should loop.", default: "false"
Void EndScriptedMusic() End the current scripted song and resumes normal/ area music. End Scripted Music Scripts\\Audio
Void ResumeAreaMusic() Resumes the area music if it exists, or the scripted Song Resume Area Music Scripts\\Audio
Void FadeOutAreaMusic() Quickly fades out area Music Fade Out Area Music Scripts\\Audio
Void EnableMusicLoopCooldown() Sets a flag Enable Music Loop Cooldown Scripts\\Audio
Void DisableMusicLoopCooldown() Removes a flag Disable Music Loop Cooldown Scripts\\Audio
Void FadeOutAudio(Guid, Single) Fades out all audio of this object Fade Out Audio Scripts\\Audio name: "Parent Object", description: "The parent object with the audio sources", default: "", type: "ObjectGuid" name: "Fade Time", description: "How long to fade the audio in seconds.", default: "1.0"
Void FadeInAudio(Guid, Single) Fades in all audio of this object Fade In Audio Scripts\\Audio name: "Parent Object", description: "The parent object with the audio sources", default: "", type: "ObjectGuid" name: "Fade Time", description: "How long to fade the audio in seconds.", default: "1.0"
Void OverrideFatigueWhispers(Single) Overrides the volume of fatigue whispers. Override Fatigue Whispers Scripts\\Audio name: "New Volume", description: "The new volume to force the fatigue whispers to.", default: "0.0"
Void ReleaseFatigueWhisperOverride() Remove a fatigue volume override. Release Fatigue Whisper Override Scripts\\Audio
Void SetIsHostile(Guid, Boolean) Set the NPC hostile or neutral to the player. Set Is Hostile Scripts\\Faction name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Is Hostile", description: "Hostile state towards the player", default: "true"
Void SetTeamRelationship(String, String, Relationship) Sets the relationship between 2 teams. Set Team Relationship Scripts\\Faction name: "Team A", description: "The first team to change", default: "", type: "" name: "Team B", description: "The second team to change", default: "", type: "" name: "Relationship", description: "How team A and B will relate to each other", default: "", type: ""
Void ReputationAddPoints(FactionName, Axis, ChangeStrength)", AdjustStat("axis", "strength", "id"), description: "Modifies the reputation of the player by the given team. Reputation Add Points By Tag Scripts\\Faction name: "Faction Name", description: "Faction tag to modify", default: "", type: "FactionName", type: "" name: "Axis", description: "Good vs. Bad action", default: "Positive"", type: "ReputationAxis" name: "Strength", description: "Severity of the change", default: "Minor", type: "ReputationChangeStrength"
Void DispositionAddPoints(Axis, Strength)", AdjustStat("axis", "strength"), description: "Increses the given player character disposition. Disposition Add Points Scripts\\Disposition name: "Axis", description: "Action type", default: "Aggressive", type: "Disposition" , "param1: name: "Strength", description: "Severity of the change", default: "Minor", type: "DispositionRankStrength"
Void PrintString(String) Writs a String to the ingame log. Print String Scripts\\General name: "Text", description: "String print to the console", default: "", type: ""
Void ActivateObject(Guid, Boolean) Activates or deactivates an object. Activate Object Scripts\\General name: "Object", description: "Object to activate.", default: "", type: "ObjectGuid" name: "Active", description: "Active state to set the object to.", default: "true"
Void StartConversation(Guid, String, Int32) Starts a Conversation based on the given File on this node id. Dead People cant speak. Start Conversation Scripts\\Conversation name: "Object", description: "Speaker Object", default: "", type: "ObjectGuid" name: "Conversation", description: "Conversation File", default: "", type: "Conversation" name: "Conversation Node ID", description: "Conversation Node ID", default: "0"
Void StartScriptedInteraction(Guid) Starts a scripted interaction with this object if it have one. Start Scripted Interaction Scripts\\Interaction name: "Object", description: "Scripted Interaction Object", default: "", type: "ObjectGuid"
Void StartCutscene(Guid) Starts the given Cutscene. Start Cutscene Scripts\\Cutscene name: "Object", description: "Cutscene Object", default: "", type: "ObjectGuid"
Void AreaTransition(MapType, PointLocation) Transition on to the new map, from the startpoint Area Transition Scripts\\Area name: "Area Name", description: "The name of the area", default: "", type: "MapType" name: "Start Point Name", description: "The name of the start point", default: "", type: "PointLocation"
Void AddExperience(Int32) Gives each party member this many xp. Add Experience Scripts\\Quest name: "Experience", description: "Amount of XP to reward", default: "50"
Void AddExperienceToLevel(Int32) Instantly reach the given level with all party members Add Experience To Level Scripts\\Quest name: "Level", description: "The level you want to level to", default: "12"
Void AddExperiencePlayer(Int32) Gives only the player character xp. Add Experience Player Scripts\\Quest name: "Experience", description: "Amount of XP to reward", default: "50"
Void SetInteractionImage(Int32) Changes the image in a scripted interaction screen to the one of the given state Set Interaction Image Scripts\\Interaction name: "Interaction Image", description: "The interaction image index", default: "0"
Void FlipTile(Guid, Int32) ? Flip Tile Scripts\\Tile name: "Object", description: "Flip tile object", default: "", type: "ObjectGuid" name: "Frame", description: "The interaction image index", default: "0"
Void AddToParty(Guid) Adds the NPC to the party. Add to Party Scripts\\Party name: "Tag", description: "Companion to Add", default: "", type: "ObjectGuid"
Void RemoveFromParty(Guid) Removes the NPC from the party Remove from Party Scripts\\Party name: "Tag", description: "Companion to Remove", default: "", type: "ObjectGuid"
Void TeleportPartyToLocation(Guid) Teleports the party on the same map to the given point. Teleport Party To Location Scripts\\Movement name: "Tag", description: "Location to teleport to ", default: "", type: "ObjectGuid"
Void TeleportPlayerToLocation(Guid) Teleports the player on the same map to the given point. Teleport Player To Location Scripts\\Movement name: "Tag", description: "Location to teleport to ", default: "", type: "ObjectGuid"
Void TeleportObjectToLocation(Guid, Guid) Teleports the object on the same map to the given point. Teleport Object To Location Scripts\\Movement name: "Object", description: "The object to teleport", default: "", type: "ObjectGuid" name: "Tag", description: "Location to teleport to.", default: "", type: "ObjectGuid"
Void StartTimer(Guid) Start the given timer Start Timer Scripts\\Timer name: "Object", description: "The timer object", default: "", type: "ObjectGuid"
Void StopTimer(Guid) Stop the given timer Stop Timer Scripts\\Timer name: "Object", description: "The timer object", default: "", type: "ObjectGuid"
Void SetTimer(Guid, Single) Set the timer to this value (seconds. If the timer runs out 'On timer Finished' scripts are executed."), name: "Set Timer Scripts\\Timer name: "Object", description: "The timer object", default: "", type: "ObjectGuid" name: "Time", description: "New delay time for timer", default: "1"
Void Rest() Rests with camp fire movie Rest Scripts\\Time
Void RestWithMovieID(Mode) Rests with given movie RestWithMovieID Scripts\\Time name: "MovieType", description: "This is the movie enum to display", default: "0", type: "RestMovieMode"
Void AdvanceTimeByHours(Int32) Advances time by x hours. AdvanceTimeByHours Scripts\\Time name: "Hours", description: "Hours to advance", default: "8"
Void AdvanceTimeToHour(Int32) Advances time to this hour. AdvanceTimeToHour Scripts\\Time name: "Hour", description: "Hour to advance to", default: "0"
Void ChangeWaterLevel(Guid, Single, Single) Changes the water level over the given time. Change Water Level Scripts\\Water name: "Object", description: "The water plane", default: "", type: "ObjectGuid" name: "Water Level", description: "New Water Level", default: "0", type: "" name: "Timer", description: "Time to move to new level", default: "1", type: ""
Void SetTriggerEnabled(Guid, Boolean) Enable or disable a trigger. Set Trigger Enabled Scripts\\Trigger name: "Object", description: "The trigger", default: "", type: "ObjectGuid" name: "isEnabled", description: "New Enabled Value", default: "true"
Void SetSwitchEnabled(Guid, Boolean) Enable or disable a switch. Set Switch Enabled Scripts\\Switch name: "Object", description: "The switch", default: "", type: "ObjectGuid" name: "isEnabled", description: "New Enabled Value", default: "true"
Void WorldMapSetVisibility(MapType, VisibilityType) Change the visibility of a map. World Map Set Visibility Scripts\\Trigger name: "Map", description: "Map to change status of", default: "Map", type: "MapType" name: "Visibility", description: "New visibility status", default: "Locked", type: "WorldMapVisibilityType"
Void FadeToBlack(Single, Boolean, Boolean) Fade out in given time. Fade To Black Scripts\\Fade name: "Fade Time", description: "Fade time", default: "2.0", type: "" name: "Fade Music", description: "Fade music", default: "true", type: "" name: "Fade Ambient Audio", description: "Fade all ambient audio", default: "true"
Void FadeFromBlack(Single, Boolean, Boolean) Fade in in given time. Fade From Black Scripts\\Fade name: "Fade Time", description: "Fade time", default: "2.0", type: "" name: "Fade Music", description: "Fade music", default: "true", type: "" name: "Fade Ambient Audio", description: "Fade all ambient audio", default: "true"
Void EncounterSpawn(Guid) Spawns an encounter, can be Creatures, NPCs, or companions not currently in party or stronghold. Encounter Spawn Scripts\\Encounter name: "Object", description: "The Encounter", default: "", type: "ObjectGuid"
Void EncounterDespawn(Guid) Removes all members of this encounter. Encounter Despawn Scripts\\Encounter name: "Object", description: "The Encounter", default: "", type: "ObjectGuid"
Void EncounterSetCombatEndWhenAllAreDeadFlag(Guid, Boolean) Sets the encounter end flag. Encounter Set Combat End When All Are Dead Flag Scripts\\Encounter name: "Object", description: "The Encounter", default: "", type: "ObjectGuid" name: "CombatEndWhenAllAreDeadFlag", description: "Set this value", default: "true"
Void SetNavMeshObstacleActivated(Guid, Boolean) Sets if the object is unwalkable. SetNavMeshObstacleActivated Scripts\\NavObstacle name: "Is Active", description: "Sets if the obstacle is activated or not.", default: "true"
Void SetBackground(Guid, Background) Sets the roleplay background of the character. Set Background Scripts\\Background name: "Object", description: "The character to set background on", default: "", type: "ObjectGuid" name: "Background", description: "The background value", default: "0", type: "Background"
Void SetPlayerBackground(Background) Sets the roleplay background of the player. Set Player Background Scripts\\PlayerBackground name: "Background", description: "The background value", default: "0"
Void UnlockPresentStoryItem(String) Unlocks the given present journal entry. Unlock Present Story Item Scripts\\PlayerBackground name: "Key", description: "The String of the item to unlock", default: "", type: ""
Void UnlockPastStoryItem(String) Unlocks the given history journal entry. Unlock Past Story Item Scripts\\PlayerBackground name: "Key", description: "The String of the item to unlock", default: "", type: ""
Void EndGame() Shows the endgame slides. End Game Scripts\\General
Void Autosave() Make a save Autosave Scripts\\General
Void ScreenShake(Single, Single) Shakes the Screen Screen Shake Scripts\\Camera name: "Duration", description: "Duration of the shake", default: "0", type: "" name: "Strength", description: "Strength of the shake", default: "0", type: ""
Void IncrementTrackedAchievementStat(TrackedAchievementStat) Adds one to the given archivment stat. Increment Tracked Achievement Stat Scripts\\General name: "Tracked Stat", description: "The tracked achievement stat we are incrementing.", default: "TrackedStat", type: "TrackedAchievementStat"
Void DecrementTrackedAchievementStat(TrackedAchievementStat) Remove one from the given achievement stat. Decrement Tracked Achievement Stat Scripts\\General name: "Tracked Stat", description: "The tracked achievement stat we are incrementing.", default: "TrackedStat", type: "TrackedAchievementStat"
Void IncrementTrackedAchievementStat(TrackedAchievementStat, Int32) Sets the given achievement stat to this value. Set Tracked Achievement Stat Scripts\\General name: "Tracked Stat", description: "The tracked achievement stat we are incrementing.", default: "TrackedStat", type: "TrackedAchievementStat" name: "New Value", description: "The new value we are setting the tracked stat to.", default: "0", type: ""
Void SelectWeaponSet(Guid, Int32) Changes the Weaponset of the character. Select Weapon Set Scripts\\General name: "Object", description: "Character", default: "", type: "ObjectGuid" name: "Weapon Set ID", description: "The index of the weapon set to apply.", default: "0"
Void SoulMemoryCameraEnable(Boolean) Shows the purple soul memory camera overlay Soul Memory Camera Enable Scripts\\Camera name: "Enabled", description: "Whether the camera should be enabled or disabled", default: "true"
Void DisableFogOfWar() Disalbe fog of war. Disable Fog Of War Scripts\\Fog of War
Void RevealAllFogOfWar() Show anything on the map. Fog Of War Reveal All Scripts\\Fog of War
Void PointOfNoReturnSave() Saves game, if not on trial of iron mode. Point Of No Return Save Scripts\\General
Void GameCompleteSave() Make a full save Game Complete Save Scripts\\General
Void SetGlobalValue(String, Int32) Sets the global variable to given value. Set Global Scripts\\Globals name: "Name", description: "Global Name", default: "GlobalName", type: "GlobalVariable" name: "Value", description: "Global Value", default: "0"
Void IncrementGlobalValue(String, Int32) Add one tho the global variable. Increment Global Scripts\\Globals name: "Name", description: "Global Name", default: "GlobalName", type: "GlobalVariable" name: "Value", description: "Increase Global by Value", default: "1"
Void RandomizeGlobalValue(String, Int32, Int32) Assigns a random value to the global, which is between minValue an maxValue. Randomize Global Scripts\\Globals name: "Name", description: "Global Name", default: "GlobalName", type: "GlobalVariable" name: "MinValue", description: "Minimum Value for Global", default: "1", type: "" name: "MaxValue", description: "Maximum Value for Global", default: "2", type: ""
Void RandomizeGlobalValueWithGlobal(String, String, String) Assigns a random value to the global, which is between the values of other global variables. Randomize Global With Global Scripts\\Globals name: "Name", description: "Global Name", default: "GlobalName", type: "GlobalVariable" name: "MinValueGlobal", description: "Minimum Value for Global", default: "GlobalName", type: "GlobalVariable" name: "MaxValueGlobal", description: "Maximum Value for Global", default: "GlobalName", type: "GlobalVariable"
Void SetHealth(Guid, Single) Sets health of the given character. Capped at max health. Set Health Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Health Value", description: "Set current health to this value", default: "100.0"
Void SetStamina(Guid, Single) Sets stamina of the given character. Capped at max stamina. Set Stamina Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Stamina Value", description: "Set current stamina to this value", default: "100.0"
Void SetFatigue(Guid, Single) Sets the fatigue value. Set Fatigue Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" "Fatigue Value", "Set current fatigue time to this value (in hours)", default: "24.0"
Void AddFatigue(Guid, Single) Add to the current fatigue. Add Fatigue Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" "Fatigue Value", "Add this value to current fatigue time (in hours)", default: "24.0"
Void AddFatigueToParty(Single) Add the given hours of fatigue to the party. Add Fatigue To Party Scripts\\Health "Fatigue Value", "Add this value to current fatigue time in hours)", "24.0"
Void AddFatigueToSlot(Single, Int32) Add the given hours of fatigue to the character at the given slot. Add Fatigue To Slot Scripts\\Health "Fatigue Value", "Add this value to current fatigue time (in hours).", "24.0"
Void AddFatigueToPartyWithSkillCheck(Single, SkillType, Operator, Int32) Add fatigue to the party member if they success at the skilltest Add Fatigue To Party With Skill Check Scripts\\Health name: "Fatigue Value", description: "Add this value to current fatigue time (in hours)", default: "24.0", type: "" name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "" name: "Skill Operator", description: "Comparison operator.", default: "EqualTo", type: "ConditionalOperator" name: "Skill Value", description: "Compare the object's skill against this value.", default: "0", type: ""
Void HealParty() Revives unconscious chracters and set health and stamina to maximum. Heal Party Scripts\\Health
Void SetInvunerable(Guid, Boolean) Set the object Invunerable Set Invunerable Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Invunerable", description: "Sets the venerability of the object", default: "true"
Void SetPreventDeath(Guid, Boolean) Prevents death. One time? Set Prevent Death Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Prevent Death", description: "Sets the death prevention of the object", default: "true"
Void Kill(Guid) Kills a Character. Can not kill animal companions or characters with prevent death. Kill Scripts\\Health name: "Object", description: "Object to kill.", default: "", type: "ObjectGuid"
Void DealDamage(Guid, Single) Deal damage to a character. Deal Damage Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" "Damage", "Deals this amount of damage to the object (armor/defense is applied to calculation)", "10.0"
Void ApplyAffliction(Guid, String) Apply an affliction to the character. See afflictions.stringtable Apply Affliction Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Affliction", description: "Applies this affliction to the object", default: "", type: ""
Void ApplyAfflictionToPartyMember(String, Int32) Apply an affliction to the partymember at the given slot. See afflictions.stringtable Apply Affliciton To Party Member Slot # Scripts\\Health name: "Affliction", description: "Applies this affliction to the object", default: "", type: "" name: "Slot #", description: "Party member slot # to apply affliction to", default: "", type: ""
Void RemoveAffliction(Guid, String) Remove an affliction from the character. Remove Affliction Scripts\\Health name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Affliction", description: "Removes this affliction from the object", default: "", type: ""
Void ApplyAfflictionToPartyWithSkillCheck(String, SkillType, Operator, Int32) Apply an affliction to each party member if the succeed at the skillcheck. Apply Affliction To Party With Skill Check Scripts\\Health name: "Affliction", description: "Applies this affliction to the object", default: "", type: "" name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "" name: "Skill Operator", description: "Comparison operator.", default: "EqualTo", type: "ConditionalOperator" name: "Skill Value", description: "Compare the object's skill against this value.", default: "0", type: ""
Void ApplyAfflictionToWorstPartyMember(String, SkillType) Finds the partymember with the lowest given stat and apply the affliction to him. Apply Affliction To Worst Party Member Scripts\\Health name: "Affliction", description: "Applies this affliction to the object", default: "", type: "" name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "SkillType"
Void ApplyAfflictionToBestPartyMember(String, SkillType) Finds the partymember with the highest given stat and apply the affliction to him. Set Affliction To Best Party Member Scripts\\Health name: "Affliction", description: "Applies this affliction to the object", default: "", type: "" name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "SkillType"
Void SetSkillCheckToken(SkillType, Operator, Int32) Fills the skillcheck token array with all party members who succeed the test. Set Skill Check Token Scripts\\Health name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "SkillType" name: "Skill Operator", description: "Comparison operator.", default: "EqualTo", type: "ConditionalOperator" name: "Skill Value", description: "Compare the object's skill against this value.", default: "0"
Void SetSkillCheckTokenWorst(SkillType) Sets the first token array enrty to the party member with the worst skill level. Set Skill Check Token With Worst Check Scripts\\Health name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "SkillType"
Void SetSkillCheckTokenBest(SkillType) Sets the first token array entry to the party member with the best skill level. Set Skill Check Token With Best Check Scripts\\Health name: "Skill Type", description: "Skill to test.", default: "Stealth", type: "SkillType"
Void RemoveItem(String) Remove the item one time from the current party inventories. Don't affect the stash. Remove Item Scripts\\Items name: "Item Name", description: "The name of the item to remove", default: "ItemName"
Void RemoveItemFromNPC(Guid, String) Removes the item from the character, equipped or in inventory. Remove Item from NPC Scripts\\Items name: "NPC", description: "Remove item from this NPC.", default: "", type: "ObjectGuid" name: "Item Name", description: "The name of the item to remove", default: "ItemName"
Void GiveItem(String, Int32) Gives the player character the named item. Give Item By Name Scripts\\Items name: "Item Name", description: "The name of the item to give", default: "ItemName", type: "" name: "Count", description: "The number of items to add", default: "1", type: ""
Void GiveItemAndEquip(Guid, String, Boolean) Gives the character the named item and equip it to primary or secondary weapon slot. Works only for weapons. Give Item And Equip Scripts\\Items name: "NPC", description: "NPC to give the item to.", default: "", type: "ObjectGuid" name: "Item Name", description: "The name of the item to give", default: "ItemName", type: "" name: "Primary", description: "Equip the item in the primary slot (left hand", default: "false"
Void GiveItemToNPC(Guid, String, Int32) Gives the named Item count times to the character. Give Item to NPC Scripts\\Items name: "NPC", description: "NPC to give the item to.", default: "", type: "ObjectGuid" name: "Item Name", description: "The name of the item to give", default: "ItemName", type: "" name: "Count", description: "The number of items to add", default: "1", type: ""
Void RemoveItemStack(String, Int32) Remove the item count times from the party. Goes through all member inventories to find enough items to remove. Remove Item Stack Scripts\\Items name: "Item Name", description: "The name of the item to remove", default: "ItemName", type: "" name: "Count", description: "The number of items to remove", default: "1", type: ""
Void RemoveItemStackFromNPC(Guid, String, Int32) Remove the item count times from the character. Remove Item Stack From NPC Scripts\\Items name: "NPC", description: "NPC to lose item.", default: "", type: "ObjectGuid" name: "Item Name", description: "The name of the item to remove", default: "ItemName", type: "" name: "Count", description: "The number of items to remove", default: "1", type: ""
Void UnequipItemInSlot(Guid, EquipmentSlot) Removes the item equiped in the given slot of the character. Stores it in Inventory. Unequip Item in Slot Scripts\\Items name: "Character", description: "Character to unequip.", default: "", type: "ObjectGuid" name: "Slot", description: "Equipment Slot to unequip", default: "None", type: "EquipmentSlot"
Int32 GetPlayerMoney() Returns the total money. Get Player Money Scripts\\Items
Void GivePlayerMoney(Int32) Gives money to the player. Give Player Money Scripts\\Items name: "Amount", description: "The amount of money to add to the player", default: "1"
Void RemovePlayerMoney(Int32) Remove the given amount of money from the player. If he have not enough it removes all money. Remove Player Money Scripts\\Items name: "Amount", description: "The amount of money to remove from the player", default: "1"
Void LogRecipeGet(String) Logs the fact that the group has learned a recipe. Log Given Recipe Scripts\\Items name: "Recipe Name", description: "The name of the recipe learned", default: "RecipeName"
Void RemoveItemInSlot(Guid, EquipmentSlot) Completely removes the item from the characters slot. Remove Item in Slot Scripts\\Items name: "Character", description: "Remove the item from this character.", default: "", type: "ObjectGuid" name: "Slot", description: "Equipment Slot to remove", default: "None", type: "EquipmentSlot"
Void LockEquipmentSlot(Guid, EquipmentSlot) Disables the given slot. Lock Equipment Slot Scripts\\Testing name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Slot", description: "Equipment Slot to lock", default: "None", type: "EquipmentSlot"
Void UnlockEquipmentSlot(Guid, EquipmentSlot) Enables the given slot. Unlock Equipment Slot Scripts\\Testing name: "Object", description: "Object to modify.", default: "", type: "ObjectGuid" name: "Slot", description: "Equipment Slot to unlock", default: "None", type: "EquipmentSlot"
Void Open(Guid, Boolean) Opens a container/door. Open Scripts\\OCL name: "Object", description: "Object to open.", default: "", type: "ObjectGuid" name: "Ignore Lock", description: "Should we ignore the lock to open", default: "false"
Void SealOpen(Guid, Boolean) Opens a container/door and unlocks the seal. Seal Open Scripts\\OCL name: "Object", description: "Object to open.", default: "", type: "ObjectGuid" name: "Ignore Lock", description: "Should we ignore the lock to open", default: "false"
Void Close(Guid) Close a container/door. Close Scripts\\OCL name: "Object", description: "Object to close.", default: "", type: "ObjectGuid"
Void Lock(Guid) Locks a container/door. Lock Scripts\\OCL name: "Object", description: "Name of the object", default: "", type: "ObjectGuid"
Void Unlock(Guid) Unlocks a container/door. UnLock Scripts\\OCL name: "Object", description: "Object to unlock.", default: "", type: "ObjectGuid"
Void ToggleOpen(Guid, Boolean) Toggle the container/door open state. Toggle Open Scripts\\OCL name: "Object", description: "Object to toggle.", default: "", type: "ObjectGuid" name: "Ignore Lock", description: "Should we ignore the lock to open", default: "false"
Void ToggleLock(Guid) Toggle the container/door lock state. Toggle Lock Scripts\\OCL name: "Object", description: "Object to toggle.", default: "", type: "ObjectGuid"
Void StartQuest(String) Starts the named Quest. Start Quest Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest"
Void AdvanceQuest(String) Advances the named Quest. Advance Quest Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest"
Void DebugAdvanceQuest(String) Advances the named Quest, ignores not met conditions. Debug Advance Quest Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest"
Void TriggerQuestAddendum(String, Int32) Adds the quest addendum to the questlog. Trigger Quest Addendum Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest" name: "Addendum ID", description: "The ID of the addendum to set.", default: "0"
Void TriggerQuestEndState(String, Int32) Adds the quest endstate to the questlog, ends the quest as success. Trigger Quest End State Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest" name: "End State ID", description: "The ID of the end state to set.", default: "0"
Void TriggerQuestFailState(String, Int32) Adds the quest endstate to the questlog, ends the quest as failed. Trigger Quest Fail State Scripts\\Quest name: "Quest Name", description: "The name of the quest.", default: "", type: "Quest" name: "End State ID", description: "The ID of the end state to set.", default: "0"
Void AddTalent(String) Add the abbility to the player. Add Talent Scripts\\RPG name: "Talent Name", description: "The name of the talent to add to the player. Should be faster when provided an objectGuid.", default: "TalentName"
Void AddTalent(Guid, String) Add the abbility to the character. Add Talent Scripts\\RPG name: "Target character", description: "The character desired to add talent/ability", default: "", type: "ObjectGuid" name: "Talent Name", description: "The name of the talent to add to the character.", default: "TalentName"
Void RemoveTalent(Guid, String) Remove the abbility from the character. Remove Talent Scripts\\RPG name: "Target character", description: "The character desired to remove talent/ability", default: "", type: "ObjectGuid" name: "Talent Name", description: "The name of the talent to remove from the character. Will also remove abilities.", default: "TalentName"
Void SetWantsToTalk(Guid, Boolean) Sets the 'wants to talk' flag. Set Wants To Talk Scripts\\RPG name: "Target Party Member", description: "The party member desired to show the flag", default: "", type: "ObjectGuid" name: "Wants To Talk", description: "The new state for the conversation flag", default: "false"
Void MarkConversationNodeAsRead(String, Int32) Sets the node of the given conversation as read. Mark Conversation Node As Read Scripts\\Conversation name: "Conversation", description: "Name of the conversation.", default: "", type: "Conversation" name: "Conversation Node ID", description: "Conversation node ID.", default: "0"
Void ClearConversationNodeAsRead(String, Int32) Sets the node of the given conversation as unread. Clear Conversation Node As Read Scripts\\Conversation name: "Conversation", description: "Name of the conversation.", default: "", type: "Conversation" name: "Conversation Node ID", description: "Conversation node ID.", default: "0"
Void OpenStore(Guid) Opens the store ui of the vendor. Open Store Scripts\\Stores name: "Vendor", description: "Vendor object to open.", default: "", type: "ObjectGuid"
Void OpenStoreWithRates(Guid, Single, Single) Opens the store ui of the vendor with buy and sell price multiplicator. Fullprice is 1.0 Open Store with Rates Scripts\\Stores name: "Vendor", description: "Vendor object to open.", default: "", type: "ObjectGuid" name: "Buy Rate", description: "Buy Rate (default 0.2)", default: "0.2", type: "" "Sell Rate", "Sell Rate (default 1.5)", default: "1.5", type: ""
Void OpenInn(Guid) Opens the inn ui of the vendor. Open Inn Scripts\\Stores name: "Vendor", description: "Vendor object to open.", default: "", type: "ObjectGuid"
Void OpenInnWithRate(Guid, Single) Opens the inn ui of the vendor with sleep price multiplier. Fullprice is 1.0 Open Inn Scripts\\Stores name: "Vendor", description: "Vendor object to open.", default: "", type: "ObjectGuid" "Rate", "Rate multiplier (default 1.0)", default: "1.0"
Void SetVendorRates(Guid, Single, Single, Single) Sets the multipliers for buy, sell and sleep of the vendor Set Vendor Rates Scripts\\Stores name: "Vendor", description: "Vendor object to set.", default: "", type: "ObjectGuid" name: "Buy Rate", description: "Buy Rate (default 0.2)", default: "0.2", type: "" name: "Sell Rate", description: "Sell Rate (default 1.5)", default: "1.5", type: "" "Inn Rate", "Inn Rate (default 1.0)", default: "1.0", type: ""
Void OpenRecruitment(Guid) Opens the recruitment ui. Open Recruitment Scripts\\Stores name: "Vendor", description: "Vendor object to open.", default: "", type: "ObjectGuid"
Void ActivateStronghold() Activates the Stronghold Activate Stronghold Scripts\\Stronghold
Void DisableStronghold() Disable the Stronghold Disable Stronghold Scripts\\Stronghold
Void ShowStrongholdUI(WindowPane) Opens the stronghold ui on the given page. Show Stronghold UI Scripts\\Stronghold name: "Window", description: "Window To Show", default: "Status", type: "StrongholdWindowPane"
Void AddPrisoner(Guid) Adds the character as prisoner to the stronghold. Add Prisoner Scripts\\Stronghold name: "Object", description: "Prisoner object to add to the stronghold prison", default: "", type: "ObjectGuid"
Void RemovePrisoner(Guid) Releases the character from the stronghold prison. Remove Prisoner Scripts\\Stronghold name: "Object", description: "Prisoner object to remove from the stronghold prison", default: "", type: "ObjectGuid"
Void OnPrisonerDeath(Guid) Calls Remove Prisoner On Prisoner Death Scripts\\Stronghold name: "Object", description: "Prisoner object who has been killed", default: "", type: "ObjectGuid"
Void ShowPrisoners() Lists all Prisoners in the console. Show Prisoners Scripts\\Stronghold
Void OnHirelingDeath(Guid) Dismisses the dead Hireling. On Hireling Death Scripts\\Stronghold name: "Object", description: "Hireling object who has been killed", default: "", type: "ObjectGuid"
Void OnVisitorDeath(Guid) Removes the Visitor and all bonuses/penalties from him. On Visitor Death Scripts\\Stronghold name: "Object", description: "Visitor object who has been killed", default = "", type: "ObjectGuid"
Void AdjustSecurity(Int32) Adjust the stronghold security by amount. Adjust Security Scripts\\Stronghold name: "Integer", description: "Amount to adjust stronghold Security", default: "0"
Void AdjustPrestige(Int32) Adjust the stronghold prestige by amount. Adjust Prestige Scripts\\Stronghold name: "Integer", description: "Amount to adjust stronghold Prestige", default: "0"
Void AddTurns(Int32) Add turns to the stronghold timeline Add Turns Scripts\\Stronghold name: "Integer", description: "Number of turns to add", default: "1"
Void OpenCharacterCreation() Open the character creation screen for player characters. Open Character Creation Screen Scripts\\UI
Void OpenCharacterCreationNewCompanion(Int32, Int32) Open the character creation screen for companions. Open Character Creation New Companion Screen Scripts\\UI name: "Player Cost", description: "How much it will cost if the player completes this companion.", default: "0", type: "" name: "Ending Level", description: "What level the character will be.", default: "1", type: ""
Void PlayInterstitial(Int32) Play the referenced interestial (static cutscene with scrolling text and voiceover?). Play Interstitial Scripts\\UI "Index", "The index of an interstitial to play (see InterstitialMaster list).", default: "0"
Void OpenCrafting(String) Open the crafting window if not in combat. Open Crafting Window Scripts\\UI "Crafting Object Type", "A String a unique crafting location to show (Recipe.CraftingLocation", default: ""
Void OpenEnchanting(String, String) Open the enchanting window, with the named item selected for enchanting. Open Enchanting Window Scripts\\UI name: "Crafting Object Type", description: "A String a unique crafting location to show (Recipe.CraftingLocation ", default: "", type: "" name: "Target Item Name", description: "The name of the item to enchant.", default: "", type: ""
Void ReturnToMainMenu() Quits game and return to main menu Return To Main Menu Scripts\\UI
Void TriggerTutorial(Int32) Trigger the referenced tutorial message if it wasn't already shown. Trigger Tutorial Scripts\\UI name: "Tutorial Index", description: "The index in the TutorialMaster list of the tutorial to play.", default: "0"
Void SetEndGameSlide(Int32) Set the image shown in the endgame slides. Set End Game Slide Scripts\\UI name: "Image Index", description: "The index in the EndGameSlidesImages array.", default: "0"
Void BeginWatcherMovie() Shows the watcher movie. Begin Watcher Movie Scripts\\UI
Void EndWatcherMovie() Hides the watcher movie. End Watcher Movie Scripts\\UI