Overworld event functions are used in, as the name suggests, overworld events:
steps.*.functions (invoked on entry to an event step)
*: step keyoptions.*.functions (invoked on an option being selected)
*: step keyfunctions (invoked on an option being selected)The signature is Run (OverworldEntity target, DataContainerOverworldEvent eventData). If a function needs to fire earlier than others (e.g. relies on event data that would be discarded on event exit), implement IOverworldEventFunctionEarly interface (only relevant in a few special cases, check the codebase for details).
No general description available
string actionKey (nullable)
DataMultiLinkerOverworldAction database key!CancelAction
actionKey: ''
No general description available
string actorKey (nullable)string faction (nullable)!ChangeOverworldActorFaction
actorKey: ''
faction: ''
No general description available
string actorKey (nullable)string assetKey (nullable)!ChangeOverworldActorView
actorKey: ''
assetKey: ''
No general description available
string assetKey (nullable)!ChangeSelfView
assetKey: ''
No general description available
string faction (nullable)!ChangeTargetFaction
faction: ''
No general description available
string assetKey (nullable)!ChangeTargetView
assetKey: ''
No general description available
string actionKey (nullable)
DataMultiLinkerOverworldAction database key!CompleteAction
actionKey: ''
No general description available
DataBlockOverworldEventSpawnData spawnData (nullable)!CreateOverworldEntity
spawnData:
spawnLookupKey: spawn_01
locationProvider: SourceProvince
provinceKey: ''
spawnGroupKey: general
generationProfileCustom: false
generationProfileKey: ''
generationProfile:
siteTags:
'': false
faction: Invaders
memoryChanges:
- change: Offset
key: ''
value: 1
valueFromMemory: false
valueFromMemoryKey: ''
intel:
known: false
recognized: false
sensorContactSeconds: 0
flags:
isWarObjective: false
No general description available
string actorKey (nullable)!DeleteOverworldActor
actorKey: ''
No general description available
!DestroyTarget {}
No general description available
string message (nullable)!Log
message: ''
No general description available
List<DataBlockMemoryChangeFloat> changes (nullable)!ModifyMemoryBase
changes:
- change: Offset
key: ''
value: 1
valueFromMemory: false
valueFromMemoryKey: ''
No general description available
string actorKey (nullable)string personalityKey (nullable)
DataMultiLinkerPilotPersonality database keybool random!ModifyPilotActorPersonality
actorKey: ''
personalityKey: ''
random: false
No general description available
int offsetstring actorKey (nullable)bool allowDeath!ModifyPlayerPilotsHealth
offset: 0
actorKey: ''
allowDeath: false
No general description available
List<DataBlockResourceChange> resourceChanges (nullable)!ModifyResources
resourceChanges:
- key: ''
check: true
checkStrict: false
offset: true
value: 0
No general description available
List<DataBlockResourceChange> resourceChanges (nullable)!ModifyResourcesTarget
resourceChanges:
- key: ''
check: true
checkStrict: false
offset: true
value: 0
No general description available
int unitsfloat proportionfloat value!ModifyUnitHealth
units: 4
proportion: 0.5
value: 0.5
No general description available
string actorKey (nullable)int offset!OffsetOverworldActorThreat
actorKey: ''
offset: 0
No general description available
int offset!OffsetTargetThreat
offset: 0
No general description available
string key (nullable)
DataMultiLinkerCutsceneVideo database keybool instant!PlayCutscene
key: ''
instant: false
No general description available
string actorKey (nullable)!RevealOverworldActor
actorKey: ''
No general description available
DataBlockOverworldActionInstanceData data (nullable)!StartAction
data:
key: ''
owner: Base
ownerKey: ''
target: None
targetKey: ''
visible: true
durationOverride:
f: 0
durationMultiplier:
f: 0
No general description available
List<string> eventKeys (nullable)
DataMultiLinkerOverworldEvent database key!StartOverworldEvent
eventKeys:
- ''
No general description available
!StartRetreat {}
No general description available
string key (nullable)
DataMultiLinkerTutorial database key!StartTutorial
key: ''
No general description available
!StopBase {}
No general description available
!StunTarget {}
No general description available
string actorKey (nullable)!SummonPatrolActor
actorKey: ''
No general description available
!SummonPatrolTarget {}
No general description available
Vector3 position!TeleportBaseToPosition
position:
x: 0
y: 0
z: 0
No general description available
string blueprintKey (nullable)
DataMultiLinkerOverworldEntityBlueprint database keybool contactRange!TeleportBaseToType
blueprintKey: ''
contactRange: false
No general description available
string actionKey (nullable)
DataMultiLinkerOverworldAction database key!TerminateAction
actionKey: ''
No general description available
string blueprintKey (nullable)string rewardKey (nullable)int rewardCount!TransferBlueprintRewards
blueprintKey: ''
rewardKey: ''
rewardCount: 0
No general description available
string actorKey (nullable)!TransferPilotActorToTarget
actorKey: ''
No general description available
!TransferPilotsFromTarget {}
No general description available
!TransferTargetInventory {}
No general description available
string rewardKey (nullable)int rewardCount!TransferTargetRewards
rewardKey: ''
rewardCount: 0
No general description available
string key (nullable)!UnlockAchievement
key: ''
No general description available
string actorKey (nullable)!WarObjectiveOverworldActor
actorKey: ''