Scripts

Void AbandonShipDuel(ShipDuelParticipant)

Scripts\Ship Duel\Retreat from Ship Duel

Name /typeDescription /example
Actor
String (ShipDuelParticipant)
The participant that ran away.
"Player"

Void ActivateNewPlayer(Guid)

Scripts\Party\Activate New Player

Name /typeDescription /example
New Player
Guid (Instance ID)
The new player to activate.
"00000000-0000-0000-0000-000000000000"

Void ActivateObject(Guid, Boolean)

Scripts\General\Activate Object

Name /typeDescription /example
Object
Guid (Instance ID)
Object to activate.
"00000000-0000-0000-0000-000000000000"
Active
Boolean
Active state to set the object to.
"True"

Void ActivateObjectWithVfx(Guid, String, Boolean)

Scripts\General\Activate Object With VFX

Name /typeDescription /example
Object
Guid (Instance ID)
Object to activate.
"00000000-0000-0000-0000-000000000000"
VFX Prefab Name
String
The game object name of the vfx prefab to use.
""
Active
Boolean
Active state to set the object to.
"True"

Void AddAbility(Guid, Guid)

Scripts\RPG\Add Ability, Talent, or Phrase

Name /typeDescription /example
Target character
Guid (Instance ID)
The character to add the unlockable to.
"b1a8e901-0000-0000-0000-000000000000"
Unlockable
Guid (ProgressionUnlockableGameData)
The ability, talent, or phrase to add.
"00000000-0000-0000-0000-000000000000"

Void AddAbilityWithPopup(Guid, Guid)

Scripts\RPG\Add Ability, Talent, or Phrase (Show Popup)

Name /typeDescription /example
Target character
Guid (Instance ID)
The character to add the unlockable to.
"b1a8e901-0000-0000-0000-000000000000"
Unlockable
Guid (ProgressionUnlockableGameData)
The ability, talent, or phrase to add.
"00000000-0000-0000-0000-000000000000"

Void AddCharacterWaitingForSceneTransition(Guid)

Scripts\AI\Behaviors\SceneTransition\Add Character Waiting For Scene Transition

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AddCrewToRoster(Guid)

Scripts\Ship Crew\Add Crew To Roster

Name /typeDescription /example
Crew Member
Guid (ShipCrewMemberData)
The crew member to add
"00000000-0000-0000-0000-000000000000"

Void AddExperience(Int32)

Scripts\Quest\Add Experience

Name /typeDescription /example
Experience
Int32
Amount of XP to reward
"50"

Void AddExperiencePlayer(Int32)

Scripts\Quest\Add Experience Player

Name /typeDescription /example
Experience
Int32
Amount of XP to reward
"50"

Void AddExperienceToLevel(Int32)

Scripts\Quest\Add Experience To Level

Name /typeDescription /example
Level
Int32
The level you want to level to
"12"

Void AddInjury(Guid, Guid, Boolean)

Scripts\Health\Add Injury

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Injury
Guid (AfflictionGameData)
The affliction that will be applied.
"00000000-0000-0000-0000-000000000000"
Can Kill
Boolean
If true then a 4th injury can kill the target.
"False"

Void AddInjuryToPartyWithAttributeCheck(Guid, Guid, Operator, Int32, Boolean)

Scripts\RPG\Add Injury To Party With Attribute Check

Name /typeDescription /example
Injury
Guid (AfflictionGameData)
The affliction that will be applied.
"00000000-0000-0000-0000-000000000000"
Attribute Type
Guid (AttributeGameData)
Attribute to test.
"00000000-0000-0000-0000-000000000000"
Attribute Operator
String (Operator)
Comparison operator.
"EqualTo"
Attribute Value
Int32
Compare the object's attribute against this value.
"0"
Can Kill
Boolean
If true then a 4th injury can kill the target.
"False"
Name /typeDescription /example
Injury
Guid (AfflictionGameData)
The affliction that will be applied.
"00000000-0000-0000-0000-000000000000"
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"
Can Kill
Boolean
If true then a 4th injury can kill the target.
"False"
Name /typeDescription /example
Injury
Guid (AfflictionGameData)
The affliction that will be applied.
"00000000-0000-0000-0000-000000000000"
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"
Scaler
String (DifficultyScaler)
Scaler to use, if the player has enabled it.
"NONE"
Can Kill
Boolean
If true then a 4th injury can kill the target.
"False"

Void AddPlayerShipUpgrade(Guid, Guid)

Scripts\Ships\Give And Equip Player Upgrade

Name /typeDescription /example
Ship
Guid (ShipGameData)
The ship to add the upgrade to.
"00000000-0000-0000-0000-000000000000"
Upgrade
Guid (ShipUpgradeGameData)
The upgrade to add.
"00000000-0000-0000-0000-000000000000"

Void AddTargetToKiteIgnoreList(Guid)

Scripts\AI\Behaviors\PreparingToAct\Add Target To Kite Ignore List

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AddToParty(Guid)

Scripts\Party\Add to Party

Name /typeDescription /example
Companion
Guid (Instance ID)
The companion to add.
"00000000-0000-0000-0000-000000000000"
Name /typeDescription /example
Character
Guid (Instance ID)
The character to apply to.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
The slot to apply to.
"PrimaryWeapon"
Amount
Single
The amount of wear to apply.
"1"

Void AdjustMorale(Int32)

Scripts\Ship Crew\Adjust Morale

Name /typeDescription /example
Value
Int32
The number to add or subtract from morale. Values less than 0 will reduce morale, values above 0 will increase morale.
"0"

Void AdjustSevereInjuryDuration(Guid, Guid, Int32)

Scripts\General\Adjust Severe Injury Duration

Name /typeDescription /example
Target
Guid (Instance ID)
The target character to adjust duration on
"00000000-0000-0000-0000-000000000000"
Injury
Guid (AfflictionGameData)
The injury to adjust the duration of
"00000000-0000-0000-0000-000000000000"
DurationAdjustment
Int32
The number of days to adjust the duration by. Values less than 0 will reduce remaining recovery time, greater than 0 will increase recovery time
"0"

Void AdjustSupplyCount(ShipSupplyType, Int32)

Scripts\Ships\Adjust Supply Count

Name /typeDescription /example
Supply Type
String (ShipSupplyType)
The type of supply to adjust.
"Ammunition"
Value
Int32
The number to adjust the supply by. Values less than 0 will reduce the supply, values above 0 will increase the supply.
"0"

Void AdjustSupplyCountPercentage(ShipSupplyType, Int32, Int32)

Scripts\Ships\Adjust Supply Count Percentage

Name /typeDescription /example
Supply Type
String (ShipSupplyType)
The type of supply to adjust.
"Ammunition"
Minimum Percent
Int32
The minimum percent to adjust the supply by (0-100).
"0"
Maximum Percent
Int32
The maximum percent to adjust the supply by (0-100).
"0"

Void AdvanceQuest(Guid)

Scripts\Quest\Advance Quest

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"

Void AdvanceTimeByHours(Int32)

Scripts\Time\Advance Time By Hours

Name /typeDescription /example
Hours
Int32
Hours to advance
"8"

Void AdvanceTimeByHoursNoRest(Int32)

Scripts\Time\Advance Time By Hours No Rest

Name /typeDescription /example
Hours
Int32
Hours to advance
"8"

Void AdvanceTimeToHour(Int32)

Scripts\Time\Advance Time To Hour

Name /typeDescription /example
Hour
Int32
Hour of the day to advance to
"0"

Void AIClearCurrentAction(Guid)

Scripts\AI\Behaviors\Clear Current Action

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AIClearForcedAction(Guid)

Scripts\AI\Behaviors\Clear Forced Action

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AIClearIsOnDestination(Guid)

Scripts\AI\Behaviors\Patrol\Clear Is On Destination

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AIForceAttack(Guid, Guid)

Scripts\AI\Force Attack

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
Object to attack
"00000000-0000-0000-0000-000000000000"

Void AIForfeitAction(Guid)

Scripts\AI\Behaviors\AI Forfeit Action if NPC

Name /typeDescription /example
Character
Guid (Instance ID)
Character whose action to pass.
"7d150000-0000-0000-0000-000000000000"

Void AIForfeitActionAny(Guid)

Scripts\AI\Behaviors\AI Forfeit Action

Name /typeDescription /example
Character
Guid (Instance ID)
Character whose action to pass.
"7d150000-0000-0000-0000-000000000000"

Void AIForfeitMovement(Guid)

Scripts\AI\Behaviors\AI Forfeit Movement if NPC

Name /typeDescription /example
Character
Guid (Instance ID)
Character whose movement to pass.
"7d150000-0000-0000-0000-000000000000"
Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
Object to investigate position
"00000000-0000-0000-0000-000000000000"
Movement Type
String (MovementType)
How to get there
"Walk"
Range
Single
Range to get withing target position
"0.5"

Void AIMoveToNextWaypoint(Guid)

Scripts\AI\Behaviors\Patrol\Move To Next Waypoint

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
Object to path to
"b1a8e901-0000-0000-0000-000000000000"
Movement Type
String (MovementType)
How to get there
"None"
Arrival Radius
Single
Distance for arrival check
"1"
Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Point
Guid (Instance ID)
Object to path to
"00000000-0000-0000-0000-000000000000"
Movement Type
String (MovementType)
How to get there
"None"

Void AIPickRandomDestination(Guid, Single, Single)

Scripts\AI\Behaviors\Pick Random Destination

Name /typeDescription /example
Character
Guid (Instance ID)
Character that is terrified.
"7d150000-0000-0000-0000-000000000000"
Minimum Distance
Single
Minimum distance the character will go.
"2"
Maximum Distance
Single
Maximum distance the character will go.
"5"

Void AIRecordRetreatPosition(Guid)

Scripts\AI\Behaviors\Record Retreat Position

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void AISetAnimationLooping(Guid, Boolean)

Scripts\AI\Behaviors\Set Animation Looping

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Is Animation Looping
Boolean
Whether the animation should be set to loopiong
"True"
Name /typeDescription /example
Character
Guid (Instance ID)
Character to update.
"7d150000-0000-0000-0000-000000000000"
Status Effect Anim Type
String (StatusEffectAnimType)
The status effect animation to play on the character.
"None"

Void AISetArrivalDistance(Guid, Single)

Scripts\AI\Behaviors\Set Arrival Distance

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Arrival Distance
Single
The new state of patrolling
"0"

Void AISetBusy(Guid, Boolean)

Scripts\AI\Set Busy State

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Is Busy
Boolean
The new state of busy
"False"

Void AISetCurrentActionFinished(Guid, Boolean)

Scripts\AI\Behaviors\Set Current Action Finished

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Is Finished
Boolean
Whether the action should be set to finished state
"True"

Void AISetCurrentActionToForcedAction(Guid)

Scripts\AI\Behaviors\Set Current Action To Forced Action

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Name /typeDescription /example
Character
Guid (Instance ID)
Character to update.
"7d150000-0000-0000-0000-000000000000"
Scripted Behavior
String (ScriptedBehaviorType)
The new scripted behavior type
"None"

Void AISetScriptedUseObject(Guid, Guid)

Scripts\AI\Set Scripted Use Object

Name /typeDescription /example
Chararacter
Guid (Instance ID)
Charactetr to update.
"7d150000-0000-0000-0000-000000000000"
Object
Guid (Instance ID)
Object to interact with.
"00000000-0000-0000-0000-000000000000"

Void AISetWaitingToSelectAnAction(Guid, Boolean)

Scripts\AI\Behaviors\PreparingToAct\Set Waiting To Select An Action

Name /typeDescription /example
Character
Guid (Instance ID)
Character to set.
"7d150000-0000-0000-0000-000000000000"
Waiting
Boolean
Whether character is waiting to select an action.
"False"

Void AIShipAction()

Scripts\Ship Duel\AI Action

Void AIShowInvestigateIndicator(Guid)

Scripts\AI\Behaviors\Show Investigate Indicator

Name /typeDescription /example
Character
Guid (Instance ID)
Character that is investigating.
"7d150000-0000-0000-0000-000000000000"

Void AIUnlockTurn(Guid)

Scripts\AI\Behaviors\Animation Unlock Turn

Name /typeDescription /example
Character
Guid (Instance ID)
Character whose attack should be unlocked.
"7d150000-0000-0000-0000-000000000000"

Void AllPartyMembersToBench()

Scripts\Party\All Party Members To Bench

Void AnyPartyMemberUseAbility(Guid)

Scripts\RPG\Any Party Member Use Ability

Name /typeDescription /example
Ability
Guid (GenericAbilityGameData)
The ability to check.
"00000000-0000-0000-0000-000000000000"

Void ApplyDamageToPlayerShip(Int32, ShipDuelDamageType)

Scripts\Ship Duel\Apply Damage To Player Ship

Name /typeDescription /example
Value
Int32
Damage to deal to player ship
"10"
Target
String (ShipDuelDamageType)
Whether to deal damage to the hull or the sails
"Hull"
Name /typeDescription /example
Ship
String (ShipDuelParticipant)
The ship to damage.
"Player"
Target
String (ShipDuelDamageType)
Whether to deal damage to the hull or the sails
"Hull"
Value
Int32
Damage to deal to the ship
"10"

Void ApplyLegacyHistoryToGame()

Scripts\LegacyHistory\Apply Legacy History

Void ApplyRandomSevereInjuryToRandomCrew(Int32, Boolean)

Scripts\Ship Crew\Apply Random Severe Injury to Random Crew

Name /typeDescription /example
Count
Int32
Number of crew members to apply random injuries to.
"1"
Ignore Player
Boolean
Set to true if you don't want the player to possibly be selected for injury.
"True"

Void ApplySevereInjury(Guid, Guid)

Scripts\General\Apply Severe Injury

Name /typeDescription /example
Target
Guid (Instance ID)
The target character to apply the injury to
"00000000-0000-0000-0000-000000000000"
Injury
Guid (AfflictionGameData)
The injury to apply to the target
"00000000-0000-0000-0000-000000000000"

Void ApplyShipEvent(ShipDuelParticipant, Guid)

Scripts\Ship Duel\Apply Ship Event

Name /typeDescription /example
Target
String (ShipDuelParticipant)
The ship to affect.
"Player"
Event Type
Guid (ShipDuelEventGameData)
The type of event to apply.
"00000000-0000-0000-0000-000000000000"

Void ApplyStatusEffect(Guid, Guid)

Scripts\General\Apply Status Effect

Name /typeDescription /example
Target
Guid (Instance ID)
Character to apply to.
"00000000-0000-0000-0000-000000000000"
StatusEffect
Guid (StatusEffectGameData)
The effect to apply.
"00000000-0000-0000-0000-000000000000"

Void ApplyStatusEffectToPartyWithSkillCheck(Guid, Guid, Operator, Int32)

Scripts\RPG\Apply Status Effect To Party With Skill Check

Name /typeDescription /example
Status Effect
Guid (StatusEffectGameData)
The effect that will be applied.
"00000000-0000-0000-0000-000000000000"
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"

Void ApplyStatusEffectToPartyWithSkillCheckScaled(Guid, Guid, Operator, Int32, DifficultyScaler)

Scripts\RPG\Apply Status Effect To Party With Skill Check (Scaled)

Name /typeDescription /example
Status Effect
Guid (StatusEffectGameData)
The effect that will be applied.
"00000000-0000-0000-0000-000000000000"
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"
Scaler
String (DifficultyScaler)
Scaler to use, if the player has enabled it.
"NONE"
Name /typeDescription /example
Area
Guid (MapGameData)
The area to transition to
"00000000-0000-0000-0000-000000000000"
Start Point Name
String (PointLocation)
The name of the start point
"ReferenceByName"
Reference Name
String
The name of the ReferenceByName start point if using ReferenceByName
""

Void ArenaVictory()

Scripts\Arena\Launch Arena Victory Scripts

Void Autosave()

Scripts\General\Autosave

Void BeginShipDuel(Guid)

Scripts\Ship Duel\Begin Ship Duel

Name /typeDescription /example
Opponent
Guid (ShipCaptainGameData)
The enemy captain to fight.
"00000000-0000-0000-0000-000000000000"

Void BeginWatcherMovie()

Scripts\UI\Begin Watcher Movie

Void BindItemInSlot(Guid, Guid, EquipmentSlot)

Scripts\Items\Bind Item In Slot

Name /typeDescription /example
Character
Guid (Instance ID)
Character to bind the item to.
"00000000-0000-0000-0000-000000000000"
Class
Guid (CharacterClassGameData)
Character class to bind the item to.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to bind
"None"

Void BlockForShipAI()

Scripts\Ship Duel\Block for AI

Void CalculateDestinationPoint(Guid)

Scripts\AI\Behaviors\Calculate Destination Point

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void CalculateFleeCombatDestination(Guid)

Scripts\AI\Behaviors\FleeCombat\Calculate Flee Combat Destination

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void CalculateInteractionPoint(Guid)

Scripts\AI\Behaviors\Calculate Interaction Point

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void CallGlobalScript(Guid)

Scripts\Global Scripts\Call Global Script

Name /typeDescription /example
Global Script
Guid (GlobalScript)
Name of the global script.
"00000000-0000-0000-0000-000000000000"

Void CallGlobalScriptAfterTimePasses(Guid, Int32, Int32, Int32, Int32, Boolean)

Scripts\Global Scripts\Call Global Script After Time Passes

Name /typeDescription /example
Global Script
Guid (GlobalScript)
Name of the global script.
"00000000-0000-0000-0000-000000000000"
Days
Int32
How many days need to pass
"0"
Hours
Int32
How many hours need to pass
"0"
Minutes
Int32
How many minutes need to pass
"0"
Seconds
Int32
How many seconds need to pass
"0"
Clear on Zone Transition
Boolean
Whether or not the timed script event should delete itself when changing a zone
"False"

Void CastImmediately(Guid)

Scripts\AI\Behaviors\Cast Immediately

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ChangeTeam(Guid, Guid)

Scripts\Faction\Change Team

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Team
Guid (TeamGameData)
The new team to change to
"00000000-0000-0000-0000-000000000000"

Void ChangeWaterLevel(Guid, Single, Single)

Scripts\Water\Change Water Level

Name /typeDescription /example
Object
Guid (Instance ID)
The water plane
"00000000-0000-0000-0000-000000000000"
Water Level
Single
New Water Level
"0"
Timer
Single
Time to move to new level
"1"

Void CharacterUseAbility(Guid, Guid)

Scripts\RPG\Character Use Ability

Name /typeDescription /example
Object
Guid (Instance ID)
Character to use.
"00000000-0000-0000-0000-000000000000"
Ability
Guid (GenericAbilityGameData)
The ability to check.
"00000000-0000-0000-0000-000000000000"

Void ChooseNewWaypoint(Guid)

Scripts\AI\Behaviors\TownieSchedule\Choose New Waypoint

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ClearActiveTownies()

Scripts\General\Clear All Active Townies

Void ClearConversationNodeAsRead(Guid, Int32)

Scripts\Conversation\Clear Conversation Node As Read

Name /typeDescription /example
Conversation
Guid (Conversation)
Name of the conversation.
"00000000-0000-0000-0000-000000000000"
Conversation Node ID
Int32
Conversation node ID.
"0"

Void ClearPerceptionState(Guid)

Scripts\AI\Clear Perception State

Name /typeDescription /example
Character
Guid (Instance ID)
Clear the perception state on this character.
"00000000-0000-0000-0000-000000000000"

Void ClearPreviousAttackTarget(Guid)

Scripts\AI\Behaviors\PreparingToAct\Clear Previous Attack Target

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ClearSpecifiedGuids()

Scripts\General\Clear Specified Guids

Void Close(Guid)

Scripts\OCL\Close

Name /typeDescription /example
Object
Guid (Instance ID)
Object to close.
"00000000-0000-0000-0000-000000000000"

Void CloseAllUIWindows()

Scripts\UI\Close All UI Windows

Name /typeDescription /example
Party Member Source
Guid (Instance ID)
The character to change
"00000000-0000-0000-0000-000000000000"
Party Member Target
Guid (Instance ID)
The character to change the relationship towards
"b1a8e901-0000-0000-0000-000000000000"
Axis
String (Axis)
Good vs. Bad action
"Positive"
Strength
Guid (ChangeStrengthGameData)
Severity of the change
"71c858fe-7c4b-432a-a105-c518319eaed7"
Only In Party
Boolean
Effect will only take place if the referenced character is in the active party
"True"

Void CompanionResolveRelationship(Guid, Guid, Boolean)

Scripts\Companion\Resolve Relationship

Name /typeDescription /example
Party Member Subject
Guid (Instance ID)
The character to change
"00000000-0000-0000-0000-000000000000"
Party Member Object
Guid (Instance ID)
The character to change the relationship towards
"b1a8e901-0000-0000-0000-000000000000"
Mutual
Boolean
Mutually apply to both companions
"False"

Void ConsumeShipDrink(Int32)

Scripts\Ships\Consume Ship Drink

Name /typeDescription /example
Amount
Int32
The number of items to consume.
"1"

Void ConsumeShipFood(Int32)

Scripts\Ships\Consume Ship Food

Name /typeDescription /example
Amount
Int32
The number of items to consume.
"1"

Void ContinueShipAction(ShipDuelParticipant)

Scripts\Ship Duel\Continue Ongoing Ship Action

Name /typeDescription /example
Participant
String (ShipDuelParticipant)
The participant to act.
"Player"

Void DeactivateTrap(Guid, Boolean)

Scripts\General\Deactivate Trap

Name /typeDescription /example
Trap
Guid (Instance ID)
The trap to deactivate.
"00000000-0000-0000-0000-000000000000"
Disarm
Boolean
Should the trap be disarmed.
"True"

Void DealDamage(Guid, Single)

Scripts\Health\Deal Damage

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Damage
Single
Deals this amount of damage to the object (armor/defense is applied to calculation)
"10"

Void DebugAdvanceQuest(Guid)

Scripts\Quest\Debug Advance Quest

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"

Void DecrementTrackedAchievementStat(TrackedAchievementStat)

Scripts\Achievement\Decrement Tracked Achievement Stat

Name /typeDescription /example
Tracked Stat
String (TrackedAchievementStat)
The tracked achievement stat we are incrementing.
"CompletedGame"
Name /typeDescription /example
String Table
String (StringTableType)
The string table containing the message.
"Gui"
String Id
Int32
The string ID of the message.
"0"
Item
Guid (ItemGameData)
The item to give.
"00000000-0000-0000-0000-000000000000"

Void DestroyItemInSlot(Guid, EquipmentSlot)

Scripts\Items\Destroy Item in Slot

Name /typeDescription /example
Character
Guid (Instance ID)
Remove the item from this character.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to remove
"None"

Void DestroySelf(Guid)

Scripts\AI\Behaviors\TownieSchedule\Destroy Self

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void DestroyWeaponInSlot(Guid, EquipmentSlot, Int32)

Scripts\Items\Destroy Weapon in Slot

Name /typeDescription /example
Character
Guid (Instance ID)
Remove the weapon from this character.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to remove
"None"
Weapon Set
Int32
The weapon set to destroy the item from.
"0"

Void DisableTownieSchedule(Guid)

Scripts\General\Disable Townie Schedule

Name /typeDescription /example
Object
Guid (Instance ID)
Object to disable.
"00000000-0000-0000-0000-000000000000"

Void DisplayHUDTitleText(String, String, Single)

Scripts\UI\Display HUD Title Text

Name /typeDescription /example
Title Text
String
What large title text to display.
"Title Text"
Subtitle Text
String
What subtitle text to display.
"Subtitle Text"
Duration
Single
How long to display the text.
"5"
Name /typeDescription /example
Title Text String Table
String (StringTableType)
The string table containing the title.
"Gui"
Title Text String Id
Int32
The string ID of the title.
"0"
Subtitle Text String Table
String (StringTableType)
The string table containing the subtitle.
"Gui"
Subtitle Text String Id
Int32
The string ID of the subtitle.
"0"
Duration
Single
How long to display the text.
"5"
IntroDelay
Single
How long to delay the text display.
"0.5"

Void DisplayLegacyHistoryWindow()

Scripts\LegacyHistory\Display Legacy History Window

Void DispositionAddPoints(Guid, Guid)

Scripts\Disposition\Add Disposition

Name /typeDescription /example
Disposition
Guid (DispositionGameData)
The disposition type
"00000000-0000-0000-0000-000000000000"
Strength
Guid (ChangeStrengthGameData)
Severity of the change
"71c858fe-7c4b-432a-a105-c518319eaed7"

Void DozensGameRollOpponent()

Scripts\Minigame\Dozens Game Roll Opponent

Void DozensGameRollPlayer()

Scripts\Minigame\Dozens Game Roll Player

Void DrawSelectionCircle(Guid, Boolean)

Scripts\General\Draw Selection Circle

Name /typeDescription /example
Target
Guid (Instance ID)
The object to set drawing onto.
"00000000-0000-0000-0000-000000000000"
Show
Boolean
Sets whether the selection circle should be drawn or not.
"False"

Void EmergeLurk(Guid, Int32)

Scripts\AI\Behaviors\Emerge\Emerge Lurk

Name /typeDescription /example
Character
Guid (Instance ID)
Character to lurk.
"7d150000-0000-0000-0000-000000000000"
Emerge Index
Int32
Index of the animation to use.
"1"

Void EmergeStart(Guid)

Scripts\AI\Behaviors\Emerge\Emerge Start

Name /typeDescription /example
Character
Guid (Instance ID)
Character who should emerge. Must have an EmergeController.
"7d150000-0000-0000-0000-000000000000"

Void EncounterDespawn(Guid)

Scripts\Encounter\Encounter Despawn

Name /typeDescription /example
Object
Guid (Instance ID)
The Encounter
"00000000-0000-0000-0000-000000000000"

Void EncounterReset(Guid)

Scripts\Encounter\Encounter Reset

Name /typeDescription /example
Encounter
Guid (Instance ID)
Encounter to reset.
"00000000-0000-0000-0000-000000000000"

Void EncounterSetCombatEndWhenAllAreDeadFlag(Guid, Boolean)

Scripts\Encounter\Encounter Set Combat End When All Are Dead Flag

Name /typeDescription /example
Object
Guid (Instance ID)
The Encounter
"00000000-0000-0000-0000-000000000000"
CombatEndWhenAllAreDeadFlag
Boolean
Set this value
"True"

Void EncounterSetPlayerRelationship(Guid, Relationship)

Scripts\Encounter\Encounter Set Player Relationship

Name /typeDescription /example
Encounter
Guid (Instance ID)
Encounter to set relationship to player for.
"00000000-0000-0000-0000-000000000000"
Relationship
String (Relationship)
Relationship value.
"Hostile"

Void EncounterSpawn(Guid)

Scripts\Encounter\Encounter Spawn

Name /typeDescription /example
Object
Guid (Instance ID)
The Encounter
"00000000-0000-0000-0000-000000000000"

Void EncounterStartWave(Guid)

Scripts\Encounter\Encounter Start Next Wave

Name /typeDescription /example
Encounter
Guid (Instance ID)
Encounter Wave Manager to start next wave.
"00000000-0000-0000-0000-000000000000"

Void EncounterStopCombat(Guid)

Scripts\Encounter\Encounter Stop Combat

Name /typeDescription /example
Encounter
Guid (Instance ID)
Encounter to stop combat for.
"00000000-0000-0000-0000-000000000000"

Void EndGame()

Scripts\General\End Game

Void EndShipDuel()

Scripts\Ship Duel\End Ship Duel

Void EndWatcherMovie()

Scripts\UI\End Watcher Movie

Void EndWeatherPattern(Boolean)

Scripts\Weather\End Weather Pattern

Name /typeDescription /example
Is Transition Insant
Boolean
Whether the transition back to the default weather forecast should be instant or gradual.
"False"

Void EnterAttackCriticalRegion(Guid)

Scripts\AI\Enter Attack Critical Region

Name /typeDescription /example
Object
Guid (Instance ID)
The attacker.
"7d150000-0000-0000-0000-000000000000"

Void ExitAmbientAnimation(Guid)

Scripts\AI\Exit Ambient Animation

Name /typeDescription /example
Object
Guid (Instance ID)
Object to exit ambient animation.
"7d150000-0000-0000-0000-000000000000"

Void ExitAttackCriticalRegion(Guid)

Scripts\AI\Exit Attack Critical Region

Name /typeDescription /example
Object
Guid (Instance ID)
The attacker.
"7d150000-0000-0000-0000-000000000000"

Void FaceTarget(Guid)

Scripts\AI\Behaviors\Face Target

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Name /typeDescription /example
Fade Time
Single
Fade time
"2"
Fade Music
Boolean
Fade music
"False"
Fade Ambient Audio
Boolean
Fade all ambient audio
"False"

Void FadeInChildGameObjects(Guid, Single)

Scripts\Fade\Fade In Child GameObjects

Name /typeDescription /example
Object
Guid (Instance ID)
Object which contains children w/ AlphaControl
"00000000-0000-0000-0000-000000000000"
Fade Time
Single
Fade time
"2"

Void FadeInGameObject(Guid, Single)

Scripts\Fade\Fade In GameObject

Name /typeDescription /example
Object
Guid (Instance ID)
Object w/ AlphaControl
"00000000-0000-0000-0000-000000000000"
Fade Time
Single
Fade time
"2"

Void FadeInSceneVisuals(Single)

Scripts\Fade\(Prologue Intro) Fade In Scene Visuals

Name /typeDescription /example
Fade Time
Single
Fade time
"2"
Name /typeDescription /example
Object
Guid (Instance ID)
Object which contains children w/ AlphaControl
"00000000-0000-0000-0000-000000000000"
Fade Time
Single
Fade time
"2"
FadeOutBehavior
String (FadeOutBehavior)
Disable, destroy, or do nothing at the end of the fade
"Destroy"
Name /typeDescription /example
Object
Guid (Instance ID)
Object w/ AlphaControl
"00000000-0000-0000-0000-000000000000"
Fade Time
Single
Fade time
"2"
FadeOutBehavior
String (FadeOutBehavior)
Disable, destroy, or do nothing at the end of the fade
"Destroy"

Void FadeOutSceneVisuals(Single)

Scripts\Fade\(Prologue Intro) Fade Out Scene Visuals

Name /typeDescription /example
Fade Time
Single
Fade time
"0"
Name /typeDescription /example
Fade Time
Single
Fade time
"2"
Fade Music
Boolean
Fade music
"False"
Fade Ambient Audio
Boolean
Fade all ambient audio
"False"

Void FastFowardAnimators(Guid)

Scripts\General\Fast Foward Animators

Name /typeDescription /example
Target
Guid (Instance ID)
The object to fast forward animators on.
"00000000-0000-0000-0000-000000000000"
Name /typeDescription /example
Character
Guid (Instance ID)
Character to force to flee.
"7d150000-0000-0000-0000-000000000000"
Can Queue
Boolean
Whether the character can queue the flee if it is executing a higher priority behavior.
"True"
Teleport Ability (Optional)
Guid (GenericAbilityGameData)
Teleport ability to use for fleeing.
"00000000-0000-0000-0000-000000000000"
Minimum Distance
Single
Minimum distance the character will flee.
"3"
Maximum Distance
Single
Maximum distance the character will flee.
"6"

Void FlipTile(Guid, Int32)

Scripts\Tile\Flip Tile

Name /typeDescription /example
Object
Guid (Instance ID)
The Flip Tile object to flip.
"00000000-0000-0000-0000-000000000000"
Frame
Int32
The interaction image index to flip to.
"0"

Void FocusCameraOnPosition(Guid, Single)

Scripts\Camera\Focus Camera On Position

Name /typeDescription /example
Target Object
Guid (Instance ID)
The object to focus on.
"00000000-0000-0000-0000-000000000000"
Time
Single
The time in seconds over which to move.
"0.5"

Void ForceCombatPathing(Guid, Boolean)

Scripts\AI\Force Combat Pathing

Name /typeDescription /example
NPC
Guid (Instance ID)
Set combat pathing for this character.
"00000000-0000-0000-0000-000000000000"
Use Combat Pathing
Boolean
Whether the character should be forced to use combat pathing.
"True"

Void ForceInCombatIdle(Guid, Boolean)

Scripts\AI\Force In Combat Idle

Name /typeDescription /example
NPC
Guid (Instance ID)
Set the combat idle stance for this character.
"00000000-0000-0000-0000-000000000000"
In Combat Idle
Boolean
Whether the character should be a combat idle stance.
"True"

Void ForceRandomEncounterToAttack()

Scripts\Encounter\Force Random Encounter to Attack

Void ForgetTarget(Guid)

Scripts\AI\Behaviors\Forget Target

Name /typeDescription /example
Character
Guid (Instance ID)
Character whose target to clear.
"7d150000-0000-0000-0000-000000000000"

Void FullyHeal(Guid)

Scripts\Health\Fully Heal

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void GameCompleteSave()

Scripts\General\Game Complete Save

Void GameOver()

Scripts\General\Game Over

Void GenerateLootListInto(Guid, Guid)

Scripts\Items\Generate Loot List Into

Name /typeDescription /example
Inventory
Guid (Instance ID)
The object to give the items to.
"00000000-0000-0000-0000-000000000000"
Loot List
Guid (LootListGameData)
The list to generate.
"00000000-0000-0000-0000-000000000000"

Void GiveAdvantage(ShipDuelParticipant)

Scripts\Ship Duel\Give Advantage

Name /typeDescription /example
Target
String (ShipDuelParticipant)
The particpant to give advantage to
"Player"

Void GiveAndEquipPlayerCrewman(Guid, ShipCrewJobType, Guid)

Scripts\Ships\Give And Equip Player Crewman

Name /typeDescription /example
Ship
Guid (ShipGameData)
The ship to add the crewman to.
"00000000-0000-0000-0000-000000000000"
Job
String (ShipCrewJobType)
The job to add the crewman to.
"Deckhand"
Crew
Guid (ShipCrewMemberData)
The crewman to add.
"00000000-0000-0000-0000-000000000000"

Void GiveEncounterExperience()

Scripts\Ship Crew\Give Encounter Experience

Void GiveFlag(Guid)

Scripts\Ships\Give Ship Flag

Name /typeDescription /example
Flag
Guid (ShipUpgradeGameData)
Flag to give to the player.
"00000000-0000-0000-0000-000000000000"

Void GiveItemAndEquip(Guid, Guid, Boolean)

Scripts\Items\Give Item And Equip

Name /typeDescription /example
Character
Guid (Instance ID)
Character to give the item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (EquippableGameData)
The item to give
"00000000-0000-0000-0000-000000000000"
Primary
Boolean
If set, equip the item in the primary slot.
"True"

Void GiveItems(Guid, Int32)

Scripts\Items\Give Items (to Party)

Name /typeDescription /example
Item
Guid (ItemGameData)
The item to give.
"00000000-0000-0000-0000-000000000000"
Count
Int32
The number of items to add.
"1"

Void GiveItemsToObject(Guid, Guid, Int32)

Scripts\Items\Give Items to Object

Name /typeDescription /example
Object
Guid (Instance ID)
Object to give the item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (ItemGameData)
The item to give
"00000000-0000-0000-0000-000000000000"
Count
Int32
The number of items to add
"1"

Void GiveItemsToQuickBar(Guid, Guid, Int32)

Scripts\Items\Give Items To Quick Bar

Name /typeDescription /example
Character
Guid (Instance ID)
Character to give the item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (ItemGameData)
The item to give
"00000000-0000-0000-0000-000000000000"
Quantity
Int32
The quantity to give.
"True"

Void GiveItemsToShipConsumeQueue(Guid, Int32)

Scripts\Items\Give Items To Ship Consume Queue

Name /typeDescription /example
Item
Guid (ItemGameData)
The item to give
"00000000-0000-0000-0000-000000000000"
Quantity
Int32
The quantity to give.
"5"

Void GivePartyXP(Int32, Boolean)

Scripts\Party\Give Party Bonus XP

Name /typeDescription /example
Amount
Int32
Amount of experience to grant.
"0"
Should Report
Boolean
True to report the bonus XP, false to hide it.
"False"

Void GivePlayerMoney(Int32)

Scripts\Items\Give Player Money

Name /typeDescription /example
Amount
Int32
The amount of money to add to the player
"1"

Void GivePlayerShip(Guid)

Scripts\Ships\Give Player Ship

Name /typeDescription /example
Ship
Guid (ShipGameData)
Ship to give to the player.
"00000000-0000-0000-0000-000000000000"

Void GiveSailorTales(Int32)

Scripts\Ship Crew\Give Sailor Tales

Name /typeDescription /example
Number
Int32
Number of sailor tales to award to active crew.
"0"

Void GiveSailorTalesToCrewMember(Guid, Int32)

Scripts\Ship Crew\Give Sailor Tales to Crew Member

Name /typeDescription /example
Crew Member
Guid (Instance ID)
Crew Member to give experience to.
"00000000-0000-0000-0000-000000000000"
Number
Int32
Number of sailor tales to award to crew member.
"0"

Void GiveTriumph(Guid)

Scripts\Ships\Give Triumph

Name /typeDescription /example
Triumph
Guid (ShipTriumphGameData)
Triumph to give to the player.
"00000000-0000-0000-0000-000000000000"

Void GiveTrophy(Guid)

Scripts\Ships\Give Trophy

Name /typeDescription /example
Trophy
Guid (ShipTrophyGameData)
Trophy to give to the player.
"00000000-0000-0000-0000-000000000000"
Name /typeDescription /example
Character
Guid (Instance ID)
Character to give the item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (EquippableGameData)
The item to give
"00000000-0000-0000-0000-000000000000"
Primary
Boolean
If set, equip the item in the primary slot.
"True"
Weapon Set
Int32
The weapon set to equip the weapon to.
"0"
Name /typeDescription /example
Title Text String Table
String (StringTableType)
The string table containing the title.
"Gui"
Title Text String Id
Int32
The string ID of the title.
"0"
Duration
Single
How long to display the text.
"5"
XP
Int32
Amount of XP to give.
"0"
IntroDelay
Single
How long to delay the text display.
"0.5"

Void GrappleExit(Guid)

Scripts\AI\Behaviors\Grapple\Grapple Exit

Name /typeDescription /example
Character
Guid (Instance ID)
Character who is grappling.
"7d150000-0000-0000-0000-000000000000"

Void HealParty()

Scripts\Health\Heal Party

Void HideScriptedInteractionPortaits()

Scripts\Interaction\Hide Scripted Interaction Portraits

Void HitReact(Guid)

Scripts\Health\Hit React

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void IncreaseWorldMapMapSize(Guid, Int32)

Scripts\World Map\Increase World Map Map Size

Name /typeDescription /example
World Map
Guid (WorldMapGameData)
The world map to update.
"00000000-0000-0000-0000-000000000000"
Index
Int32
Increases the map size stage to this index.
"1"

Void IncrementAttemptCount(Guid)

Scripts\AI\Behaviors\Increment Attempt Count

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void IncrementGlobalValue(String, Int32)

Scripts\GlobalVars\Increment Global

Name /typeDescription /example
Name
String (Global Variable)
Global Name
"GlobalName"
Value
Int32
Increase Global by Value
"1"

Void IncrementTrackedAchievementStat(TrackedAchievementStat)

Scripts\Achievement\Increment Tracked Achievement Stat

Name /typeDescription /example
Tracked Stat
String (TrackedAchievementStat)
The tracked achievement stat we are incrementing.
"CompletedGame"

Void InteractionSelectPartyMember(Int32)

Scripts\Interaction\Interaction Select Party Member

Name /typeDescription /example
Specify Index
Int32
The index of the oei_specified GUID to store the selected character in.
"0"

Void Interrupt(Guid)

Scripts\Health\Interrupt

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void Kill(Guid)

Scripts\Health\Kill

Name /typeDescription /example
Object
Guid (Instance ID)
Object to kill.
"00000000-0000-0000-0000-000000000000"

Void KillBarkstringOnSpeaker(Guid, Boolean, Boolean)

Scripts\Conversation\Kill Barkstring on Speaker

Name /typeDescription /example
Object
Guid (Instance ID)
Speaker Object
"00000000-0000-0000-0000-000000000000"
Instant
Boolean
Kills the bark instantly
"True"
Run Scripts
Boolean
Run scripts on the bark
"True"

Void KillDestructible(Guid)

Scripts\Health\Kill Destructible

Name /typeDescription /example
Object
Guid (Instance ID)
Destrctuble to kill.
"00000000-0000-0000-0000-000000000000"

Void KnockDown(Guid)

Scripts\Health\Knock Down

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void LaunchAttackAtObject(Guid, Guid)

Scripts\Attacks\Launch Attack At Object

Name /typeDescription /example
Target Object
Guid (Instance ID)
The object to attack.
"00000000-0000-0000-0000-000000000000"
Attack
Guid (AttackBaseGameData)
The attack to launch.
"00000000-0000-0000-0000-000000000000"

Void LaunchAttackAtObjectWithCaster(Guid, Guid, Guid)

Scripts\Attacks\Launch Attack At Object With Caster

Name /typeDescription /example
Caster
Guid (Instance ID)
The object to cast the attack.
"00000000-0000-0000-0000-000000000000"
Target Object
Guid (Instance ID)
The object to attack.
"00000000-0000-0000-0000-000000000000"
Attack
Guid (AttackBaseGameData)
The attack to launch.
"00000000-0000-0000-0000-000000000000"

Void LaunchAttackAtPosition(Guid, Guid)

Scripts\Attacks\Launch Attack At Position

Name /typeDescription /example
Target Position
Guid (Instance ID)
The position to attack.
"00000000-0000-0000-0000-000000000000"
Attack
Guid (AttackBaseGameData)
The attack to launch.
"00000000-0000-0000-0000-000000000000"

Void LaunchAttackAtPositionWithCaster(Guid, Guid, Guid)

Scripts\Attacks\Launch Attack At Position With Caster

Name /typeDescription /example
Caster
Guid (Instance ID)
The object to cast the attack.
"00000000-0000-0000-0000-000000000000"
Target Position
Guid (Instance ID)
The position to attack.
"00000000-0000-0000-0000-000000000000"
Attack
Guid (AttackBaseGameData)
The attack to launch.
"00000000-0000-0000-0000-000000000000"

Void LaunchRandomEncounter(Guid)

Scripts\Encounter\Launch Random Encounter

Name /typeDescription /example
Encounter
Guid (WorldMapEncounterGameData)
The world map random encounter to launch
"00000000-0000-0000-0000-000000000000"

Void LoadAudioBank(String)

Scripts\Audio\Load Audio Bank

Name /typeDescription /example
Audio Bank
String
Does NOT actually load audio bank.Use Audio Sound Back component to load.
""
Name /typeDescription /example
Object
Guid (Instance ID)
Object with an AudioEmitter. If empty, will use global object.
"00000000-0000-0000-0000-000000000000"
Audio Bank
String
Does NOT actually load audio bank. Use Audio Sound Back component to load.
""
Audio Event
String
The audio event to play.
""
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"
Name /typeDescription /example
Object
Guid (Instance ID)
Object with an AudioEmitter. If empty, will use global object.
"00000000-0000-0000-0000-000000000000"
Audio Bank
String
Does NOT actually load audio bank.Use Audio Sound Back component to load.
""
Audio Event 1
String
Audio event to play.
""
Audio Event 2
String
Audio event to play.
""
Audio Event 3
String
Audio event to play.
""
Audio Event 4
String
Audio event to play.
""
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"
Name /typeDescription /example
ID
String
Unique identifier.
""
Audio Bank
String
The audio bank to load.
""
Audio Event
String
The audio event to play.
""
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"
Name /typeDescription /example
ID
String
Unique identifier.
""
Audio Bank
String
The audio bank to load.
""
Audio Event 1
String
Audio event to play.
""
Audio Event 2
String
Audio event to play.
""
Audio Event 3
String
Audio event to play.
""
Audio Event 4
String
Audio event to play.
""
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"

Void LoadEncounterMap(EncounterScenarioType)

Scripts\Encounter\Load Encounter Map

Name /typeDescription /example
Scenario Type
String (EncounterScenarioType)
The type of scenario we should load
"Standard"

Void Lock(Guid)

Scripts\OCL\Lock

Name /typeDescription /example
Object
Guid (Instance ID)
Name of the object
"00000000-0000-0000-0000-000000000000"

Void LockAllEquipmentSlots(Guid)

Scripts\Items\Lock All Equipment Slots

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void LockCameraAtZoom(Single)

Scripts\Camera\Lock Camera At Zoom

Name /typeDescription /example
Zoom Value
Single
The zoom value to lock the camera at.
"1"

Void LockEquipmentSlot(Guid, EquipmentSlot)

Scripts\Items\Lock Equipment Slot

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to lock
"None"

Void LockGameObjectFade(Guid, Boolean)

Scripts\Fade\Lock GameObject Fade

Name /typeDescription /example
Object
Guid (Instance ID)
Object w/ AlphaControl
"00000000-0000-0000-0000-000000000000"
Lock
Boolean
Whether or not to prevent any other systems from fading the GameObject in/out
"False"

Void LogRecipeGet(Guid)

Scripts\Items\Log Given Recipe

Name /typeDescription /example
Recipe Name
Guid (RecipeData)
The recipe learned
"00000000-0000-0000-0000-000000000000"

Void MarkConversationNodeAsRead(Guid, Int32)

Scripts\Conversation\Mark Conversation Node As Read

Name /typeDescription /example
Conversation
Guid (Conversation)
Name of the conversation.
"00000000-0000-0000-0000-000000000000"
Conversation Node ID
Int32
Conversation node ID.
"0"

Void Open(Guid, Boolean)

Scripts\OCL\Open

Name /typeDescription /example
Object
Guid (Instance ID)
Object to open.
"00000000-0000-0000-0000-000000000000"
Ignore Lock
Boolean
Should we ignore the lock to open
"False"

Void OpenArenaResult()

Scripts\UI\Open the Arena Result Window

Void OpenArenaSelection()

Scripts\UI\Open the Arena Selection Window

Void OpenCharacterCreation()

Scripts\UI\Open Character Creation Screen

Void OpenCharacterCreationNewCompanion(Int32, Int32)

Scripts\UI\Open Character Creation New Companion Screen

Name /typeDescription /example
Player Cost
Int32
How much it will cost if the player completes this companion.
"0"
Ending Level
Int32
What level the character will be.
"1"

Void OpenCrafting(CraftingLocation)

Scripts\UI\Open Crafting Window

Name /typeDescription /example
Crafting Object Type
String (CraftingLocation)
The crafting location the player is triggering this from
"None"

Void OpenCrewRecruitment(Guid)

Scripts\Stores\Open Crew Recruitment

Name /typeDescription /example
Vendor
Guid (Instance ID)
Vendor object to open.
"00000000-0000-0000-0000-000000000000"

Void OpenEnchanting(CraftingLocation, Guid)

Scripts\UI\Open Enchanting Window

Name /typeDescription /example
Crafting Object Type
String (CraftingLocation)
The crafting location the player is triggering this from
"None"
Target Item Name
Guid (EquippableGameData)
The item to enchant.
"00000000-0000-0000-0000-000000000000"

Void OpenInn(Guid)

Scripts\Stores\Open Inn

Name /typeDescription /example
Vendor
Guid (Instance ID)
Vendor object to open.
"00000000-0000-0000-0000-000000000000"

Void OpenInventory()

Scripts\UI\Open Inventory Window

Void OpenInventoryOfMember(Guid)

Scripts\UI\Open Inventory Window Of Member

Name /typeDescription /example
Party Member
Guid (Instance ID)
The character to open the inventory
"00000000-0000-0000-0000-000000000000"

Void OpenPetMelding(Guid)

Scripts\Stores\Open Pet Melding

Name /typeDescription /example
Vendor
Guid (Instance ID)
Vendor object to open.
"00000000-0000-0000-0000-000000000000"

Void OpenRecruitment(Guid)

Scripts\Stores\Open Adventurer Recruitment

Name /typeDescription /example
Vendor
Guid (Instance ID)
Vendor object to open.
"00000000-0000-0000-0000-000000000000"

Void OpenStore(Guid)

Scripts\Stores\Open Store

Name /typeDescription /example
Vendor
Guid (Instance ID)
Vendor object to open.
"00000000-0000-0000-0000-000000000000"

Void OrlanGameReset()

Scripts\Minigame\Orlan Game Round Over

Void OrlanGameRollOpponent(Guid, Approach)

Scripts\Minigame\Orlan Game Roll Opponent

Name /typeDescription /example
Object
Guid (Instance ID)
Character to make the throw.
"00000000-0000-0000-0000-000000000000"
Approach
String (Approach)
Controls which set of probabilities is used.
"NOSE"

Void OrlanGameRollPlayer(Guid, Approach)

Scripts\Minigame\Orlan Game Roll Player

Name /typeDescription /example
Object
Guid (Instance ID)
Character to make the throw.
"00000000-0000-0000-0000-000000000000"
Approach
String (Approach)
Controls which set of probabilities is used.
"NOSE"

Void OrlanGameRoundOver()

Scripts\Minigame\Orlan Game Reset

Void OverrideFatigueWhispers(Single)

Scripts\Audio\Override Fatigue Whispers

Name /typeDescription /example
New Volume
Single
The new volume to force the fatigue whispers to.
"0"

Void PartyMemberToActiveParty(Guid)

Scripts\Party\Party Member To Active Party

Name /typeDescription /example
Companion
Guid (Instance ID)
Inactive companion to move into the active party.
"00000000-0000-0000-0000-000000000000"

Void PartyMemberToBench(Guid)

Scripts\Party\Party Member To Bench

Name /typeDescription /example
Companion
Guid (Instance ID)
Active companion to send to the ship.
"00000000-0000-0000-0000-000000000000"

Void PassTurn(Guid)

Scripts\AI\Pass Turn

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void PlayConversationAnimation(Guid, Int32)

Scripts\Conversation\Play Animation

Name /typeDescription /example
Object
Guid (Instance ID)
Object ro play animation on
"00000000-0000-0000-0000-000000000000"
Variation
Int32
Animation variation type
"0"

Void PlayDynamicAmbientMusicEvent(AmbientMusicStateType, String)

Scripts\Audio\Play Dynamic Ambient Music Event

Name /typeDescription /example
Category
String (AmbientMusicStateType)
Category of the dynamic music state.
"Default"
State ID
String
ID of the dynamic music state.
""

Void PlayDynamicAmbientMusicEvent(String, String, String)

Scripts\Audio\Play Dynamic Ambient Music Event (Multiple)

Name /typeDescription /example
Default State ID
String
ID of the default dynamic music state.
""
Stealth State ID
String
ID of the stealth dynamic music state.
""
Conversation State ID
String
ID of the conversation dynamic music state.
""

Void PlayDynamicCombatMusicEvent(String)

Scripts\Audio\Play Dynamic Combat Music Event

Name /typeDescription /example
State ID
String
ID of the dynamic music state.
""

Void PlayerSafeMode(Boolean)

Scripts\AI\Player Safe Mode

Name /typeDescription /example
Enabled
Boolean
True to disable party character AIs and Input, false to restore
"True"

Void PlayerShipAction(ShipDuelActionType)

Scripts\Ship Duel\Player Action

Name /typeDescription /example
Action
String (ShipDuelActionType)
The action to take.
"None"

Void PlayerShipActionFireCannons()

Scripts\Ship Duel\Player Action Fire Cannons

Void PlayerShipActionReport()

Scripts\Ship Duel\Player Action Report

Void PlayInterstitial(Int32)

Scripts\UI\Play Interstitial

Name /typeDescription /example
Index
Int32
The index of an interstitial to play (see InterstitialMaster list).
"0"

Void PlayMovie(MovieType, Single)

Scripts\Play Cutscene Video

Name /typeDescription /example
Movie Type
String (MovieType)
Movie Type To Play
"None"
Alpha Fade Time
Single
How long to unfade the alpha at the end of the movie. A value of zero does no alpha fade and relies on the Black fade in game for transition
"0"
Name /typeDescription /example
Audio Event
String
The audio event to play.
""
Participant
String (ShipDuelParticipant)
The ship to play the audio for.
"Player"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"

Void PlaySoundAction(Guid, ChatterEventType)

Scripts\Conversation\Play Sound Action

Name /typeDescription /example
Object
Guid (Instance ID)
Speaker Object
"00000000-0000-0000-0000-000000000000"
Chatter Action
String (ChatterEventType)
Chatter Action type
"AbilityCast"

Void PointOfNoReturnSave()

Scripts\General\Point Of No Return Save

Void PopCustomAnimController(Guid)

Scripts\AI\Pop Custom Anim Controller

Name /typeDescription /example
Character
Guid (Instance ID)
Character to use.
"7d150000-0000-0000-0000-000000000000"

Void PopScriptedMusic(Single)

Scripts\Audio\Pop Scripted Music

Name /typeDescription /example
Delay
Single
Delay in seconds.
"0"

Void PreDlcSave(StringTableType, Int32)

Scripts\General\Pre DLC Save

Name /typeDescription /example
String Table
String (StringTableType)
The string table containing the message.
"Gui"
String Id
Int32
The string ID of the message.
"0"

Void PreloadScene(MapType)

Scripts\Area\Preload Scene

Name /typeDescription /example
Area Name
String (MapType)
The name of the area to begin background loading
"None"

Void PrintString(String)

Scripts\Test\(DEBUG) Print String

Name /typeDescription /example
Text
String
A string to print to the console.
""

Void PushScriptedMusic(String, Single)

Scripts\Audio\Push Scripted Music

Name /typeDescription /example
Music Track
String
State string from the Audio Project.
""
Delay
Single
Delay in seconds.
"0"

Void QueryPlayerForFeatureName(Guid)

Scripts\World Map\Query Player for Feature Name

Name /typeDescription /example
Feature
Guid (PlayerNamedFeatureGameData)
The feature for the player to name.
"00000000-0000-0000-0000-000000000000"

Void RandomizeGlobalValue(String, Int32, Int32)

Scripts\GlobalVars\Randomize Global

Name /typeDescription /example
Name
String (Global Variable)
Global Name
"GlobalName"
MinValue
Int32
The minimum value (inclusive)
"1"
MaxValue
Int32
The maximum value (inclusive)
"2"

Void RandomizeGlobalValueWithGlobal(String, String, String)

Scripts\GlobalVars\Randomize Global With Global

Name /typeDescription /example
Name
String (Global Variable)
Global Name
"GlobalName"
MinValueGlobal
String (Global Variable)
Minimum Value for Global
""
MaxValueGlobal
String (Global Variable)
Maximum Value for Global
""

Void RandomizeShipDuelDistance(Int32, Int32)

Scripts\Ship Duel\Randomize Distance

Name /typeDescription /example
Min
Int32
The minimum distance.
"400"
Max
Int32
The maximum distance.
"600"

Void RandomizeShipDuelRelativeBearing(ShipDuelParticipant)

Scripts\Ship Duel\Randomize Relative Bearing

Name /typeDescription /example
From
String (ShipDuelParticipant)
Will randomize the bearing from this ship to the other ship.
"Player"

Void RecruitCrewMember(Guid, Guid)

Scripts\Ships\Recruit Crew Member

Name /typeDescription /example
Crewmember
Guid (ShipCrewMemberData)
The crewman to add.
"00000000-0000-0000-0000-000000000000"
Game Object
Guid (Instance ID)
The scene object representing the crewmember.
"00000000-0000-0000-0000-000000000000"

Void ReduceAmmoByCannonCount()

Scripts\Ships\Reduce Ammo By Cannon Count

Void ReduceAmmoByCannonCount(ShipCombatRelativeBearing)

Scripts\Ships\Reduce Ammo By Cannon Count on Side

Name /typeDescription /example
Side
String (ShipCombatRelativeBearing)
The side to check for cannons on.
"Port"

Void ReduceSupplyCountPerCrewMember(ShipSupplyType, Int32)

Scripts\Ships\Reduce Supply Count per Crew Member

Name /typeDescription /example
Supply Type
String (ShipSupplyType)
The type of supply to adjust.
"Ammunition"
Value
Int32
Number to reduce the supply by - per crew.
"0"

Void ReleaseFatigueWhisperOverride()

Scripts\Audio\Release Fatigue Whisper Override

Void RemoveAbility(Guid, Guid)

Scripts\RPG\Remove Ability, Talent, or Phrase

Name /typeDescription /example
Target character
Guid (Instance ID)
The character to remove the unlockable from.
"00000000-0000-0000-0000-000000000000"
Unlockable
Guid (ProgressionUnlockableGameData)
The ability, talent, or phrase to remove.
"b1a8e901-0000-0000-0000-000000000000"

Void RemoveAllInjuries(Guid)

Scripts\General\Remove All Injuries

Name /typeDescription /example
Target
Guid (Instance ID)
The target character to remove the injuries from
"00000000-0000-0000-0000-000000000000"

Void RemoveAllItemsFromObject(Guid)

Scripts\Items\Remove All Items from Object

Name /typeDescription /example
Object
Guid (Instance ID)
Object to lose items.
"00000000-0000-0000-0000-000000000000"

Void RemoveCameraScriptedFocus()

Scripts\Camera\Remove Smart Camera Scripted Focus

Void RemoveCharacterWaitingForSceneTransition(Guid)

Scripts\AI\Behaviors\SceneTransition\Remove Character Waiting For Scene Transition

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void RemoveFromParty(Guid)

Scripts\Party\Remove from Party

Name /typeDescription /example
Companion
Guid (Instance ID)
The companion to remove.
"00000000-0000-0000-0000-000000000000"

Void RemoveFromPartyAndLeave(Guid)

Scripts\Party\Remove from Party and Leave

Name /typeDescription /example
Companion
Guid (Instance ID)
The companion to remove.
"00000000-0000-0000-0000-000000000000"

Void RemoveItems(Guid, Int32)

Scripts\Items\Remove Items (from Party)

Name /typeDescription /example
Item
Guid (ItemGameData)
The item to remove
"00000000-0000-0000-0000-000000000000"
Count
Int32
The number of items to remove
"1"

Void RemoveItemsFromObject(Guid, Guid, Int32)

Scripts\Items\Remove Items from Object

Name /typeDescription /example
Object
Guid (Instance ID)
Object to lose item.
"00000000-0000-0000-0000-000000000000"
Item
Guid (ItemGameData)
The item to remove
"00000000-0000-0000-0000-000000000000"
Count
Int32
The number of items to remove
"1"

Void RemovePet(Guid)

Scripts\Companion\Remove Pet

Name /typeDescription /example
Owner
Guid (Instance ID)
The owner to remove the pet from.
"00000000-0000-0000-0000-000000000000"

Void RemovePlayerMoney(Int32)

Scripts\Items\Remove Player Money

Name /typeDescription /example
Amount
Int32
The amount of money to remove from the player
"1"

Void RemovePlayerShip(Guid)

Scripts\Ships\Remove Player Ship

Name /typeDescription /example
Ship
Guid (ShipGameData)
Ship to give to the player.
"00000000-0000-0000-0000-000000000000"

Void RemoveStatusEffect(Guid, Guid)

Scripts\General\Remove Status Effect

Name /typeDescription /example
Target
Guid (Instance ID)
Character to remove from.
"00000000-0000-0000-0000-000000000000"
StatusEffect
Guid (StatusEffectGameData)
The effect to remove.
"00000000-0000-0000-0000-000000000000"

Void ReplaceScriptedMusic(String, Single)

Scripts\Audio\Replace Scripted Music

Name /typeDescription /example
Music Track
String
State string from the Audio Project.
""
Delay
Single
Delay in seconds.
"0"

Void ReputationAddPoints(Guid, Axis, Guid)

Scripts\Faction\Add Reputation

Name /typeDescription /example
Faction
Guid (FactionGameData)
Faction to modify.
"00000000-0000-0000-0000-000000000000"
Axis
String (Axis)
Good vs. Bad action
"Positive"
Strength
Guid (ChangeStrengthGameData)
Severity of the change
"71c858fe-7c4b-432a-a105-c518319eaed7"

Void ResetActionReevaluationTimer(Guid)

Scripts\AI\Behaviors\PreparingToAct\Reset Action Reevaluation Timer

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ResetFogOfWar()

Scripts\Fog of War\Fog Of War Reset All

Void ResetPrimaryAttackReevaluationTimer(Guid)

Scripts\AI\Behaviors\PreparingToAct\Reset Primary Attack Reevaluation Timer

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ResetTimer(Guid)

Scripts\AI\Behaviors\Reset Time

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void ResetTriggerCharges(Guid)

Scripts\Trigger\Reset Trigger Charges

Name /typeDescription /example
Object
Guid (Instance ID)
The trigger
"00000000-0000-0000-0000-000000000000"

Void Rest()

Scripts\Time\Rest

Void RestoreResourcesFromRest(Guid)

Scripts\Time\Restore Resources From Rest

Name /typeDescription /example
Object
Guid (Instance ID)
Character to restore resources as if rested
"00000000-0000-0000-0000-000000000000"

Void RestoreUnequippedItems(Guid)

Scripts\Items\Restore Unequipped Items

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void RestWithMovieID(MovieType)

Scripts\Time\Rest With Movie

Name /typeDescription /example
MovieType
String (MovieType)
This is the movie enum to display
"Inn"

Void ReturnToMainMenu()

Scripts\UI\Return To Main Menu

Void RevealAllFogOfWar()

Scripts\Fog of War\Fog Of War Reveal All

Void RevealAllTraps(Guid)

Scripts\General\Reveal All Traps in Scene

Name /typeDescription /example
Character
Guid (Instance ID)
The character to do the revealing.
"00000000-0000-0000-0000-000000000000"

Void RevealDetectable(Guid, Guid)

Scripts\General\Reveal Detectable

Name /typeDescription /example
Detectable Object
Guid (Instance ID)
The object to reveal.
"00000000-0000-0000-0000-000000000000"
Character
Guid (Instance ID)
The character to do the revealing.
"00000000-0000-0000-0000-000000000000"

Void RevealWorldMapFogOfWar()

Scripts\World Map\Reveal World Map Fog of War

Void RevertSkeletonTransform(Guid)

Scripts\AI\Behaviors\Grapple\Revert Skeleton Transform

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void SaveLegacyHistory()

Scripts\LegacyHistory\Save Legacy History

Void ScreenShake(Single, Single)

Scripts\Camera\Screen Shake

Name /typeDescription /example
Duration
Single
Duration of the shake
"0"
Strength
Single
Strength of the shake
"0"

Void Seal(Guid)

Scripts\OCL\Seal OCL

Name /typeDescription /example
Object
Guid (Instance ID)
Object to seal.
"00000000-0000-0000-0000-000000000000"

Void SealOpen(Guid, Boolean)

Scripts\OCL\Seal Open

Name /typeDescription /example
Object
Guid (Instance ID)
Object to open.
"00000000-0000-0000-0000-000000000000"
Ignore Lock
Boolean
Should we ignore the lock to open
"False"

Void SelectWeaponSet(Guid, Int32)

Scripts\General\Select Weapon Set

Name /typeDescription /example
Object
Guid (Instance ID)
Character
"00000000-0000-0000-0000-000000000000"
Weapon Set ID
Int32
The index of the weapon set to apply.
"0"

Void SetActiveShip(Guid)

Scripts\Ships\Set Active Ship

Name /typeDescription /example
Ship
Guid (ShipGameData)
Ship to activate.
"00000000-0000-0000-0000-000000000000"

Void SetAdditionalCharacterCreationTarget(Guid)

Scripts\UI\Set Character Creation Additional Target

Name /typeDescription /example
Character
Guid (Instance ID)
Character to set.
"00000000-0000-0000-0000-000000000000"

Void SetAnimationTrigger(Guid, AnimationTrigger)

Scripts\General\Set Animation Trigger

Name /typeDescription /example
Object
Guid (Instance ID)
Object to play the animation trigger on.
"00000000-0000-0000-0000-000000000000"
Animation Trigger
String (AnimationTrigger)
The animation trigger to set.
"AmbientExit"

Void SetBackground(Guid, Guid)

Scripts\Background\Set Background

Name /typeDescription /example
Object
Guid (Instance ID)
The character to set background on
"00000000-0000-0000-0000-000000000000"
Background
Guid (BackgroundGameData)
The background value
"00000000-0000-0000-0000-000000000000"

Void SetBenchedPartyMemberBusy(Guid, Boolean)

Scripts\Party\Set Benched Party Member Busy

Name /typeDescription /example
Companion
Guid (Instance ID)
Benched companion whose busy state to change.
"00000000-0000-0000-0000-000000000000"
State
Boolean
True for Busy, false for Not Busy.
"True"

Void SetCameraScriptedFocus(Guid, Single)

Scripts\Camera\Set Smart Camera Scripted Focus

Name /typeDescription /example
Target Object
Guid (Instance ID)
The object to focus on.
"00000000-0000-0000-0000-000000000000"
Hedge Amount (0 to 1)
Single
How far between this point and the party should we keep in the camera view?
"0.5"

Void SetCharacterBusyInInteration(Guid, Boolean)

Scripts\Interaction\Set Character Busy (in Scripted Interaction)

Name /typeDescription /example
Character
Guid (Instance ID)
The character to set
"00000000-0000-0000-0000-000000000000"
State
Boolean
The new busy state of the character
"True"

Void SetCompanionConversationsEnabled(Boolean)

Scripts\Companion\Set Companion Conversations Enabled

Name /typeDescription /example
Enabled
Boolean
True if companion relationship conversations can trigger, false if they are blocked
"True"

Void SetEmbarkEnabled(Boolean)

Scripts\World Map\Set Embark Enabled

Name /typeDescription /example
Enabled
Boolean
Should embarking to the world map be enabled?
"false"

Void SetEndGameSlide(String)

Scripts\UI\Set End Game Slide

Name /typeDescription /example
Image
String
Path to the image to use (expected dimensions are 1840x984).
""

Void SetFleeWaypointReserved(Guid, Boolean)

Scripts\AI\Behaviors\Flee\Set Flee Waypoint Reserved

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Reserved
Boolean
Value to set reserved to.
"True"

Void SetForbidden(Guid, Boolean)

Scripts\OCL\Set OCL Forbidden to Friendly

Name /typeDescription /example
Object
Guid (Instance ID)
Object to test.
"00000000-0000-0000-0000-000000000000"
Forbidden
Boolean
The new owner team
"False"

Void SetForcedActionToAttackForcedHostileTarget(Guid)

Scripts\AI\Behaviors\PreparingToAct\Set Forced Action To Attack Forced Hostile Target

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Name /typeDescription /example
SetName
String (Global Variable)
Global Name to Set
"SetGlobalName"
Value
Int32
Global Value
"0"
CheckName
String (Global Variable)
Global variable to query.
"CheckGlobalName"
Operator
String (Operator)
Comparison operator.
"EqualTo"
CheckValue
Int32
Compare the global variable against this value.
"0"

Void SetGlobalValue(String, Int32)

Scripts\GlobalVars\Set Global

Name /typeDescription /example
Name
String (Global Variable)
Global Name
"GlobalName"
Value
Int32
Global Value
"0"

Void SetHealth(Guid, Single)

Scripts\Health\Set Health

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Health Value
Single
Set current health to this value
"100"

Void SetInteractionImage(String)

Scripts\Interaction\Set Interaction Image

Name /typeDescription /example
Interaction Image
String
Path to the image to use (expected dimensions are 680x648 for standard SI, 1730x910 for Super SI).
""

Void SetInteractionImageFromData(Guid)

Scripts\Interaction\Set Interaction Image (From Data)

Name /typeDescription /example
Interaction Image
Guid (ScriptedInteractionImageGameData)
Image to use.
"00000000-0000-0000-0000-000000000000"

Void SetInvunerable(Guid, Boolean)

Scripts\Health\Set Invunerable

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Invunerable
Boolean
Sets the invulnerability of the object
"True"

Void SetIsGuard(Guid, Boolean)

Scripts\AI\Set Is Guard

Name /typeDescription /example
NPC
Guid (Instance ID)
The character to alter.
"00000000-0000-0000-0000-000000000000"
Is Guard
Boolean
Whether the character should display the guard icon.
"True"

Void SetIsHostile(Guid, Boolean)

Scripts\Faction\Set Is Hostile

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Is Hostile
Boolean
Hostile state towards the player
"True"

Void SetIsReturning(Guid, Boolean)

Scripts\AI\Behaviors\Investigate\Set Is Returning

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Is Returning
Boolean
Whether the character should be returning to original position.
"True"

Void SetLegacyHistoryVariable(String, Int32)

Scripts\LegacyHistory\Set Legacy History Variable

Name /typeDescription /example
History Global
String (Global Variable)
The global variable the history value maps to.
""
Value
Int32
The value of the variable.
"0"

Void SetMapCanCamp(Guid, Boolean)

Scripts\Time\Set Map Can Camp

Name /typeDescription /example
Map
Guid (MapGameData)
Map to change the status of
"00000000-0000-0000-0000-000000000000"
Can Camp
Boolean
The new 'can camp' state of the map
"False"

Void SetMapCanRest(Guid, Boolean)

Scripts\Time\Set Map Can Rest

Name /typeDescription /example
Map
Guid (MapGameData)
Map to change the status of
"00000000-0000-0000-0000-000000000000"
Can Rest
Boolean
The new 'can rest' state of the map
"False"

Void SetMapCanWait(Guid, Boolean)

Scripts\Time\Set Map Can Wait

Name /typeDescription /example
Map
Guid (MapGameData)
Map to change the status of
"00000000-0000-0000-0000-000000000000"
Can Wait
Boolean
The new 'can wait' state of the map
"False"

Void SetMetaTeamRelationship(Guid, Guid, Relationship)

Scripts\Faction\Set Meta Team Relationship

Name /typeDescription /example
Team
Guid (TeamGameData)
The individual team to change
"00000000-0000-0000-0000-000000000000"
Meta Team
Guid (MetaTeamGameData)
The meta team to change
"00000000-0000-0000-0000-000000000000"
Relationship
String (Relationship)
How teams will relate to each other
"Neutral"

Void SetMinimalUIState(Boolean)

Scripts\UI\Set Minimal UI State

Name /typeDescription /example
Toggle State
Boolean
Whether or not the UI should be set to minimal state or not.
"True"

Void SetMorale(Int32)

Scripts\Ship Crew\Set Morale

Name /typeDescription /example
Value
Int32
The number to set morale to. Regardless of the value set, morale will never be above 100 or below 1.
"0"

Void SetNavMeshObstacleActivated(Guid, Boolean)

Scripts\NavObstacle\SetNavMeshObstacleActivated

Name /typeDescription /example
Object
Guid (Instance ID)
The nav mesh obstactle to affect
"00000000-0000-0000-0000-000000000000"
Is Active
Boolean
Sets if the obstacle is activated or not.
"True"

Void SetOwned(Guid, Guid)

Scripts\OCL\Set OCL owner team

Name /typeDescription /example
Object
Guid (Instance ID)
Object to test.
"00000000-0000-0000-0000-000000000000"
Team
Guid (TeamGameData)
The new owner team
"00000000-0000-0000-0000-000000000000"

Void SetParallaxLayerVisibility(Guid, Boolean)

Scripts\General\Set Parallax Layer Visibility

Name /typeDescription /example
Object
Guid (Instance ID)
Object to set visibility of.
"00000000-0000-0000-0000-000000000000"
Visible
Boolean
Visibility to set the object to.
"True"

Void SetPartyStealth(Boolean)

Scripts\Stealth\Set Party Stealth

Name /typeDescription /example
State
Boolean
True to put the party into stealth, false to take the party out of stealth.
"True"

Void SetPlayerBackground(Guid)

Scripts\Background\Set Player Background

Name /typeDescription /example
Background
Guid (BackgroundGameData)
The background value
"00000000-0000-0000-0000-000000000000"

Void SetPreparingToActParamsOwner(Guid)

Scripts\AI\Behaviors\PreparingToAct\Set Preparing To Act Params Owner

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void SetPreventDeath(Guid, Boolean)

Scripts\Health\(NOT IMPLEMENTED) Set Prevent Death

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Prevent Death
Boolean
Sets the death prevention of the object
"True"

Void SetQuestAlternateDescription(Guid, Int32)

Scripts\Quest\Set Quest Alternate Description

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest to update.
"00000000-0000-0000-0000-000000000000"
Alternate Description ID
Int32
The ID of the alternate description to display.
"0"

Void SetRetreating(Guid, Boolean)

Scripts\AI\Behaviors\PreparingToAct\Set Retreating

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"
Active
Boolean
Whether the character is retreating.
"True"

Void SetShipDuelDistance(Int32)

Scripts\Ship Duel\Set Distance

Name /typeDescription /example
Distance
Int32
The distance.
"400"
Name /typeDescription /example
From
String (ShipDuelParticipant)
Will set the bearing from this ship to the other ship.
"Player"
Bearing
String (ShipCombatRelativeBearing)
The bearing to set.
"Fore"

Void SetSkillCheckToken(Guid, Operator, Int32)

Scripts\RPG\Set Skill Check Token

Name /typeDescription /example
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"

Void SetSkillCheckTokenBest(Guid)

Scripts\RPG\Set Skill Check Token With Best Check

Name /typeDescription /example
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Name /typeDescription /example
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"
Skill Operator
String (Operator)
Comparison operator.
"EqualTo"
Skill Value
Int32
Compare the object's skill against this value.
"0"
Scaler
String (DifficultyScaler)
Scaler to use, if the player has enabled it.
"NONE"

Void SetSkillCheckTokenWorst(Guid)

Scripts\RPG\Set Skill Check Token With Worst Check

Name /typeDescription /example
Skill Type
Guid (SkillGameData)
Skill to test.
"00000000-0000-0000-0000-000000000000"

Void SetSmartCameraState(TrackingState)

Scripts\Camera\Set Smart Camera State

Name /typeDescription /example
Tracked Stat
String (TrackingState)
The tracked achievement stat we are incrementing.
"UsingSmartSettings"

Void SetSwitchEnabled(Guid, Boolean)

Scripts\Switch\Set Switch Enabled

Name /typeDescription /example
Object
Guid (Instance ID)
The switch
"00000000-0000-0000-0000-000000000000"
isEnabled
Boolean
New Enabled Value
"True"

Void SetTeamDefaultRelationship(Guid, Relationship)

Scripts\Faction\Set Team Default Relationship

Name /typeDescription /example
Team
Guid (TeamGameData)
The team to change
"00000000-0000-0000-0000-000000000000"
Relationship
String (Relationship)
How team will relate to other teams
"Neutral"

Void SetTeamRelationship(Guid, Guid, Relationship)

Scripts\Faction\Set Team Relationship

Name /typeDescription /example
Team A
Guid (TeamGameData)
The first team to change
"00000000-0000-0000-0000-000000000000"
Team B
Guid (TeamGameData)
The second team to change
"00000000-0000-0000-0000-000000000000"
Relationship
String (Relationship)
How team A and B will relate to each other
"Neutral"

Void SetTimer(Guid, Single)

Scripts\Timer\Set Timer

Name /typeDescription /example
Object
Guid (Instance ID)
The timer object
"00000000-0000-0000-0000-000000000000"
Time
Single
New delay time for timer
"1"

Void SetTriggerEnabled(Guid, Boolean)

Scripts\Trigger\Set Trigger Enabled

Name /typeDescription /example
Object
Guid (Instance ID)
The trigger
"00000000-0000-0000-0000-000000000000"
isEnabled
Boolean
New Enabled Value
"True"

Void SetUserCancelEnabled(Guid, Boolean)

Scripts\AI\Set User Cancel Enabled

Name /typeDescription /example
Object
Guid (Instance ID)
Object to enable/disable behavior canceling.
"7d150000-0000-0000-0000-000000000000"
State
Boolean
True if canceling should be enabled.
"False"

Void SetVendorFaction(Guid, Guid)

Scripts\Stores\Set Vendor Faction

Name /typeDescription /example
Vendor
Guid (Instance ID)
The vendor to modify.
"00000000-0000-0000-0000-000000000000"
Faction
Guid (FactionGameData)
The faction to set.
"00000000-0000-0000-0000-000000000000"

Void SetWantsToTalk(Guid, Boolean)

Scripts\Conversation\Set Wants To Talk

Name /typeDescription /example
Target Party Member
Guid (Instance ID)
The party member desired to show the flag
"00000000-0000-0000-0000-000000000000"
Wants To Talk
Boolean
The new state for the conversation flag
"False"

Void SetWeatherPattern(Guid, Boolean, Single)

Scripts\Weather\Set Weather Pattern

Name /typeDescription /example
Weather Pattern
Guid (WeatherPatternGameData)
Weather pattern to use.
"00000000-0000-0000-0000-000000000000"
Is Transition Insant
Boolean
Whether the transition to the weather pattern should be instant or gradual.
"False"
Duration
Single
Duration weather pattern should exist.
"60"

Void SetWorldMapIconEnabled(Guid, Boolean)

Scripts\World Map\Set World Map Usable Enabled

Name /typeDescription /example
Usable
Guid (Instance ID)
The icon to enable or disable.
"00000000-0000-0000-0000-000000000000"
Enabled
Boolean
Should the icon be enabled, or disabled?
"False"

Void SetWorldMapUsableVisibility(Guid, MapVisibilityType)

Scripts\World Map\Set World Map Usable Visibility

Name /typeDescription /example
Usable
Guid (Instance ID)
The icon to enable or disable.
"00000000-0000-0000-0000-000000000000"
Visibility
String (MapVisibilityType)
The new visibility state of the icon.
"Unlocked"

Void ShipDuelCloseToBoard(ShipDuelParticipant)

Scripts\Ship Duel\Close to Board

Name /typeDescription /example
Actor
String (ShipDuelParticipant)
The participant that will board.
"Player"

Void ShipDuelSurrender(ShipDuelParticipant)

Scripts\Ship Duel\Ship Duel Surrender

Name /typeDescription /example
Actor
String (ShipDuelParticipant)
The participant that surrenders.
"Player"

Void ShipNextTurn()

Scripts\Ship Duel\Next Turn

Void ShowMessageBox(StringTableType, Int32)

Scripts\General\Show Message Box

Name /typeDescription /example
String Table
String (StringTableType)
The string table containing the message.
"Gui"
String Id
Int32
The string ID of the message.
"0"

Void ShowMessageBoxCustomSize(StringTableType, Int32, String)

Scripts\General\Show Message Box Custom Size

Name /typeDescription /example
String Table
String (StringTableType)
The string table containing the message.
"Gui"
String Id
Int32
The string ID of the message.
"0"
Dimension Size
String
Tag of the preset dimension size, 'default' or 'large' for example.
""

Void ShowShipSIImage()

Scripts\Ship Duel\Show Ship SI Image

Void SoulMemoryCameraEnable(Boolean)

Scripts\Camera\Soul Memory Camera Enable

Name /typeDescription /example
Enabled
Boolean
Whether the camera should be enabled or disabled
"True"

Void SpecifyCharacter(Guid, Int32)

Scripts\General\Specify Character

Name /typeDescription /example
Character GUID
Guid (Instance ID)
The character to store.
"00000000-0000-0000-0000-000000000000"
Index
Int32
The index to store the character in.
"0"

Void SpecifyCrewMemberWithExpression(Guid, Int32, Boolean)

Scripts\Ship Crew\Specify Random Speaker Crew Member With Expression

Name /typeDescription /example
Expression
Guid (GlobalConditional)
Expression used to specify the crew member
"00000000-0000-0000-0000-000000000000"
Index
Int32
The index to store the character in.
"0"
Random on Fail
Boolean
If this value is set to true and no crew members fit the expression then specify any random crew member
"True"

Void SpecifyCrewMemberWithJobThenExpression(ShipCrewJobType, Guid, Int32, Boolean)

Scripts\Ship Crew\Specify Random Speaker Crew Member With Job then Expression

Name /typeDescription /example
Job
String (ShipCrewJobType)
If there is a valid crew member in this job, specify him.
"Deckhand"
Expression
Guid (GlobalConditional)
If there was no valid crewmember in the job, specify one with the expression.
"00000000-0000-0000-0000-000000000000"
Index
Int32
The index to store the character in.
"0"
Random on Fail
Boolean
If this value is set to true and no crew members fit either condition, specify any random crew member
"True"

Void SpecifyRandomCrewJobMember(ShipCrewJobType, Int32)

Scripts\Ship Crew\Specify Random Speaker Crew Member With Job

Name /typeDescription /example
Crew Job
String (ShipCrewJobType)
The job of the character to store in the guid.
"None"
Index
Int32
The index to store the character in.
"0"

Void SpecifyRandomCrewMember(Int32)

Scripts\Ship Crew\Specify Random Speaker Crew Member

Name /typeDescription /example
Index
Int32
The index to store the character in.
"0"

Void StartConversation(Guid, Guid, Int32)

Scripts\Conversation\Start Conversation

Name /typeDescription /example
Object
Guid (Instance ID)
Speaker Object
"00000000-0000-0000-0000-000000000000"
Conversation
Guid (Conversation)
Conversation File
"00000000-0000-0000-0000-000000000000"
Conversation Node ID
Int32
Conversation Node ID
"0"

Void StartConversationFacingListener(Guid, Guid, Int32)

Scripts\Conversation\Start Conversation Facing Listener

Name /typeDescription /example
Object
Guid (Instance ID)
Speaker Object
"00000000-0000-0000-0000-000000000000"
Conversation
Guid (Conversation)
Conversation File
"00000000-0000-0000-0000-000000000000"
Conversation Node ID
Int32
Conversation Node ID
"0"

Void StartCutscene(Guid)

Scripts\Cutscene\Start Cutscene

Name /typeDescription /example
Object
Guid (Instance ID)
Cutscene Object
"00000000-0000-0000-0000-000000000000"

Void StartEncounterConversation()

Scripts\Encounter\Start Encounter Conversation

Void StartFollowCamera()

Scripts\Camera\Start Follow Camera

Void StartQuest(Guid)

Scripts\Quest\Start Quest

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"

Void StartQuestWithAlternateDescription(Guid, Int32)

Scripts\Quest\Start Quest With Alternate Description

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"
Alternate Description ID
Int32
The ID of the alternate description to display.
"0"

Void StartScriptedInteraction(Guid)

Scripts\Interaction\Start Scripted Interaction

Name /typeDescription /example
Conversation
Guid (Conversation)
Scripted Interaction conversation
"00000000-0000-0000-0000-000000000000"

Void StartTimer(Guid)

Scripts\Timer\Start Timer

Name /typeDescription /example
Object
Guid (Instance ID)
The timer object
"00000000-0000-0000-0000-000000000000"

Void StartWeatherPattern(Guid, Boolean)

Scripts\Weather\Start Weather Pattern

Name /typeDescription /example
Weather Pattern
Guid (WeatherPatternGameData)
Weather pattern to begin.
"00000000-0000-0000-0000-000000000000"
Is Transition Insant
Boolean
Whether the transition to the weather pattern should be instant or gradual.
"False"
Name /typeDescription /example
Object
Guid (Instance ID)
Object with an AudioEmitter. If empty, will use global object.
"00000000-0000-0000-0000-000000000000"
Audio Event
String
The audio event to stop.
""
Fade Time
Single
The fade out time.
"0"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"
Name /typeDescription /example
Object
Guid (Instance ID)
Object with an AudioEmitter. If empty, will use global object.
"00000000-0000-0000-0000-000000000000"
Audio Event 1
String
Audio event to play.
""
Audio Event 2
String
Audio event to play.
""
Audio Event 3
String
Audio event to play.
""
Audio Event 4
String
Audio event to play.
""
Fade Time
Single
The fade out time.
"0"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"

Void StopAudioEventWithID(String, String, Single, Single, Boolean)

Scripts\Audio\Stop Audio Event With Unique ID

Name /typeDescription /example
ID
String
Unique identifier.
""
Audio Event
String
The audio event to stop.
""
Fade Time
Single
The fade out time.
"0"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"
Name /typeDescription /example
ID
String
Unique identifier.
""
Audio Event 1
String
Audio event to play.
""
Audio Event 2
String
Audio event to play.
""
Audio Event 3
String
Audio event to play.
""
Audio Event 4
String
Audio event to play.
""
Fade Time
Single
The fade out time.
"0"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"

Void StopCombat(Guid)

Scripts\Faction\Stop Combat

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void StopDynamicAmbientMusicEvent(String, String, String)

Scripts\Audio\Stop Dynamic Ambient Music Event (Multiple)

Name /typeDescription /example
Default State ID
String
ID of the default dynamic music state.
""
Stealth State ID
String
ID of the stealth dynamic music state.
""
Conversation State ID
String
ID of the conversation dynamic music state.
""

Void StopDynamicAmbientMusicEvent(AmbientMusicStateType, String)

Scripts\Audio\Stop Dynamic Ambient Music Event

Name /typeDescription /example
Category
String (AmbientMusicStateType)
Category of the dynamic music state.
"Default"
State ID
String
ID of the dynamic music state.
""

Void StopDynamicCombatMusicEvent(String)

Scripts\Audio\Stop Dynamic Combat Music Event

Name /typeDescription /example
State ID
String
ID of the dynamic music state.
""

Void StopShipDuelAudioEvent(String, Single, Single, Boolean)

Scripts\Audio\Stop Ship Duel Audio Event

Name /typeDescription /example
Audio Event
String
The audio event to stop.
""
Fade Time
Single
The fade out time.
"0"
Delay
Single
Delay in seconds.
"0"
Ignore Pause
Boolean
Update delay even if game is paused.
"True"

Void StopTimer(Guid)

Scripts\Timer\Stop Timer

Name /typeDescription /example
Object
Guid (Instance ID)
The timer object
"00000000-0000-0000-0000-000000000000"

Void StoreAddRegenerationList(Guid, Guid)

Scripts\Stores\Store Add Regeneration List

Name /typeDescription /example
Store
Guid (Instance ID)
The store to modify.
"00000000-0000-0000-0000-000000000000"
Loot List
Guid (LootListGameData)
The list to add.
"00000000-0000-0000-0000-000000000000"

Void StoreRegenerateItems(Guid)

Scripts\Stores\Regenerate Store Items

Name /typeDescription /example
Store
Guid (Instance ID)
The store to regenerate.
"00000000-0000-0000-0000-000000000000"

Void StoreRemoveAllRegenerationLists(Guid)

Scripts\Stores\Store Remove All Regeneration Lists

Name /typeDescription /example
Store
Guid (Instance ID)
The store to modify.
"00000000-0000-0000-0000-000000000000"

Void StoreRemoveRegenerationList(Guid, Guid)

Scripts\Stores\Store Remove Regeneration List

Name /typeDescription /example
Store
Guid (Instance ID)
The store to modify.
"00000000-0000-0000-0000-000000000000"
Loot List
Guid (LootListGameData)
The list to add.
"00000000-0000-0000-0000-000000000000"

Void TeleportAnimalCompanionToLocation(Guid, Guid)

Scripts\Movement\Teleport Animal Companion To Location

Name /typeDescription /example
Object
Guid (Instance ID)
The object who needs their animal companion teleported.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"

Void TeleportAvailablePartyToLocation(Guid)

Scripts\Movement\Teleport Available Party To Location

Name /typeDescription /example
Target
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"

Void TeleportDetectedPartyToLocation(Guid, Guid, Boolean, Single)

Scripts\Movement\Teleport Detected Party To Location

Name /typeDescription /example
Target
Guid (Instance ID)
The object to to teleport to
"00000000-0000-0000-0000-000000000000"
Detector
Guid (Instance ID)
The object to check detection of
"00000000-0000-0000-0000-000000000000"
Fade
Boolean
If we should handle the fade (sfx is faded too)
"False"
ExtraDistance
Single
If we want to add a bit of distance on the perception range
"0"

Void TeleportObjectToLocation(Guid, Guid)

Scripts\Movement\Teleport Object To Location

Name /typeDescription /example
Object
Guid (Instance ID)
The object to move.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"

Void TeleportPartyToLocation(Guid)

Scripts\Movement\Teleport Party To Location

Name /typeDescription /example
Tag
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"

Void TeleportPlayerToLocation(Guid)

Scripts\Movement\Teleport Player To Location

Name /typeDescription /example
Target
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"

Void TeleportWorldMapPlayerToLocation(Guid, Boolean)

Scripts\World Map\Teleport World Map Player To Location

Name /typeDescription /example
Target
Guid (Instance ID)
The object to teleport to.
"00000000-0000-0000-0000-000000000000"
Advance Time
Boolean
Should time be advanced, as though the player moved this distance?
"True"

Void TempUnequipItems(Guid)

Scripts\Items\Temp Unequip Items

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void ToggleLock(Guid)

Scripts\OCL\Toggle Lock

Name /typeDescription /example
Object
Guid (Instance ID)
Object to toggle.
"00000000-0000-0000-0000-000000000000"

Void ToggleOpen(Guid, Boolean)

Scripts\OCL\Toggle Open

Name /typeDescription /example
Object
Guid (Instance ID)
Object to toggle.
"00000000-0000-0000-0000-000000000000"
Ignore Lock
Boolean
Should we ignore the lock to open
"False"

Void TradePlayerShip(Guid, Guid)

Scripts\Ships\Trade Player Ship

Name /typeDescription /example
Give Ship
Guid (ShipGameData)
Ship to give to the player.
"00000000-0000-0000-0000-000000000000"
Take Ship
Guid (ShipGameData)
Ship to take from the player.
"00000000-0000-0000-0000-000000000000"
Name /typeDescription /example
From
Guid (Instance ID)
Object to take item from.
"00000000-0000-0000-0000-000000000000"
To
Guid (Instance ID)
Object to give item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (ItemGameData)
The item to move.
"00000000-0000-0000-0000-000000000000"
Quantity
Int32
Number of items to transfer.
"1"

Void TransferItemFromParty(Guid, Guid, Int32)

Scripts\Items\Transfer Item From Party

Name /typeDescription /example
To
Guid (Instance ID)
Object to give item to.
"00000000-0000-0000-0000-000000000000"
Item
Guid (ItemGameData)
The item to move.
"00000000-0000-0000-0000-000000000000"
Quantity
Int32
Number of items to transfer.
"1"
Name /typeDescription /example
From
Guid (Instance ID)
Object to take item from.
"00000000-0000-0000-0000-000000000000"
To
Guid (Instance ID)
Object to give item to.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot
"None"
Quantity
Int32
Number of items to transfer.
"1"

Void TransferItemsToStash(Guid)

Scripts\Items\Transfer Items To Stash

Name /typeDescription /example
From
Guid (Instance ID)
Object to take items from.
"00000000-0000-0000-0000-000000000000"

Void TransferPlayerCrew(Guid, Guid)

Scripts\Ships\Transfer Player Crew

Name /typeDescription /example
To Ship
Guid (ShipGameData)
Ship to put the crew on.
"00000000-0000-0000-0000-000000000000"
From Ship
Guid (ShipGameData)
Ship to take the crew from.
"00000000-0000-0000-0000-000000000000"

Void TransitionToOVSState(Guid, Guid)

Scripts\OVS\Transition To OVS State

Name /typeDescription /example
OVS Object
Guid (Instance ID)
The OVS object
"00000000-0000-0000-0000-000000000000"
State Name
Guid (VisualStateNameGameData)
Name of state to transition to
"00000000-0000-0000-0000-000000000000"

Void TriggerCinematicIntro(Guid)

Scripts\UI\Trigger Cinematic Introduction

Name /typeDescription /example
Cinematic Introduction
Guid (Instance ID)
The introduction object to trigger
"00000000-0000-0000-0000-000000000000"

Void TriggerQuestAddendum(Guid, Int32)

Scripts\Quest\Trigger Quest Addendum

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"
Addendum ID
Int32
The ID of the addendum to set.
"0"

Void TriggerQuestEndState(Guid, Int32)

Scripts\Quest\Trigger Quest End State

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"
End State ID
Int32
The ID of the end state to set.
"0"

Void TriggerQuestFailState(Guid, Int32)

Scripts\Quest\Trigger Quest Fail State

Name /typeDescription /example
Quest Name
Guid (Quest)
The name of the quest.
"00000000-0000-0000-0000-000000000000"
End State ID
Int32
The ID of the end state to set.
"0"

Void TriggerTextRoll(Guid)

Scripts\UI\Trigger Text Roll

Name /typeDescription /example
TextRollSettings
Guid (TextRollSettingsGameData)
The textroll settings to use.
"00000000-0000-0000-0000-000000000000"

Void TriggerTopic(Guid, Guid, Guid, Boolean)

Scripts\Companion\Trigger Topic

Name /typeDescription /example
Speaker
Guid (Instance ID)
The character object speaking.
"b1a8e901-0000-0000-0000-000000000000"
Topic
Guid (TopicGameData)
The topic to trigger.
"00000000-0000-0000-0000-000000000000"
Strength
Guid (ChangeStrengthGameData)
Strength of the change.
"71c858fe-7c4b-432a-a105-c518319eaed7"
Include Reaction Text
Boolean
If set, a reaction from the companion will automatically be included in the node text.
"True"

Void TriggerTrap(Guid, Guid)

Scripts\General\Trigger Trap

Name /typeDescription /example
Trap
Guid (Instance ID)
The trap to trigger.
"00000000-0000-0000-0000-000000000000"
Target
Guid (Instance ID)
The character to target.
"00000000-0000-0000-0000-000000000000"

Void TriggerTutorial(Guid)

Scripts\UI\Trigger Tutorial

Name /typeDescription /example
Tutorial
Guid (TutorialGameData)
The tutorial to display.
"00000000-0000-0000-0000-000000000000"

Void UnbindItemInSlot(Guid, EquipmentSlot)

Scripts\Items\Unbind Item In Slot

Name /typeDescription /example
Character
Guid (Instance ID)
Character to unbind the item on.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to unbind
"None"

Void UnequipItemInSlot(Guid, EquipmentSlot)

Scripts\Items\Unequip Item in Slot

Name /typeDescription /example
Character
Guid (Instance ID)
Character to unequip from.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to unequip
"None"

Void Unlock(Guid)

Scripts\OCL\UnLock

Name /typeDescription /example
Object
Guid (Instance ID)
Object to unlock.
"00000000-0000-0000-0000-000000000000"

Void UnlockAllEquipmentSlots(Guid)

Scripts\Items\Unlock All Equipment Slot

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"

Void UnlockEquipmentSlot(Guid, EquipmentSlot)

Scripts\Items\Unlock Equipment Slot

Name /typeDescription /example
Object
Guid (Instance ID)
Object to modify.
"00000000-0000-0000-0000-000000000000"
Slot
String (EquipmentSlot)
Equipment Slot to unlock
"None"

Void UnlockPastStoryItem(String)

Scripts\Biography\Unlock Past Story Item

Name /typeDescription /example
Key
String
The string key of the item to unlock
""

Void UnlockPresentStoryItem(String)

Scripts\Biography\Unlock Present Story Item

Name /typeDescription /example
Key
String
The string key of the item to unlock
""

Void Unseal(Guid)

Scripts\OCL\Unseal

Name /typeDescription /example
Object
Guid (Instance ID)
Object to unseal.
"00000000-0000-0000-0000-000000000000"

Void UpdateOriginalPosition(Guid)

Scripts\AI\Behaviors\Investigate\Update Original Position

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void UpdateTimer(Guid)

Scripts\AI\Behaviors\Update Timer

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void UpdateTownieScheduleAIParams(Guid)

Scripts\AI\Behaviors\TownieSchedule\Update Townie Schedule AIParams

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void UseObject(Guid)

Scripts\AI\Behaviors\Use Object

Name /typeDescription /example
Character
Guid (Instance ID)
Character to check.
"7d150000-0000-0000-0000-000000000000"

Void WaitForDialogue(Guid)

Scripts\Conversation\Wait For Dialogue

Name /typeDescription /example
Object
Guid (Instance ID)
Object to push into Wait For Dialogue to End behavior.
"00000000-0000-0000-0000-000000000000"

Void WaitForShipAI()

Scripts\Ship Duel\Wait for AI

Void WaitForShipPlayer()

Scripts\Ship Duel\Wait for Player

Void WorldMapRespawn(WorldMapTransitMode)

Scripts\World Map\World Map Respawn

Name /typeDescription /example
Transit Mode
String (WorldMapTransitMode)
What mode the player should spawn into.
"Sailing"

Void WorldMapSetVisibility(Guid, MapVisibilityType)

Scripts\World Map\World Map Set Visibility

Name /typeDescription /example
Map
Guid (MapGameData)
Map to change the status of
"00000000-0000-0000-0000-000000000000"
Visibility
String (MapVisibilityType)
New visibility status
"Locked"