Skip to content

Reference: Interface‐based data

Jump to bottom
Artyom Zuev edited this page Jan 19, 2026 · 2 revisions

Interface-based classes are used across many databases in Phantom Brigade. They offer a way to separate responsibilities and streamline serialized data. Instead of including every possible piece of functionality directly into the data structure (e.g. "is this config a weapon? if yes, what is its projectile? if it has a projectile, what is it's model? ..."), data types can declare collections with interface values. Those collections might be empty or include many different entries of different types implementing a given interface, each with different fields and execution logic.

This article covers most commonly utilized interface types based on annotations provided in code. Refer to FunctionInterfaces.cs in the SDK codebase and inspect the code for types inheriting from a given interface to learn more about each of the interfaces used by the game.

IOverworldFunction

ℹ️ Used to execute arbitrary logic not requiring a target entity in the overworld context. Signature void Run ()
Classes inheriting from this interface: 106

ApplyProvinceArrivalEffects

No description available.

!ApplyProvinceArrivalEffects {}

ApplySimLockEffect

No description available.

  • string type (nullable)
  • bool displayDialog
!ApplySimLockEffect
type: ''
displayDialog: true

BasePartInstall

No description available.

  • string partKey (nullable)
    • DataMultiLinkerBasePart database key
!BasePartInstall
partKey: ''

CallMethodStatic

No description available.

  • string typeName (nullable)
  • string methodName (nullable)
  • string argument (nullable)
  • int frameDelay
!CallMethodStatic
typeName: ''
methodName: ''
argument: ''
frameDelay: 0

ChangeSelfView

No description available.

  • string assetKey (nullable)
!ChangeSelfView
assetKey: ''

CombatModifyPlayerUnits

No description available.

  • int units
  • List<ICombatUnitValidationFunction> checks (nullable)
  • List<ICombatFunctionTargeted> functions (nullable)
!CombatModifyPlayerUnits
units: 0
checks: []
functions: []

CombatModifyUnits

No description available.

  • int units
  • List<ICombatUnitValidationFunction> checks (nullable)
  • List<ICombatFunctionTargeted> functions (nullable)
!CombatModifyUnits
units: 0
checks: []
functions: []

Comment

No description available.

  • string comment (nullable)
!Comment
comment: ''

CompleteWorkshopQueue

No description available.

!CompleteWorkshopQueue {}

CreateParts

No description available.

  • bool log
  • List<DataBlockVirtualParts> parts (nullable)
!CreateParts
log: false
parts:
- levelMin: 1
  levelMax: 1
  levelRandom: false
  qualityTableKey: ''
  preset: ''
  tagsUsed: true
  tags:
    '': false
  countMin: 1
  countMax: 1
  countRandom: false

CreatePilot

No description available.

  • PilotIdentificationLocOnly identification (nullable)
  • string bio (nullable)
  • DataBlockPilotAppearanceOverlay appearanceOverlay (nullable)
  • DataBlockPilotAppearance appearanceCustom (nullable)
  • List<string> appearancePresets (nullable)
    • DataMultiLinkerPilotAppearancePreset database key
  • SortedDictionary<string,float> memory (nullable)
!CreatePilot
identification:
  callsignLoc:
    textSector: 
    textKey: 
  namePrimaryLoc:
    textSector: 
    textKey: 
  nameSecondaryLoc:
    textSector: 
    textKey: 
bio: ''
appearanceOverlay:
  key: ''
  variant: ''
appearanceCustom:
  version: 0
  model: ''
  skinMain: ''
  heightOffset: 0
  skinOverlay: ''
  pilotSuitColorVariant: ''
  skinTintPreset: ''
  hairMain: ''
  hairMainTintPreset: ''
  hairFacial: ''
  hairEyebrows: ''
  hairFacialTintPreset: ''
  eyesTintPreset: ''
  eyesIrisPreset: ''
  lipsTintPreset: ''
  makeupPatternKey: ''
  makeupColorVariantKey: ''
  accessoryHeadTop: ''
  accessoryHeadTopVariant: ''
  accessoryHeadFront: ''
  accessoryHeadFrontVariant: ''
  blendPresetArchetype: ''
  blendAppearanceCustomization: {}
  blendShapes:
  - key: 
    value: 0
  portrait: ''
  portraitVariant: ''
  cameraAnglePreset: ''
appearancePresets:
- ''
memory:
  '': 0

CreatePoint

No description available.

  • PointDistancePriority spawnPriority
  • string spawnGroup (nullable)
  • DataBlockVector2 spawnRange (nullable)
  • string provinceOverride (nullable)
  • string nameOverride (nullable)
  • string questKey (nullable)
  • List<IOverworldTargetedFunction> functionsOnSpawn (nullable)
  • bool tagsUsed
  • List<string> keys (nullable)
  • SortedDictionary<string,bool> tags: @GetTooltip () (nullable)
  • DataContainerLink<DataContainerOverworldPointPreset>DataContainerLink<DataContainerOverworldPointPreset>> configsFiltered (nullable)
!CreatePoint
spawnPriority: None
spawnGroup: ''
spawnRange:
  v:
    x: 0
    y: 0
provinceOverride: ''
nameOverride: ''
questKey: ''
functionsOnSpawn: []
tagsUsed: true
keys:
- ''
tags:
  '': false

CreatePointFiltered

No description available.

  • SortedDictionary<string,bool> filter (nullable)
!CreatePointFiltered
filter:
  '': false

CreatePointFilteredBatch

No description available.

  • int pointLimit
  • SortedDictionary<string,bool> filter (nullable)
!CreatePointFilteredBatch
pointLimit: 3
filter:
  '': false

CreatePointRandom

No description available.

!CreatePointRandom {}

CreateRewards

No description available.

  • SortedDictionary<string,int> rewards (nullable)
!CreateRewards
rewards:
  '': 0

CreateRewardsFiltered

No description available.

  • bool randomSingleEntry
  • List<DataBlockOverworldPointReward> rewards (nullable)
  • bool generated
  • SortedDictionary<string,int> rewardsProcessed (nullable)
  • List<string> rewardKeysFiltered (nullable)
!CreateRewardsFiltered
randomSingleEntry: false
rewards:
- chance: 1
  repeats: 1
  tagsUsed: true
  keys:
  - ''
  tags:
    '': false

CreateSimplePatrol

No description available.

!CreateSimplePatrol {}

CreateSubsystems

No description available.

  • bool log
  • List<DataBlockVirtualSubsystems> subsystems (nullable)
!CreateSubsystems
log: false
subsystems:
- ratingRange:
    min: 0
    max: 0
  blueprint: ''
  tagsUsed: true
  tags:
    '': false
  countMin: 1
  countMax: 1
  countRandom: false

CreateUnit

No description available.

  • int levelOffset
  • string qualityTable (nullable)
    • DataMultiLinkerQualityTable database key
  • string factionBranch (nullable)
    • DataMultiLinkerOverworldFactionBranch database key
  • string presetKey (nullable)
    • DataMultiLinkerUnitPreset database key
  • SortedDictionary<string,bool> presetTags (nullable)
  • SortedDictionary<string,float> memory (nullable)
!CreateUnit
levelOffset: 0
qualityTable: ''
factionBranch: ''
presetKey: ''
presetTags:
  '': false
memory:
  '': 0

CreateWorkshopProjects

No description available.

  • List<DataBlockVirtualWorkshopProject> projects (nullable)
!CreateWorkshopProjects
projects:
- countMin: 1
  countMax: 1
  countRandom: false
  tagsUsed: false
  key: ''
  tags:
    '': false

DelayGroupRealtime

No description available.

  • float delay
  • List<IOverworldFunction> functions (nullable)
!DelayGroupRealtime
delay: 0
functions: []

DeletePoints

No description available.

  • Mode mode
  • int target
  • bool onlyCombat
  • bool onlyHostile
  • List<IOverworldEntityValidationFunction> checks (nullable)
!DeletePoints
mode: DeleteUntilTarget
target: 0
onlyCombat: false
onlyHostile: false
checks: []

ImplementSimLockEffectCamp

No description available.

!ImplementSimLockEffectCamp {}

ImplementSimLockEffectResupply

No description available.

!ImplementSimLockEffectResupply {}

ImplementSimLockEffectTravel

No description available.

!ImplementSimLockEffectTravel {}

Log

No description available.

  • string message (nullable)
!Log
message: ''

LogMessage

No description available.

  • DataBlockLocString data (nullable)
  • string colorKey (nullable)
    • DataMultiLinkerUIColor database key
!LogMessage
data:
  textSector: ui_combat
  textKey: ''
colorKey: ''

ModifyMemoryBase

No description available.

  • List<DataBlockMemoryChangeFloat> changes (nullable)
!ModifyMemoryBase
changes:
- change: Offset
  key: ''
  value: 1
  valueFromMemory: false
  valueFromMemoryKey: ''

ModifyMemoryBaseAdv

No description available.

  • string keyInput (nullable)
  • string keyOutput (nullable)
  • List<IFloatOperation> operations (nullable)
!ModifyMemoryBaseAdv
keyInput: ''
keyOutput: ''
operations: []

ModifyMemoryProvinceCurrent

No description available.

  • List<DataBlockMemoryChangeFloat> changes (nullable)
!ModifyMemoryProvinceCurrent
changes:
- change: Offset
  key: ''
  value: 1
  valueFromMemory: false
  valueFromMemoryKey: ''

ModifyOverworldPoints

No description available.

  • int count
  • bool onlyCombat
  • bool onlyHostile
  • List<IOverworldEntityValidationFunction> checks (nullable)
  • List<IOverworldTargetedFunction> functions (nullable)
!ModifyOverworldPoints
count: 0
onlyCombat: true
onlyHostile: true
checks: []
functions: []

ModifyPilots

No description available.

  • int pilots
  • bool deployed
  • List<IPilotValidationFunction> checks (nullable)
  • List<IPilotTargetedFunction> functions (nullable)
!ModifyPilots
pilots: 0
deployed: false
checks: []
functions: []

ModifyResources

No description available.

  • List<DataBlockResourceChange> resourceChanges (nullable)
!ModifyResources
resourceChanges:
- key: ''
  check: true
  checkStrict: false
  offset: true
  value: 0

ModifyUnitHealth

No description available.

  • int units
  • float value
!ModifyUnitHealth
units: 0
value: 0.5

ModifyUnitsOverworld

No description available.

  • int units
  • List<IOverworldUnitValidationFunction> checks (nullable)
  • List<IOverworldUnitFunction> functions (nullable)
!ModifyUnitsOverworld
units: 0
checks: []
functions: []

OffsetTime

No description available.

  • float time
  • bool holdCountdown
!OffsetTime
time: 0
holdCountdown: true

OverworldAfterTravelDebug

No description available.

!OverworldAfterTravelDebug {}

OverworldAudioEvent

No description available.

  • string eventKey (nullable)
!OverworldAudioEvent
eventKey: ''

OverworldAudioSync

No description available.

  • string syncKey (nullable)
  • float value
!OverworldAudioSync
syncKey: ''
value: 0

OverworldCameraChange

No description available.

  • float delay
  • bool positionOverride
  • Vector3 position
  • string positionFromEntityName (nullable)
  • bool rotationXOverride
  • float rotationX
  • bool rotationYOverride
  • float rotationY
  • bool zoomOverride
  • float zoom
!OverworldCameraChange
delay: 0
positionOverride: false
position:
  x: 0
  y: 0
  z: 0
positionFromEntityName: ''
rotationXOverride: false
rotationX: 45
rotationYOverride: false
rotationY: 180
zoomOverride: false
zoom: 0.5

OverworldCampaignEffect

No description available.

  • string effectKey (nullable)
  • DataBlockCampaignEffect effectFallback (nullable)
!OverworldCampaignEffect
effectKey: ''
effectFallback:
  functionsGlobal: []
  functionsBase: []

OverworldChance

No description available.

  • float chance
  • IOverworldFunction function (nullable)
!OverworldChance
chance: 0.5
function: !LogMessage
  data:
    textSector: ui_combat
    textKey: 
  colorKey: ''

OverworldChanceBranch

No description available.

  • float chance
  • IOverworldFunction function (nullable)
  • IOverworldFunction functionElse (nullable)
!OverworldChanceBranch
chance: 0.5
function: !LogMessage
  data:
    textSector: ui_combat
    textKey: 
  colorKey: ''
functionElse: !LogMessage
  data:
    textSector: ui_combat
    textKey: 
  colorKey: ''

OverworldChanceBranchGroup

No description available.

  • float chance
  • List<IOverworldFunction> functions (nullable)
  • List<IOverworldFunction> functionsElse (nullable)
!OverworldChanceBranchGroup
chance: 0.5
functions: []
functionsElse: []

OverworldChanceGroup

No description available.

  • float chance
  • List<IOverworldFunction> functions (nullable)
!OverworldChanceGroup
chance: 0.5
functions: []

OverworldChanceWeighted

No description available.

  • Dictionary<float,IOverworldFunction> functions (nullable)
!OverworldChanceWeighted
functions: {}

OverworldChanceWeightedGroup

No description available.

  • List<IOverworldFunction>List<IOverworldFunction>> functions (nullable)
!OverworldChanceWeightedGroup
functions:
  0: []

OverworldCombatForced

No description available.

  • string scenarioKey (nullable)
    • DataMultiLinkerScenario database key
  • string areaKey (nullable)
    • DataMultiLinkerCombatArea database key
!OverworldCombatForced
scenarioKey: ''
areaKey: ''

OverworldDisplayTitle

No description available.

  • float hue
  • DataBlockLocString textPrimary (nullable)
  • DataBlockLocString textSecondary (nullable)
  • DataBlockLocString textTertiary (nullable)
!OverworldDisplayTitle
hue: 0
textPrimary:
  textSector: ui_combat
  textKey: ''
textSecondary:
  textSector: ui_combat
  textKey: ''
textTertiary:
  textSector: ui_combat
  textKey: ''

OverworldGroupConditional

No description available.

  • List<IOverworldGlobalValidationFunction> checksGlobal (nullable)
  • List<IOverworldEntityValidationFunction> checksBase (nullable)
  • List<DataBlockOverworldResolvedIntCheck> checksBaseValues (nullable)
  • List<IOverworldFunction> functions (nullable)
  • List<IOverworldFunction> functionsElse (nullable)
!OverworldGroupConditional
checksGlobal: []
checksBase: []
checksBaseValues:
- resolver: !OverworldIntValuePointInstances
    onlyCombat: false
    onlyHostile: false
    checks: []
  check: Less
  value: 0
functions: []
functionsElse: []

OverworldGroupTargetFiltered

No description available.

  • List<IOverworldEntityValidationFunction> checks (nullable)
  • List<IOverworldTargetedFunction> functions (nullable)
!OverworldGroupTargetFiltered
checks: []
functions: []

OverworldGroupTargetNamed

No description available.

  • string nameInternal (nullable)
  • List<IOverworldTargetedFunction> functions (nullable)
!OverworldGroupTargetNamed
nameInternal: ''
functions: []

OverworldInteractionExit

No description available.

!OverworldInteractionExit {}

OverworldInteractionStartFilter

No description available.

  • bool overrideOngoing
  • bool tagsUsed
  • List<string> keys (nullable)
  • SortedDictionary<string,bool> tags: @GetTooltip () (nullable)
  • DataContainerLink<DataContainerOverworldInteraction>DataContainerLink<DataContainerOverworldInteraction>> configsFiltered (nullable)
!OverworldInteractionStartFilter
overrideOngoing: true
tagsUsed: true
keys:
- ''
tags:
  '': false

OverworldInteractionStartFilterFallback

No description available.

  • List<IOverworldFunction> functionsFallback (nullable)
  • bool overrideOngoing
  • bool tagsUsed
  • List<string> keys (nullable)
  • SortedDictionary<string,bool> tags: @GetTooltip () (nullable)
  • DataContainerLink<DataContainerOverworldInteraction>DataContainerLink<DataContainerOverworldInteraction>> configsFiltered (nullable)
!OverworldInteractionStartFilterFallback
functionsFallback: []
overrideOngoing: true
tagsUsed: true
keys:
- ''
tags:
  '': false

OverworldInteractionStartFilterTargeted

No description available.

  • string targetNameInternal (nullable)
  • bool overrideOngoing
  • bool tagsUsed
  • List<string> keys (nullable)
  • SortedDictionary<string,bool> tags: @GetTooltip () (nullable)
  • DataContainerLink<DataContainerOverworldInteraction>DataContainerLink<DataContainerOverworldInteraction>> configsFiltered (nullable)
!OverworldInteractionStartFilterTargeted
targetNameInternal: ''
overrideOngoing: true
tagsUsed: true
keys:
- ''
tags:
  '': false

OverworldModifierAdd

No description available.

  • string key (nullable)
    • DataMultiLinkerOverworldProvinceModifier database key
!OverworldModifierAdd
key: ''

OverworldModifierRemove

No description available.

  • string key (nullable)
    • DataMultiLinkerOverworldProvinceModifier database key
!OverworldModifierRemove
key: ''

OverworldModifyPlayerUnits

No description available.

  • int units
  • List<ICombatUnitValidationFunction> checks (nullable)
  • List<ICombatFunctionTargeted> functions (nullable)
!OverworldModifyPlayerUnits
units: 0
checks: []
functions: []

OverworldOffsetCountdownStartTime

No description available.

  • int hours
!OverworldOffsetCountdownStartTime
hours: 0

OverworldRemoveCountdown

No description available.

!OverworldRemoveCountdown {}

OverworldRepeat

No description available.

  • int repeats
  • IOverworldFunction function (nullable)
!OverworldRepeat
repeats: 1
function: !LogMessage
  data:
    textSector: ui_combat
    textKey: 
  colorKey: ''

OverworldRepeatGroup

No description available.

  • int repeats
  • List<IOverworldFunction> functions (nullable)
!OverworldRepeatGroup
repeats: 1
functions: []

OverworldResetCountdownStartTime

No description available.

!OverworldResetCountdownStartTime {}

OverworldSetCountdown

No description available.

  • int min
  • int max
!OverworldSetCountdown
min: 1
max: 1

OverworldSetCountdownFromMemory

No description available.

  • string durationMemoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • int durationFallback
!OverworldSetCountdownFromMemory
durationMemoryKey: ''
durationFallback: 24

OverworldTravel

No description available.

  • string provinceKey (nullable)
    • DataMultiLinkerOverworldProvinceBlueprints database key
  • List<IOverworldFunction> functionsGlobal (nullable)
  • List<IOverworldTargetedFunction> functionsBase (nullable)
  • List<IOverworldTargetedFunction> functionsDestination (nullable)
!OverworldTravel
provinceKey: ''
functionsGlobal: []
functionsBase: []
functionsDestination: []

PlayCutscene

No description available.

  • string key (nullable)
    • DataMultiLinkerCutsceneVideo database key
  • bool instant
!PlayCutscene
key: ''
instant: false

QuestActiveApplyEffectGroup

No description available.

  • string effectKey (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestActiveApplyEffectGroup
effectKey: ''
questMain: true
questKey: ''

QuestActivePointConditional

No description available.

  • DataBlockOverworldEventSubcheckInt countCheck (nullable)
  • List<IOverworldEntityValidationFunction> pointChecks (nullable)
  • List<IOverworldFunction> functions (nullable)
  • List<IOverworldFunction> functionsElse (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestActivePointConditional
countCheck:
  check: Less
  value: 0
pointChecks: []
functions: []
functionsElse: []
questMain: true
questKey: ''

QuestDeletePoints

No description available.

  • bool onlyCombat
  • bool onlyHostile
  • List<IOverworldEntityValidationFunction> checks (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestDeletePoints
onlyCombat: false
onlyHostile: false
checks: []
questMain: true
questKey: ''

QuestExit

No description available.

  • bool effectOnExit
  • bool questMain
  • string questKey (nullable)
!QuestExit
effectOnExit: true
questMain: true
questKey: ''

QuestLiberationUpdate

No description available.

  • int pointsPreserved
  • List<IOverworldEntityValidationFunction> pointChecks (nullable)
  • string progressMemoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • SortedDictionary<string,bool> filter (nullable)
  • string spawnGroup (nullable)
  • bool spawnShuffle
  • int spawnLimit
  • bool spawnLimitOverridesVariant
  • string spawnVariantsKey (nullable)
  • List<QuestLiberationSpawnVariant> spawnVariantsCustom (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestLiberationUpdate
pointsPreserved: 1
pointChecks: []
progressMemoryKey: ''
filter:
  '': false
spawnGroup: ''
spawnShuffle: true
spawnLimit: 0
spawnLimitOverridesVariant: false
spawnVariantsKey: ''
spawnVariantsCustom:
- escalationValue: 0
  progressMemoryValue: 1
  countdownOffset:
    x: 0
    y: 0
questMain: true
questKey: ''

QuestMemoryOffset

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • int value
  • DataBlockInt min (nullable)
  • DataBlockInt max (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestMemoryOffset
memoryKey: ''
value: 0
min:
  i: 0
max:
  i: 0
questMain: true
questKey: ''

QuestMemoryRemove

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • bool questMain
  • string questKey (nullable)
!QuestMemoryRemove
memoryKey: ''
questMain: true
questKey: ''

QuestMemorySet

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • int value
  • bool questMain
  • string questKey (nullable)
!QuestMemorySet
memoryKey: ''
value: 0
questMain: true
questKey: ''

QuestProgress

No description available.

  • string stepRequired (nullable)
  • string stepNext (nullable)
  • bool effectOnExit
  • bool effectOnEntry
  • bool questMain
  • string questKey (nullable)
!QuestProgress
stepRequired: ''
stepNext: ''
effectOnExit: true
effectOnEntry: true
questMain: true
questKey: ''

QuestProvinceCapture

No description available.

  • bool questMain
  • string questKey (nullable)
!QuestProvinceCapture
questMain: true
questKey: ''

QuestProvinceCreatePoint

No description available.

  • string key (nullable)
  • string spawnGroupOverride (nullable)
  • string nameOverride (nullable)
  • List<IOverworldTargetedFunction> functionsOnSpawn (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestProvinceCreatePoint
key: ''
spawnGroupOverride: ''
nameOverride: ''
functionsOnSpawn: []
questMain: true
questKey: ''

QuestProvinceCreatePointFiltered

No description available.

  • Vector2 spawnRange
  • PointDistancePriority spawnPriority
  • SortedDictionary<string,bool> filter (nullable)
  • string spawnGroupOverride (nullable)
  • string nameOverride (nullable)
  • List<IOverworldTargetedFunction> functionsOnSpawn (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestProvinceCreatePointFiltered
spawnRange:
  x: 0
  y: 0
spawnPriority: None
filter:
  '': false
spawnGroupOverride: ''
nameOverride: ''
functionsOnSpawn: []
questMain: true
questKey: ''

QuestProvinceCreatePointFilteredBatch

No description available.

  • int pointLimit
  • int escalationMin
  • int escalationMax
  • SortedDictionary<string,bool> filter (nullable)
  • List<IOverworldTargetedFunction> functionsOnSpawn (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestProvinceCreatePointFilteredBatch
pointLimit: 3
escalationMin: 0
escalationMax: 0
filter:
  '': false
functionsOnSpawn: []
questMain: true
questKey: ''

QuestProvinceWarState

No description available.

  • bool active
  • bool questMain
  • string questKey (nullable)
!QuestProvinceWarState
active: false
questMain: true
questKey: ''

QuestReducePointsToCount

No description available.

  • int countTarget
  • bool questMain
  • string questKey (nullable)
!QuestReducePointsToCount
countTarget: 1
questMain: true
questKey: ''

QuestStart

No description available.

  • string questKey (nullable)
!QuestStart
questKey: ''

QuestStartWithQuestProvince

No description available.

  • string questKeyOngoing (nullable)
  • string questKey (nullable)
!QuestStartWithQuestProvince
questKeyOngoing: ''
questKey: ''

QuestUnlinkPoints

No description available.

  • bool onlyCombat
  • bool onlyHostile
  • List<IOverworldEntityValidationFunction> checks (nullable)
  • bool questMain
  • string questKey (nullable)
!QuestUnlinkPoints
onlyCombat: false
onlyHostile: false
checks: []
questMain: true
questKey: ''

RebuildTravelPoints

No description available.

  • bool questMain
  • string questKey (nullable)
!RebuildTravelPoints
questMain: true
questKey: ''

SelectBase

No description available.

!SelectBase {}

SelectEntity

No description available.

  • string nameInternal (nullable)
  • float delay
  • bool select
  • bool focus
!SelectEntity
nameInternal: ''
delay: 0
select: true
focus: true

SelectEntityByPreset

No description available.

  • string key (nullable)
  • float delay
!SelectEntityByPreset
key: ''
delay: 0

SetGameplayUIActive

No description available.

  • bool active
!SetGameplayUIActive
active: false

SetScreenFade

No description available.

  • bool active
  • bool instant
!SetScreenFade
active: true
instant: false

StartRetreat

No description available.

!StartRetreat {}

StartSimLock

No description available.

  • float duration
  • string type (nullable)
!StartSimLock
duration: 12
type: ''

StartTutorial

No description available.

  • string key (nullable)
    • DataMultiLinkerTutorial database key
  • bool allowRepeat
!StartTutorial
key: ''
allowRepeat: true

TeleportBaseToEntityName

No description available.

  • string nameInternal (nullable)
  • float interactionRangeMultiplier
!TeleportBaseToEntityName
nameInternal: ''
interactionRangeMultiplier: 0

TeleportBaseToPosition

No description available.

  • Vector3 position
!TeleportBaseToPosition
position:
  x: 0
  y: 0
  z: 0

TerminateAction

No description available.

  • string actionKey (nullable)
    • DataMultiLinkerOverworldAction database key
!TerminateAction
actionKey: ''

UnlockAchievement

No description available.

  • string key (nullable)
!UnlockAchievement
key: ''

UnlockCodex

No description available.

  • string key (nullable)
!UnlockCodex
key: ''

UnlockCodexGroup

No description available.

  • HashSet<string> keys (nullable)
!UnlockCodexGroup
keys:
- ''

UpdateCampaignOnFullStart

No description available.

!UpdateCampaignOnFullStart {}

UpdateCampaignOnProvinceArrival

No description available.

!UpdateCampaignOnProvinceArrival {}

WorkshopProgressPart

No description available.

  • string partPresetKey (nullable)
    • DataMultiLinkerPartPreset database key
  • int rating
  • int offset
!WorkshopProgressPart
partPresetKey: ''
rating: 1
offset: 1

WorkshopProgressSubsystem

No description available.

  • string subsystemBlueprintKey (nullable)
    • DataMultiLinkerSubsystem database key
  • int offset
!WorkshopProgressSubsystem
subsystemBlueprintKey: ''
offset: 1

PhantomBrigade.Functions.IOverworldTargetedFunction

ℹ️ Used to modify an overworld entity, similar to unit targeted functions. Signature void Run (OverworldEntity entityOverworld)
Classes inheriting from this interface: 40

Comment

No description available.

  • string comment (nullable)
!Comment
comment: ''

Log

No description available.

  • string message (nullable)
!Log
message: ''

ModifyMemory

No description available.

  • List<DataBlockMemoryChangeFloat> changes (nullable)
!ModifyMemory
changes:
- change: Offset
  key: ''
  value: 1
  valueFromMemory: false
  valueFromMemoryKey: ''

OverworldEntityBranch

No description available.

  • string key (nullable)
    • DataMultiLinkerOverworldFactionBranch database key
!OverworldEntityBranch
key: ''

OverworldEntityBranchOutsideProvince

No description available.

!OverworldEntityBranchOutsideProvince {}

OverworldEntityChance

No description available.

  • float chance
  • IOverworldTargetedFunction function (nullable)
!OverworldEntityChance
chance: 0.5
function: !Log
  message: ''

OverworldEntityChanceGroup

No description available.

  • float chance
  • List<IOverworldTargetedFunction> functions (nullable)
!OverworldEntityChanceGroup
chance: 0.5
functions: []

OverworldEntityChangeView

No description available.

  • string assetKey (nullable)
!OverworldEntityChangeView
assetKey: ''

OverworldEntityChecked

No description available.

  • List<IOverworldEntityValidationFunction> conditions (nullable)
  • List<IOverworldTargetedFunction> functions (nullable)
  • List<IOverworldTargetedFunction> functionsElse (nullable)
!OverworldEntityChecked
conditions: []
functions: []
functionsElse: []

OverworldEntityCombat

No description available.

!OverworldEntityCombat {}

OverworldEntityConceal

No description available.

!OverworldEntityConceal {}

OverworldEntityDestroy

No description available.

!OverworldEntityDestroy {}

OverworldEntityEffect

No description available.

  • DataBlockAsset asset (nullable)
!OverworldEntityEffect
asset:
  key: ''
  scale:
    x: 1
    y: 1
    z: 1

OverworldEntityEscalation

No description available.

  • bool offset
  • int level
!OverworldEntityEscalation
offset: false
level: 1

OverworldEntityExpiration

No description available.

  • float duration
!OverworldEntityExpiration
duration: 10

OverworldEntityFaction

No description available.

  • bool friendly
!OverworldEntityFaction
friendly: false

OverworldEntityGlobal

No description available.

  • IOverworldFunction function (nullable)
!OverworldEntityGlobal
function: !LogMessage
  data:
    textSector: ui_combat
    textKey: 
  colorKey: ''

OverworldEntityGlobalGroup

No description available.

  • List<IOverworldFunction> functions (nullable)
!OverworldEntityGlobalGroup
functions: []

OverworldEntityInteractionStart

No description available.

  • string key (nullable)
  • bool validated
!OverworldEntityInteractionStart
key: ''
validated: false

OverworldEntityLevelRelative

No description available.

  • int levelOffset
!OverworldEntityLevelRelative
levelOffset: 0

OverworldEntityMemoryFromQuest

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • bool offset
  • bool consume
  • bool questMain
  • string questKey (nullable)
!OverworldEntityMemoryFromQuest
memoryKey: ''
offset: false
consume: false
questMain: true
questKey: ''

OverworldEntityMemoryOffset

No description available.

  • int value
  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
!OverworldEntityMemoryOffset
value: 0
memoryKey: ''

OverworldEntityMemoryRemove

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
!OverworldEntityMemoryRemove
memoryKey: ''

OverworldEntityMemorySet

No description available.

  • int value
  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
!OverworldEntityMemorySet
value: 0
memoryKey: ''

OverworldEntityMemorySetRandom

No description available.

  • Vector2 valueRange
  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
!OverworldEntityMemorySetRandom
valueRange:
  x: 0
  y: 0
memoryKey: ''

OverworldEntityMemoryToQuest

No description available.

  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
  • bool offset
  • bool consume
  • bool questMain
  • string questKey (nullable)
!OverworldEntityMemoryToQuest
memoryKey: ''
offset: false
consume: false
questMain: true
questKey: ''

OverworldEntityMoveRandom

No description available.

  • float speed
  • Vector2 pointRange
  • PointDistancePriority pointPriority
!OverworldEntityMoveRandom
speed: 10
pointRange:
  x: 0
  y: 0
pointPriority: None

OverworldEntityMoveThroughSpawnGroup

No description available.

  • bool rawPath
  • int rawPathSubdivision
  • bool destroyOnEnd
  • float speed
  • string spawnGroupKey (nullable)
  • string indexMemoryKey (nullable)
!OverworldEntityMoveThroughSpawnGroup
rawPath: false
rawPathSubdivision: 2
destroyOnEnd: false
speed: 10
spawnGroupKey: ''
indexMemoryKey: ''

OverworldEntityMoveToBase

No description available.

  • float speed
  • Vector2 pointRange
!OverworldEntityMoveToBase
speed: 10
pointRange:
  x: 0
  y: 0

OverworldEntityProvinceCapture

No description available.

!OverworldEntityProvinceCapture {}

OverworldEntityProvinceCreatePoint

No description available.

  • string key (nullable)
!OverworldEntityProvinceCreatePoint
key: ''

OverworldEntityProvinceCreatePointBatch

No description available.

  • int pointLimit
  • SortedDictionary<string,bool> filter (nullable)
!OverworldEntityProvinceCreatePointBatch
pointLimit: 3
filter:
  '': false

OverworldEntityProvinceCreatePointFiltered

No description available.

  • SortedDictionary<string,bool> filter (nullable)
!OverworldEntityProvinceCreatePointFiltered
filter:
  '': false

OverworldEntityProvinceMemory

No description available.

  • List<DataBlockMemoryChangeFloat> changes (nullable)
!OverworldEntityProvinceMemory
changes:
- change: Offset
  key: ''
  value: 1
  valueFromMemory: false
  valueFromMemoryKey: ''

OverworldEntityQuestUnlink

No description available.

!OverworldEntityQuestUnlink {}

OverworldEntityRepeat

No description available.

  • int repeats
  • IOverworldTargetedFunction function (nullable)
!OverworldEntityRepeat
repeats: 1
function: !Log
  message: ''

OverworldEntityRepeatGroup

No description available.

  • int repeats
  • List<IOverworldTargetedFunction> functions (nullable)
!OverworldEntityRepeatGroup
repeats: 1
functions: []

OverworldEntityStun

No description available.

!OverworldEntityStun {}

OverworldEntityWeather

No description available.

  • float precipitation
  • float temperature
!OverworldEntityWeather
precipitation: 0
temperature: 1

OverworldTravelFrontline

No description available.

  • List<IOverworldFunction> functionsGlobal (nullable)
  • List<IOverworldTargetedFunction> functionsBase (nullable)
  • List<IOverworldTargetedFunction> functionsDestination (nullable)
!OverworldTravelFrontline
functionsGlobal: []
functionsBase: []
functionsDestination: []

PhantomBrigade.Functions.IOverworldUnitFunction

ℹ️ Used to execute arbitrary logic involving a specific unit in overworld. Signature void Run (PersistentEntity unitPersistent)
Classes inheriting from this interface: 5

OverworldUnitFrameDefectsOffset

No description available.

  • int value
!OverworldUnitFrameDefectsOffset
value: 0

OverworldUnitFrameDefectsSet

No description available.

  • int value
!OverworldUnitFrameDefectsSet
value: 0

OverworldUnitFrameIntegrityFromDifficulty

No description available.

  • string multiplier (nullable)
    • DataMultiLinkerDifficultySetting database key
  • float value
!OverworldUnitFrameIntegrityFromDifficulty
multiplier: ''
value: 0

OverworldUnitFrameIntegrityOffset

No description available.

  • float value
!OverworldUnitFrameIntegrityOffset
value: 0

OverworldUnitFrameIntegritySet

No description available.

  • float value
!OverworldUnitFrameIntegritySet
value: 0

PhantomBrigade.Functions.IOverworldIntValueFunction

ℹ️ Used to get a int value from an overworld unit: typically a memory, a stat or some constant. Signature int Resolve (OverworldEntity entityOverworld)
Classes inheriting from this interface: 19

OverworldIntValueCampaignLiberationCount

No description available.

!OverworldIntValueCampaignLiberationCount {}

OverworldIntValueCampaignProgress

No description available.

!OverworldIntValueCampaignProgress {}

OverworldIntValueCombatDestruction

No description available.

!OverworldIntValueCombatDestruction {}

OverworldIntValueCombatTurn

No description available.

!OverworldIntValueCombatTurn {}

OverworldIntValueCompletionArea

No description available.

  • string key (nullable)
!OverworldIntValueCompletionArea
key: ''

OverworldIntValueCompletionPreset

No description available.

  • string key (nullable)
!OverworldIntValueCompletionPreset
key: ''

OverworldIntValueCompletionScenario

No description available.

  • string key (nullable)
!OverworldIntValueCompletionScenario
key: ''

OverworldIntValueFixed

No description available.

  • int value
!OverworldIntValueFixed
value: 0

OverworldIntValueMemory

No description available.

  • string key (nullable)
!OverworldIntValueMemory
key: ''

OverworldIntValueMemoryAdv

No description available.

  • string key (nullable)
  • int valueFallback
  • List<IFloatOperation> operations (nullable)
!OverworldIntValueMemoryAdv
key: ''
valueFallback: 0
operations: []

OverworldIntValuePilotsAtBase

No description available.

  • List<IPilotValidationFunction> checks (nullable)
!OverworldIntValuePilotsAtBase
checks: []

OverworldIntValuePointInstances

No description available.

  • bool onlyCombat
  • bool onlyHostile
  • List<IOverworldEntityValidationFunction> checks (nullable)
!OverworldIntValuePointInstances
onlyCombat: false
onlyHostile: false
checks: []

OverworldIntValueProvinceCompletionPresetKey

No description available.

  • string key (nullable)
!OverworldIntValueProvinceCompletionPresetKey
key: ''

OverworldIntValueProvinceCompletionPresetTag

No description available.

  • string tag (nullable)
!OverworldIntValueProvinceCompletionPresetTag
tag: ''

OverworldIntValueProvinceMemory

No description available.

  • string key (nullable)
!OverworldIntValueProvinceMemory
key: ''

OverworldIntValueQuestMemory

No description available.

  • string questKey (nullable)
  • string memoryPrefix (nullable)
  • string memoryKey (nullable)
    • DataMultiLinkerOverworldMemory database key
!OverworldIntValueQuestMemory
questKey: ''
memoryPrefix: ''
memoryKey: ''

OverworldIntValueUnitsAtBase

No description available.

  • List<ICombatUnitValidationFunction> checks (nullable)
!OverworldIntValueUnitsAtBase
checks: []

OverworldIntValueUnitsInCombat

No description available.

  • List<ICombatUnitValidationFunction> checks (nullable)
!OverworldIntValueUnitsInCombat
checks: []

OverworldIntValueWorkshopQueue

No description available.

!OverworldIntValueWorkshopQueue {}

This wiki is a work in progress. Please make sure to check the built-in tutorials within the SDK or the modding articles on the game wiki to supplement this page. If you get stuck or experience a bug, please don't hesitate to ask questions in the #phantom-modding channel of the official Discord server. We can't wait to see what you create!

Clone this wiki locally