Module content.mission.mission_framework.mission_interface🔗

[Expand All] [Collapse All]
global record MissionInterface
  
enum GameScriptMode
    "GuideSystem"
    "Mission"
end
  
record CaptureParams
    gameScriptMode: GameScriptMode
end
  
record MissionSavegameUtil
    updateTownBuildings: function()
    updateMaintenanceCost: function()
    updateIndustriesPlayerOwned: function({Engine.Entity})
end
  
record MissionLegacyUtil
    currentVersion: integer
    updateLegacyState: function(MissionState)
end
  
record TaskVTable<S, P>
    getGenericParams: function(): GenericTaskParams
    getSpecificParams: function(): P
    onComplete: function(TaskContext<S, P>, MissionTaskApi)
    getTaskInfo: function(TaskContext<S, P>): TaskInfo
    getGuideInfo: function(TaskContext<S, P>): GuideInfo
    getTaskScript: function(): TaskScript<S, P>
    needTaskDeletion: function(): boolean
end
  
record TaskConfig
    getVTableScriptFn: string
    getVTableScriptFnParams: any
    uniqueKey: string
end
  
record TaskProgressData
    
record Counter
      current: integer
      max: integer
end
    
enum Style
      "Bad"
      "Good"
      "Neutral"
end
    iconPath: string
    cargoTypeRes: ResName
    bool: boolean
    text: string
    dynamicText: string
    counter: Counter
    percentage: number
    progressBar: boolean
    style: Style
    townRatingKey: TownRatingKey
    entity: Engine.Entity
end
  
record BootstrapDesc
    bootstrapScriptFn: string
    bootstrapScriptFnParams: string
end
  
record MissionSoundtrack
    
record Track
      name: string
      file: string
      enableRepeat: boolean
end
    
enum AddMode
      "add"
      "set"
end
    mode: AddMode
    enableRepeat: boolean
    tracks: {Track}
end
  
enum HighlightStyle
    "Circle"
    "Square"
end
  
record GenericTaskParams
    isBonusTask: boolean
    medals: {string : boolean}
    stars: {string : boolean}
    visibilityRules: {string : boolean}
    enableRules: {string : boolean}
    highlightRules: {string : HighlightStyle}
    omitNotificationOnComplete: boolean
    startSoundtrack: string
    soundtrack: MissionSoundtrack
    playlistOverride: ResName
    disableGuideSystem: boolean
    allowBuyVehicles: {string : integer}
    allowBuyVehicleGroups: {string : {{string}, integer}}
    lockedVehicles: {Engine.Entity}
    notificationFilter: {string : boolean}
    menuFilter: GameContext.Filters.MenuFilter
    vehicleFilter: GameContext.Filters.VehicleFilter
    selectorEntityFilter: {Engine.Entity : boolean}
    disableFeatures: {DisableFeatures : boolean}
    requiredTaskToComplete: string
    allowSimultaneousUiTasks: {string}
    financialReward: integer
    showInHistory: boolean
    showInGuiWithoutName: boolean
    suppressAutoOpen: boolean
end
  
record GenericTaskState
    uid: string
    config: TaskConfig
    acceptedTime: number
    spawnTime: number
    guiSpawnTime: number
    completedTime: number
    optionDecision: any
    progress: TaskProgressData
    subTasksProgress: {TaskProgressData}
    
record InstructionQueueEntry
      
enum InstructionState
        "Complete"
        "Pending"
        "Playing"
end
      instructionKey: string
      param: any
      state: InstructionState
end
    instructionsQueue: {InstructionQueueEntry}
end
  
record TaskState<TaskSpecificState, TaskSpecificParams>
    type: string
    specific: TaskSpecificState
    genericState: GenericTaskState
end
  
record MissionState
    tasks: {TaskState<<any type>, <any type>>}
    nextUid: integer
    version: integer
    bootTypes: {string : boolean}
    nonBulldozableEntities: {Engine.Entity : boolean}
    notificationFilter: {string : boolean}
    needPauseNotifications: boolean
    notificationsArePaused: boolean
    guiTimeSeconds: number
    isComplete: boolean
    lastCompletedTime: number
    isTutorialActive: boolean
end
  
record MissionTaskApi
    addTask: function(TaskConfig)
    sendTaskEvent: function(string, any)
    getTaskState: function(string): TaskState<<any type>, <any type>>
end
  
record MissionTaskReadOnlyApi
    getTaskState: function(string): TaskState<<any type>, <any type>>
    getLastCompletedTime: function(): number
    hasPendingGuide: function(): boolean
end
  
record DeferredTaskApi
    sendTaskEvent: function(string, any)
    getTaskState: function(string): TaskState<<any type>, <any type>>
end
  
record TaskDesc
    scriptFile: string
end
  
record PosRadius
    pos: {number}
    radius: number
end
  
record Marker
    key: string
    position: {number, number, number}
    entity: Engine.Entity
    type: string
    scaling: number
    isSelectable: boolean
    fireSelectEntity: boolean
end
  
record Zone
    key: string
    polygon: PolygonUtil.Polygon
    circle: MissionInterface.PosRadius
    draw: boolean
    getDrawColor: function(): Vec4f
    playAnimation: boolean
    prohibitBuilding: boolean
    zOffset: number
end
  
record GuideInfo
    
enum Position
      "Above"
      "Below"
      "Left"
      "Right"
end
    
enum FreePosition
      "High"
      "Low"
end
    
record Target
      idOrTag: string
      position: Position
end
    name: string
    text: string
    textGamepad: string
    image: string
    imageGamepad: string
    caption: string
    targets: {Target}
    free: boolean
    freePosition: FreePosition
end
  
record TaskInfo
    
record NotificationInput
      missionTaskKey: string
      financialReward: integer
end
    
record Paragraph
      text: string
      textMouse: string
      textGamepad: string
end
    
record Option
      text: string
      key: any
end
    
record LinkDef
      entity: Engine.Entity
      location: PosRadius
      getEntity: function(): Engine.Entity
      getLocation: function(): MissionInterface.PosRadius
end
    links: {string : LinkDef}
    
record SubTaskInfo
      name: string
      description: string
      progress: TaskProgressData
end
    name: string
    paragraphs: {Paragraph}
    options: {Option}
    camera: {LinkDef}
    progress: TaskProgressData
    subTasks: {SubTaskInfo}
    instructionData: MissionDialogueData.InstructionData
    makeInstructionData: function(string, any): MissionDialogueData.InstructionData
    showTaskInGuiWithoutName: boolean
end
  
record ProposalHandlerResult
    error: string
    warning: string
    priority: number
    isWhitelist: boolean
end
  
record TaskContext<TaskSpecificState, TaskSepcificParams>
    state: TaskSpecificState
    genericState: GenericTaskState
    params: TaskSepcificParams
    guiTimeSeconds: number
end
  
interface TaskScript<TaskSpecificState, TaskParams>
    taskScriptName: string
    disableGuideSystem: boolean
    handleLegacy: function(TaskContext<TaskSpecificState, TaskParams>, integer): TaskContext<TaskSpecificState, TaskParams>
    onSpawn: function(TaskParams, number): TaskSpecificState | nil
    onStart: function(TaskContext<TaskSpecificState, TaskParams>)
    getInfo: function(TaskContext<TaskSpecificState, TaskParams>): TaskInfo
    isComplete: function(TaskContext<TaskSpecificState, TaskParams>): boolean
    onComplete: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi)
    onUpdate: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskReadOnlyApi)
    handleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi): any
    guiHandleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): any
    guiUpdate: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi)
    guiHandleProposal: function(string, string, ProposalEventData, boolean, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): ProposalHandlerResult
    onGuiKickOff: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): boolean
    getMarkers: function(TaskContext<TaskSpecificState, TaskParams>): {Marker}
    getZones: function(TaskContext<TaskSpecificState, TaskParams>): {Zone}
    getNonBulldozableEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity}
    getProtectedEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}
    getSelectorEntityFilter: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : boolean}
    getVisibilityRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
    getEnableRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
    getHighlightRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : MissionInterface.HighlightStyle}
end
end

Category: globals🔗

MissionInterface🔗

[Expand All] [Collapse All]
global record MissionInterface
  
enum GameScriptMode
    "GuideSystem"
    "Mission"
end
  
record CaptureParams
    gameScriptMode: GameScriptMode
end
  
record MissionSavegameUtil
    updateTownBuildings: function()
    updateMaintenanceCost: function()
    updateIndustriesPlayerOwned: function({Engine.Entity})
end
  
record MissionLegacyUtil
    currentVersion: integer
    updateLegacyState: function(MissionState)
end
  
record TaskVTable<S, P>
    getGenericParams: function(): GenericTaskParams
    getSpecificParams: function(): P
    onComplete: function(TaskContext<S, P>, MissionTaskApi)
    getTaskInfo: function(TaskContext<S, P>): TaskInfo
    getGuideInfo: function(TaskContext<S, P>): GuideInfo
    getTaskScript: function(): TaskScript<S, P>
    needTaskDeletion: function(): boolean
end
  
record TaskConfig
    getVTableScriptFn: string
    getVTableScriptFnParams: any
    uniqueKey: string
end
  
record TaskProgressData
    
record Counter
      current: integer
      max: integer
end
    
enum Style
      "Bad"
      "Good"
      "Neutral"
end
    iconPath: string
    cargoTypeRes: ResName
    bool: boolean
    text: string
    dynamicText: string
    counter: Counter
    percentage: number
    progressBar: boolean
    style: Style
    townRatingKey: TownRatingKey
    entity: Engine.Entity
end
  
record BootstrapDesc
    bootstrapScriptFn: string
    bootstrapScriptFnParams: string
end
  
record MissionSoundtrack
    
record Track
      name: string
      file: string
      enableRepeat: boolean
end
    
enum AddMode
      "add"
      "set"
end
    mode: AddMode
    enableRepeat: boolean
    tracks: {Track}
end
  
enum HighlightStyle
    "Circle"
    "Square"
end
  
record GenericTaskParams
    isBonusTask: boolean
    medals: {string : boolean}
    stars: {string : boolean}
    visibilityRules: {string : boolean}
    enableRules: {string : boolean}
    highlightRules: {string : HighlightStyle}
    omitNotificationOnComplete: boolean
    startSoundtrack: string
    soundtrack: MissionSoundtrack
    playlistOverride: ResName
    disableGuideSystem: boolean
    allowBuyVehicles: {string : integer}
    allowBuyVehicleGroups: {string : {{string}, integer}}
    lockedVehicles: {Engine.Entity}
    notificationFilter: {string : boolean}
    menuFilter: GameContext.Filters.MenuFilter
    vehicleFilter: GameContext.Filters.VehicleFilter
    selectorEntityFilter: {Engine.Entity : boolean}
    disableFeatures: {DisableFeatures : boolean}
    requiredTaskToComplete: string
    allowSimultaneousUiTasks: {string}
    financialReward: integer
    showInHistory: boolean
    showInGuiWithoutName: boolean
    suppressAutoOpen: boolean
end
  
record GenericTaskState
    uid: string
    config: TaskConfig
    acceptedTime: number
    spawnTime: number
    guiSpawnTime: number
    completedTime: number
    optionDecision: any
    progress: TaskProgressData
    subTasksProgress: {TaskProgressData}
    
record InstructionQueueEntry
      
enum InstructionState
        "Complete"
        "Pending"
        "Playing"
end
      instructionKey: string
      param: any
      state: InstructionState
end
    instructionsQueue: {InstructionQueueEntry}
end
  
record TaskState<TaskSpecificState, TaskSpecificParams>
    type: string
    specific: TaskSpecificState
    genericState: GenericTaskState
end
  
record MissionState
    tasks: {TaskState<<any type>, <any type>>}
    nextUid: integer
    version: integer
    bootTypes: {string : boolean}
    nonBulldozableEntities: {Engine.Entity : boolean}
    notificationFilter: {string : boolean}
    needPauseNotifications: boolean
    notificationsArePaused: boolean
    guiTimeSeconds: number
    isComplete: boolean
    lastCompletedTime: number
    isTutorialActive: boolean
end
  
record MissionTaskApi
    addTask: function(TaskConfig)
    sendTaskEvent: function(string, any)
    getTaskState: function(string): TaskState<<any type>, <any type>>
end
  
record MissionTaskReadOnlyApi
    getTaskState: function(string): TaskState<<any type>, <any type>>
    getLastCompletedTime: function(): number
    hasPendingGuide: function(): boolean
end
  
record DeferredTaskApi
    sendTaskEvent: function(string, any)
    getTaskState: function(string): TaskState<<any type>, <any type>>
end
  
record TaskDesc
    scriptFile: string
end
  
record PosRadius
    pos: {number}
    radius: number
end
  
record Marker
    key: string
    position: {number, number, number}
    entity: Engine.Entity
    type: string
    scaling: number
    isSelectable: boolean
    fireSelectEntity: boolean
end
  
record Zone
    key: string
    polygon: PolygonUtil.Polygon
    circle: MissionInterface.PosRadius
    draw: boolean
    getDrawColor: function(): Vec4f
    playAnimation: boolean
    prohibitBuilding: boolean
    zOffset: number
end
  
record GuideInfo
    
enum Position
      "Above"
      "Below"
      "Left"
      "Right"
end
    
enum FreePosition
      "High"
      "Low"
end
    
record Target
      idOrTag: string
      position: Position
end
    name: string
    text: string
    textGamepad: string
    image: string
    imageGamepad: string
    caption: string
    targets: {Target}
    free: boolean
    freePosition: FreePosition
end
  
record TaskInfo
    
record NotificationInput
      missionTaskKey: string
      financialReward: integer
end
    
record Paragraph
      text: string
      textMouse: string
      textGamepad: string
end
    
record Option
      text: string
      key: any
end
    
record LinkDef
      entity: Engine.Entity
      location: PosRadius
      getEntity: function(): Engine.Entity
      getLocation: function(): MissionInterface.PosRadius
end
    links: {string : LinkDef}
    
record SubTaskInfo
      name: string
      description: string
      progress: TaskProgressData
end
    name: string
    paragraphs: {Paragraph}
    options: {Option}
    camera: {LinkDef}
    progress: TaskProgressData
    subTasks: {SubTaskInfo}
    instructionData: MissionDialogueData.InstructionData
    makeInstructionData: function(string, any): MissionDialogueData.InstructionData
    showTaskInGuiWithoutName: boolean
end
  
record ProposalHandlerResult
    error: string
    warning: string
    priority: number
    isWhitelist: boolean
end
  
record TaskContext<TaskSpecificState, TaskSepcificParams>
    state: TaskSpecificState
    genericState: GenericTaskState
    params: TaskSepcificParams
    guiTimeSeconds: number
end
  
interface TaskScript<TaskSpecificState, TaskParams>
    taskScriptName: string
    disableGuideSystem: boolean
    handleLegacy: function(TaskContext<TaskSpecificState, TaskParams>, integer): TaskContext<TaskSpecificState, TaskParams>
    onSpawn: function(TaskParams, number): TaskSpecificState | nil
    onStart: function(TaskContext<TaskSpecificState, TaskParams>)
    getInfo: function(TaskContext<TaskSpecificState, TaskParams>): TaskInfo
    isComplete: function(TaskContext<TaskSpecificState, TaskParams>): boolean
    onComplete: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi)
    onUpdate: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskReadOnlyApi)
    handleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi): any
    guiHandleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): any
    guiUpdate: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi)
    guiHandleProposal: function(string, string, ProposalEventData, boolean, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): ProposalHandlerResult
    onGuiKickOff: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): boolean
    getMarkers: function(TaskContext<TaskSpecificState, TaskParams>): {Marker}
    getZones: function(TaskContext<TaskSpecificState, TaskParams>): {Zone}
    getNonBulldozableEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity}
    getProtectedEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}
    getSelectorEntityFilter: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : boolean}
    getVisibilityRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
    getEnableRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
    getHighlightRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : MissionInterface.HighlightStyle}
end
end

MissionInterface.GameScriptMode🔗

enum MissionInterface.GameScriptMode
  "GuideSystem"
  "Mission"
end

MissionInterface.GameScriptMode."GuideSystem"🔗

MissionInterface.GameScriptMode."Mission"🔗

MissionInterface.CaptureParams🔗

record MissionInterface.CaptureParams
  gameScriptMode: GameScriptMode
end

MissionInterface.CaptureParams.gameScriptMode🔗

MissionInterface.CaptureParams.gameScriptMode: GameScriptMode

MissionInterface.MissionSavegameUtil🔗

record MissionInterface.MissionSavegameUtil
  updateTownBuildings: function()
  updateMaintenanceCost: function()
  updateIndustriesPlayerOwned: function({Engine.Entity})
end

MissionInterface.MissionSavegameUtil.updateTownBuildings🔗

function MissionInterface.MissionSavegameUtil.updateTownBuildings()

MissionInterface.MissionSavegameUtil.updateMaintenanceCost🔗

function MissionInterface.MissionSavegameUtil.updateMaintenanceCost()

MissionInterface.MissionSavegameUtil.updateIndustriesPlayerOwned🔗

function MissionInterface.MissionSavegameUtil.updateIndustriesPlayerOwned({Engine.Entity})

Parameters

• {Engine.Entity}

MissionInterface.MissionLegacyUtil🔗

record MissionInterface.MissionLegacyUtil
  currentVersion: integer
  updateLegacyState: function(MissionState)
end

MissionInterface.MissionLegacyUtil.currentVersion🔗

MissionInterface.MissionLegacyUtil.currentVersion: integer

MissionInterface.MissionLegacyUtil.updateLegacyState🔗

function MissionInterface.MissionLegacyUtil.updateLegacyState(MissionState)

Parameters

• MissionState

MissionInterface.TaskVTable🔗

record MissionInterface.TaskVTable<S, P>
  getGenericParams: function(): GenericTaskParams
  getSpecificParams: function(): P
  onComplete: function(TaskContext<S, P>, MissionTaskApi)
  getTaskInfo: function(TaskContext<S, P>): TaskInfo
  getGuideInfo: function(TaskContext<S, P>): GuideInfo
  getTaskScript: function(): TaskScript<S, P>
  needTaskDeletion: function(): boolean
end

Type Parameters

• S
• P

MissionInterface.TaskVTable.getGenericParams🔗

function MissionInterface.TaskVTable.getGenericParams(): GenericTaskParams

Returns

1. GenericTaskParams

MissionInterface.TaskVTable.getSpecificParams🔗

function MissionInterface.TaskVTable.getSpecificParams(): P

Returns

1. P

MissionInterface.TaskVTable.onComplete🔗

function MissionInterface.TaskVTable.onComplete(TaskContext<S, P>, MissionTaskApi)

Parameters

• TaskContext<S, P>
• MissionTaskApi

MissionInterface.TaskVTable.getTaskInfo🔗

function MissionInterface.TaskVTable.getTaskInfo(TaskContext<S, P>): TaskInfo

Parameters

• TaskContext<S, P>

Returns

1. TaskInfo

MissionInterface.TaskVTable.getGuideInfo🔗

function MissionInterface.TaskVTable.getGuideInfo(TaskContext<S, P>): GuideInfo

Parameters

• TaskContext<S, P>

Returns

1. GuideInfo

MissionInterface.TaskVTable.getTaskScript🔗

function MissionInterface.TaskVTable.getTaskScript(): TaskScript<S, P>

Returns

1. TaskScript<S, P>

MissionInterface.TaskVTable.needTaskDeletion🔗

function MissionInterface.TaskVTable.needTaskDeletion(): boolean

Returns

1. boolean

MissionInterface.TaskConfig🔗

record MissionInterface.TaskConfig
  getVTableScriptFn: string
  getVTableScriptFnParams: any
  uniqueKey: string
end

MissionInterface.TaskConfig.getVTableScriptFn🔗

MissionInterface.TaskConfig.getVTableScriptFn: string

MissionInterface.TaskConfig.getVTableScriptFnParams🔗

MissionInterface.TaskConfig.getVTableScriptFnParams: any

MissionInterface.TaskConfig.uniqueKey🔗

MissionInterface.TaskConfig.uniqueKey: string

MissionInterface.TaskProgressData🔗

[Expand All] [Collapse All]
record MissionInterface.TaskProgressData
  
record Counter
    current: integer
    max: integer
end
  
enum Style
    "Bad"
    "Good"
    "Neutral"
end
  iconPath: string
  cargoTypeRes: ResName
  bool: boolean
  text: string
  dynamicText: string
  counter: Counter
  percentage: number
  progressBar: boolean
  style: Style
  townRatingKey: TownRatingKey
  entity: Engine.Entity
end

MissionInterface.TaskProgressData.Counter🔗

record MissionInterface.TaskProgressData.Counter
  current: integer
  max: integer
end

MissionInterface.TaskProgressData.Counter.current🔗

MissionInterface.TaskProgressData.Counter.current: integer

MissionInterface.TaskProgressData.Counter.max🔗

MissionInterface.TaskProgressData.Counter.max: integer

MissionInterface.TaskProgressData.Style🔗

enum MissionInterface.TaskProgressData.Style
  "Bad"
  "Good"
  "Neutral"
end

MissionInterface.TaskProgressData.Style."Bad"🔗

MissionInterface.TaskProgressData.Style."Good"🔗

MissionInterface.TaskProgressData.Style."Neutral"🔗

MissionInterface.TaskProgressData.iconPath🔗

MissionInterface.TaskProgressData.iconPath: string

MissionInterface.TaskProgressData.cargoTypeRes🔗

MissionInterface.TaskProgressData.cargoTypeRes: ResName

MissionInterface.TaskProgressData.bool🔗

MissionInterface.TaskProgressData.bool: boolean

MissionInterface.TaskProgressData.text🔗

MissionInterface.TaskProgressData.text: string

MissionInterface.TaskProgressData.dynamicText🔗

MissionInterface.TaskProgressData.dynamicText: string

MissionInterface.TaskProgressData.counter🔗

MissionInterface.TaskProgressData.counter: Counter

MissionInterface.TaskProgressData.percentage🔗

MissionInterface.TaskProgressData.percentage: number

MissionInterface.TaskProgressData.progressBar🔗

MissionInterface.TaskProgressData.progressBar: boolean

MissionInterface.TaskProgressData.style🔗

MissionInterface.TaskProgressData.style: Style

MissionInterface.TaskProgressData.townRatingKey🔗

MissionInterface.TaskProgressData.townRatingKey: TownRatingKey

MissionInterface.TaskProgressData.entity🔗

MissionInterface.TaskProgressData.entity: Engine.Entity

MissionInterface.BootstrapDesc🔗

record MissionInterface.BootstrapDesc
  bootstrapScriptFn: string
  bootstrapScriptFnParams: string
end

MissionInterface.BootstrapDesc.bootstrapScriptFn🔗

MissionInterface.BootstrapDesc.bootstrapScriptFn: string

MissionInterface.BootstrapDesc.bootstrapScriptFnParams🔗

MissionInterface.BootstrapDesc.bootstrapScriptFnParams: string

MissionInterface.MissionSoundtrack🔗

[Expand All] [Collapse All]
record MissionInterface.MissionSoundtrack
  
record Track
    name: string
    file: string
    enableRepeat: boolean
end
  
enum AddMode
    "add"
    "set"
end
  mode: AddMode
  enableRepeat: boolean
  tracks: {Track}
end

MissionInterface.MissionSoundtrack.Track🔗

record MissionInterface.MissionSoundtrack.Track
  name: string
  file: string
  enableRepeat: boolean
end

describe a single track of the tracklist

MissionInterface.MissionSoundtrack.Track.name🔗

MissionInterface.MissionSoundtrack.Track.name: string

the name of the track, this is optional

MissionInterface.MissionSoundtrack.Track.file🔗

MissionInterface.MissionSoundtrack.Track.file: string

the path to the track file, this is required

MissionInterface.MissionSoundtrack.Track.enableRepeat🔗

MissionInterface.MissionSoundtrack.Track.enableRepeat: boolean

when true, repeats a single track
default: "false"

MissionInterface.MissionSoundtrack.AddMode🔗

enum MissionInterface.MissionSoundtrack.AddMode
  "add"
  "set"
end

a mode that controls how a tracklist is added to the music player

MissionInterface.MissionSoundtrack.AddMode."add"🔗

pushes the given tracklist on top of the current tracklist; when the tracklist ends, resumes the previous tracklist.

MissionInterface.MissionSoundtrack.AddMode."set"🔗

replaces the current tracklist with the given tracklist.

MissionInterface.MissionSoundtrack.mode🔗

MissionInterface.MissionSoundtrack.mode: AddMode

the mode to use when adding the tracklist to the music player
default: "set"

MissionInterface.MissionSoundtrack.enableRepeat🔗

MissionInterface.MissionSoundtrack.enableRepeat: boolean

when true, repeats the entire tracklist
default: "true"

MissionInterface.MissionSoundtrack.tracks🔗

MissionInterface.MissionSoundtrack.tracks: {Track}

the list of tracks to play

MissionInterface.HighlightStyle🔗

enum MissionInterface.HighlightStyle
  "Circle"
  "Square"
end

MissionInterface.HighlightStyle."Circle"🔗

MissionInterface.HighlightStyle."Square"🔗

MissionInterface.GenericTaskParams🔗

record MissionInterface.GenericTaskParams
  isBonusTask: boolean
  medals: {string : boolean}
  stars: {string : boolean}
  visibilityRules: {string : boolean}
  enableRules: {string : boolean}
  highlightRules: {string : HighlightStyle}
  omitNotificationOnComplete: boolean
  startSoundtrack: string
  soundtrack: MissionSoundtrack
  playlistOverride: ResName
  disableGuideSystem: boolean
  allowBuyVehicles: {string : integer}
  allowBuyVehicleGroups: {string : {{string}, integer}}
  lockedVehicles: {Engine.Entity}
  notificationFilter: {string : boolean}
  menuFilter: GameContext.Filters.MenuFilter
  vehicleFilter: GameContext.Filters.VehicleFilter
  selectorEntityFilter: {Engine.Entity : boolean}
  disableFeatures: {DisableFeatures : boolean}
  requiredTaskToComplete: string
  allowSimultaneousUiTasks: {string}
  financialReward: integer
  showInHistory: boolean
  showInGuiWithoutName: boolean
  suppressAutoOpen: boolean
end

MissionInterface.GenericTaskParams.isBonusTask🔗

MissionInterface.GenericTaskParams.isBonusTask: boolean

MissionInterface.GenericTaskParams.medals🔗

MissionInterface.GenericTaskParams.medals: {string : boolean}

MissionInterface.GenericTaskParams.stars🔗

MissionInterface.GenericTaskParams.stars: {string : boolean}

MissionInterface.GenericTaskParams.visibilityRules🔗

MissionInterface.GenericTaskParams.visibilityRules: {string : boolean}

MissionInterface.GenericTaskParams.enableRules🔗

MissionInterface.GenericTaskParams.enableRules: {string : boolean}

MissionInterface.GenericTaskParams.highlightRules🔗

MissionInterface.GenericTaskParams.highlightRules: {string : HighlightStyle}

MissionInterface.GenericTaskParams.omitNotificationOnComplete🔗

MissionInterface.GenericTaskParams.omitNotificationOnComplete: boolean

MissionInterface.GenericTaskParams.startSoundtrack🔗

MissionInterface.GenericTaskParams.startSoundtrack: string

MissionInterface.GenericTaskParams.soundtrack🔗

MissionInterface.GenericTaskParams.soundtrack: MissionSoundtrack

MissionInterface.GenericTaskParams.playlistOverride🔗

MissionInterface.GenericTaskParams.playlistOverride: ResName

MissionInterface.GenericTaskParams.disableGuideSystem🔗

MissionInterface.GenericTaskParams.disableGuideSystem: boolean

MissionInterface.GenericTaskParams.allowBuyVehicles🔗

MissionInterface.GenericTaskParams.allowBuyVehicles: {string : integer}

MissionInterface.GenericTaskParams.allowBuyVehicleGroups🔗

MissionInterface.GenericTaskParams.allowBuyVehicleGroups: {string : {{string}, integer}}

MissionInterface.GenericTaskParams.lockedVehicles🔗

MissionInterface.GenericTaskParams.lockedVehicles: {Engine.Entity}

MissionInterface.GenericTaskParams.notificationFilter🔗

MissionInterface.GenericTaskParams.notificationFilter: {string : boolean}

MissionInterface.GenericTaskParams.menuFilter🔗

MissionInterface.GenericTaskParams.menuFilter: GameContext.Filters.MenuFilter

MissionInterface.GenericTaskParams.vehicleFilter🔗

MissionInterface.GenericTaskParams.vehicleFilter: GameContext.Filters.VehicleFilter

MissionInterface.GenericTaskParams.selectorEntityFilter🔗

MissionInterface.GenericTaskParams.selectorEntityFilter: {Engine.Entity : boolean}

MissionInterface.GenericTaskParams.disableFeatures🔗

MissionInterface.GenericTaskParams.disableFeatures: {DisableFeatures : boolean}

MissionInterface.GenericTaskParams.requiredTaskToComplete🔗

MissionInterface.GenericTaskParams.requiredTaskToComplete: string

MissionInterface.GenericTaskParams.allowSimultaneousUiTasks🔗

MissionInterface.GenericTaskParams.allowSimultaneousUiTasks: {string}

MissionInterface.GenericTaskParams.financialReward🔗

MissionInterface.GenericTaskParams.financialReward: integer

MissionInterface.GenericTaskParams.showInHistory🔗

MissionInterface.GenericTaskParams.showInHistory: boolean

MissionInterface.GenericTaskParams.showInGuiWithoutName🔗

MissionInterface.GenericTaskParams.showInGuiWithoutName: boolean

MissionInterface.GenericTaskParams.suppressAutoOpen🔗

MissionInterface.GenericTaskParams.suppressAutoOpen: boolean

MissionInterface.GenericTaskState🔗

[Expand All] [Collapse All]
record MissionInterface.GenericTaskState
  uid: string
  config: TaskConfig
  acceptedTime: number
  spawnTime: number
  guiSpawnTime: number
  completedTime: number
  optionDecision: any
  progress: TaskProgressData
  subTasksProgress: {TaskProgressData}
  
record InstructionQueueEntry
    
enum InstructionState
      "Complete"
      "Pending"
      "Playing"
end
    instructionKey: string
    param: any
    state: InstructionState
end
  instructionsQueue: {InstructionQueueEntry}
end

MissionInterface.GenericTaskState.uid🔗

MissionInterface.GenericTaskState.uid: string

MissionInterface.GenericTaskState.config🔗

MissionInterface.GenericTaskState.config: TaskConfig

MissionInterface.GenericTaskState.acceptedTime🔗

MissionInterface.GenericTaskState.acceptedTime: number

MissionInterface.GenericTaskState.spawnTime🔗

MissionInterface.GenericTaskState.spawnTime: number

MissionInterface.GenericTaskState.guiSpawnTime🔗

MissionInterface.GenericTaskState.guiSpawnTime: number

MissionInterface.GenericTaskState.completedTime🔗

MissionInterface.GenericTaskState.completedTime: number

MissionInterface.GenericTaskState.optionDecision🔗

MissionInterface.GenericTaskState.optionDecision: any

MissionInterface.GenericTaskState.progress🔗

MissionInterface.GenericTaskState.progress: TaskProgressData

MissionInterface.GenericTaskState.subTasksProgress🔗

MissionInterface.GenericTaskState.subTasksProgress: {TaskProgressData}

MissionInterface.GenericTaskState.InstructionQueueEntry🔗

[Expand All] [Collapse All]
record MissionInterface.GenericTaskState.InstructionQueueEntry
  
enum InstructionState
    "Complete"
    "Pending"
    "Playing"
end
  instructionKey: string
  param: any
  state: InstructionState
end

MissionInterface.GenericTaskState.InstructionQueueEntry.InstructionState🔗

enum MissionInterface.GenericTaskState.InstructionQueueEntry.InstructionState
  "Complete"
  "Pending"
  "Playing"
end

MissionInterface.GenericTaskState.InstructionQueueEntry.InstructionState."Complete"🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.InstructionState."Pending"🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.InstructionState."Playing"🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.instructionKey🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.instructionKey: string

MissionInterface.GenericTaskState.InstructionQueueEntry.param🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.param: any

MissionInterface.GenericTaskState.InstructionQueueEntry.state🔗

MissionInterface.GenericTaskState.InstructionQueueEntry.state: InstructionState

MissionInterface.GenericTaskState.instructionsQueue🔗

MissionInterface.GenericTaskState.instructionsQueue: {InstructionQueueEntry}

MissionInterface.TaskState🔗

record MissionInterface.TaskState<TaskSpecificState, TaskSpecificParams>
  type: string
  specific: TaskSpecificState
  genericState: GenericTaskState
end

Type Parameters

• TaskSpecificState
• TaskSpecificParams

MissionInterface.TaskState.type🔗

MissionInterface.TaskState.type: string

MissionInterface.TaskState.specific🔗

MissionInterface.TaskState.specific: TaskSpecificState

MissionInterface.TaskState.genericState🔗

MissionInterface.TaskState.genericState: GenericTaskState

MissionInterface.MissionState🔗

record MissionInterface.MissionState
  tasks: {TaskState<<any type>, <any type>>}
  nextUid: integer
  version: integer
  bootTypes: {string : boolean}
  nonBulldozableEntities: {Engine.Entity : boolean}
  notificationFilter: {string : boolean}
  needPauseNotifications: boolean
  notificationsArePaused: boolean
  guiTimeSeconds: number
  isComplete: boolean
  lastCompletedTime: number
  isTutorialActive: boolean
end

MissionInterface.MissionState.tasks🔗

MissionInterface.MissionState.tasks: {TaskState<<any type>, <any type>>}

MissionInterface.MissionState.nextUid🔗

MissionInterface.MissionState.nextUid: integer

MissionInterface.MissionState.version🔗

MissionInterface.MissionState.version: integer

MissionInterface.MissionState.bootTypes🔗

MissionInterface.MissionState.bootTypes: {string : boolean}

MissionInterface.MissionState.nonBulldozableEntities🔗

MissionInterface.MissionState.nonBulldozableEntities: {Engine.Entity : boolean}

MissionInterface.MissionState.notificationFilter🔗

MissionInterface.MissionState.notificationFilter: {string : boolean}

MissionInterface.MissionState.needPauseNotifications🔗

MissionInterface.MissionState.needPauseNotifications: boolean

MissionInterface.MissionState.notificationsArePaused🔗

MissionInterface.MissionState.notificationsArePaused: boolean

MissionInterface.MissionState.guiTimeSeconds🔗

MissionInterface.MissionState.guiTimeSeconds: number

MissionInterface.MissionState.isComplete🔗

MissionInterface.MissionState.isComplete: boolean

MissionInterface.MissionState.lastCompletedTime🔗

MissionInterface.MissionState.lastCompletedTime: number

MissionInterface.MissionState.isTutorialActive🔗

MissionInterface.MissionState.isTutorialActive: boolean

MissionInterface.MissionTaskApi🔗

record MissionInterface.MissionTaskApi
  addTask: function(TaskConfig)
  sendTaskEvent: function(string, any)
  getTaskState: function(string): TaskState<<any type>, <any type>>
end

MissionInterface.MissionTaskApi.addTask🔗

function MissionInterface.MissionTaskApi.addTask(TaskConfig)

Parameters

• TaskConfig

MissionInterface.MissionTaskApi.sendTaskEvent🔗

function MissionInterface.MissionTaskApi.sendTaskEvent(string, any)

Parameters

• string
• any

MissionInterface.MissionTaskApi.getTaskState🔗

function MissionInterface.MissionTaskApi.getTaskState(string): TaskState<<any type>, <any type>>

Parameters

• string

Returns

1. TaskState<<any type>, <any type>>

MissionInterface.MissionTaskReadOnlyApi🔗

record MissionInterface.MissionTaskReadOnlyApi
  getTaskState: function(string): TaskState<<any type>, <any type>>
  getLastCompletedTime: function(): number
  hasPendingGuide: function(): boolean
end

MissionInterface.MissionTaskReadOnlyApi.getTaskState🔗

function MissionInterface.MissionTaskReadOnlyApi.getTaskState(string): TaskState<<any type>, <any type>>

Parameters

• string

Returns

1. TaskState<<any type>, <any type>>

MissionInterface.MissionTaskReadOnlyApi.getLastCompletedTime🔗

function MissionInterface.MissionTaskReadOnlyApi.getLastCompletedTime(): number

Returns

1. number

MissionInterface.MissionTaskReadOnlyApi.hasPendingGuide🔗

function MissionInterface.MissionTaskReadOnlyApi.hasPendingGuide(): boolean

Returns

1. boolean

MissionInterface.DeferredTaskApi🔗

record MissionInterface.DeferredTaskApi
  sendTaskEvent: function(string, any)
  getTaskState: function(string): TaskState<<any type>, <any type>>
end

MissionInterface.DeferredTaskApi.sendTaskEvent🔗

function MissionInterface.DeferredTaskApi.sendTaskEvent(string, any)

Parameters

• string
• any

MissionInterface.DeferredTaskApi.getTaskState🔗

function MissionInterface.DeferredTaskApi.getTaskState(string): TaskState<<any type>, <any type>>

Parameters

• string

Returns

1. TaskState<<any type>, <any type>>

MissionInterface.TaskDesc🔗

record MissionInterface.TaskDesc
  scriptFile: string
end

MissionInterface.TaskDesc.scriptFile🔗

MissionInterface.TaskDesc.scriptFile: string

MissionInterface.PosRadius🔗

record MissionInterface.PosRadius
  pos: {number}
  radius: number
end

MissionInterface.PosRadius.pos🔗

MissionInterface.PosRadius.pos: {number}

MissionInterface.PosRadius.radius🔗

MissionInterface.PosRadius.radius: number

MissionInterface.Marker🔗

record MissionInterface.Marker
  key: string
  position: {number, number, number}
  entity: Engine.Entity
  type: string
  scaling: number
  isSelectable: boolean
  fireSelectEntity: boolean
end

MissionInterface.Marker.key🔗

MissionInterface.Marker.key: string

MissionInterface.Marker.position🔗

MissionInterface.Marker.position: {number, number, number}

MissionInterface.Marker.entity🔗

MissionInterface.Marker.entity: Engine.Entity

MissionInterface.Marker.type🔗

MissionInterface.Marker.type: string

MissionInterface.Marker.scaling🔗

MissionInterface.Marker.scaling: number

MissionInterface.Marker.isSelectable🔗

MissionInterface.Marker.isSelectable: boolean

MissionInterface.Marker.fireSelectEntity🔗

MissionInterface.Marker.fireSelectEntity: boolean

MissionInterface.Zone🔗

record MissionInterface.Zone
  key: string
  polygon: PolygonUtil.Polygon
  circle: MissionInterface.PosRadius
  draw: boolean
  getDrawColor: function(): Vec4f
  playAnimation: boolean
  prohibitBuilding: boolean
  zOffset: number
end

MissionInterface.Zone.key🔗

MissionInterface.Zone.key: string

MissionInterface.Zone.polygon🔗

MissionInterface.Zone.polygon: PolygonUtil.Polygon

MissionInterface.Zone.circle🔗

MissionInterface.Zone.circle: MissionInterface.PosRadius

MissionInterface.Zone.draw🔗

MissionInterface.Zone.draw: boolean

MissionInterface.Zone.getDrawColor🔗

function MissionInterface.Zone.getDrawColor(): Vec4f

Returns

1. Vec4f

MissionInterface.Zone.playAnimation🔗

MissionInterface.Zone.playAnimation: boolean

MissionInterface.Zone.prohibitBuilding🔗

MissionInterface.Zone.prohibitBuilding: boolean

MissionInterface.Zone.zOffset🔗

MissionInterface.Zone.zOffset: number

MissionInterface.GuideInfo🔗

[Expand All] [Collapse All]
record MissionInterface.GuideInfo
  
enum Position
    "Above"
    "Below"
    "Left"
    "Right"
end
  
enum FreePosition
    "High"
    "Low"
end
  
record Target
    idOrTag: string
    position: Position
end
  name: string
  text: string
  textGamepad: string
  image: string
  imageGamepad: string
  caption: string
  targets: {Target}
  free: boolean
  freePosition: FreePosition
end

MissionInterface.GuideInfo.Position🔗

enum MissionInterface.GuideInfo.Position
  "Above"
  "Below"
  "Left"
  "Right"
end

MissionInterface.GuideInfo.Position."Above"🔗

MissionInterface.GuideInfo.Position."Below"🔗

MissionInterface.GuideInfo.Position."Left"🔗

MissionInterface.GuideInfo.Position."Right"🔗

MissionInterface.GuideInfo.FreePosition🔗

enum MissionInterface.GuideInfo.FreePosition
  "High"
  "Low"
end

MissionInterface.GuideInfo.FreePosition."High"🔗

MissionInterface.GuideInfo.FreePosition."Low"🔗

MissionInterface.GuideInfo.Target🔗

record MissionInterface.GuideInfo.Target
  idOrTag: string
  position: Position
end

MissionInterface.GuideInfo.Target.idOrTag🔗

MissionInterface.GuideInfo.Target.idOrTag: string

MissionInterface.GuideInfo.Target.position🔗

MissionInterface.GuideInfo.Target.position: Position

MissionInterface.GuideInfo.name🔗

MissionInterface.GuideInfo.name: string

MissionInterface.GuideInfo.text🔗

MissionInterface.GuideInfo.text: string

MissionInterface.GuideInfo.textGamepad🔗

MissionInterface.GuideInfo.textGamepad: string

MissionInterface.GuideInfo.image🔗

MissionInterface.GuideInfo.image: string

MissionInterface.GuideInfo.imageGamepad🔗

MissionInterface.GuideInfo.imageGamepad: string

MissionInterface.GuideInfo.caption🔗

MissionInterface.GuideInfo.caption: string

MissionInterface.GuideInfo.targets🔗

MissionInterface.GuideInfo.targets: {Target}

MissionInterface.GuideInfo.free🔗

MissionInterface.GuideInfo.free: boolean

MissionInterface.GuideInfo.freePosition🔗

MissionInterface.GuideInfo.freePosition: FreePosition

MissionInterface.TaskInfo🔗

[Expand All] [Collapse All]
record MissionInterface.TaskInfo
  
record NotificationInput
    missionTaskKey: string
    financialReward: integer
end
  
record Paragraph
    text: string
    textMouse: string
    textGamepad: string
end
  
record Option
    text: string
    key: any
end
  
record LinkDef
    entity: Engine.Entity
    location: PosRadius
    getEntity: function(): Engine.Entity
    getLocation: function(): MissionInterface.PosRadius
end
  links: {string : LinkDef}
  
record SubTaskInfo
    name: string
    description: string
    progress: TaskProgressData
end
  name: string
  paragraphs: {Paragraph}
  options: {Option}
  camera: {LinkDef}
  progress: TaskProgressData
  subTasks: {SubTaskInfo}
  instructionData: MissionDialogueData.InstructionData
  makeInstructionData: function(string, any): MissionDialogueData.InstructionData
  showTaskInGuiWithoutName: boolean
end

MissionInterface.TaskInfo.NotificationInput🔗

record MissionInterface.TaskInfo.NotificationInput
  missionTaskKey: string
  financialReward: integer
end

MissionInterface.TaskInfo.NotificationInput.missionTaskKey🔗

MissionInterface.TaskInfo.NotificationInput.missionTaskKey: string

MissionInterface.TaskInfo.NotificationInput.financialReward🔗

MissionInterface.TaskInfo.NotificationInput.financialReward: integer

MissionInterface.TaskInfo.Paragraph🔗

record MissionInterface.TaskInfo.Paragraph
  text: string
  textMouse: string
  textGamepad: string
end

MissionInterface.TaskInfo.Paragraph.text🔗

MissionInterface.TaskInfo.Paragraph.text: string

MissionInterface.TaskInfo.Paragraph.textMouse🔗

MissionInterface.TaskInfo.Paragraph.textMouse: string

MissionInterface.TaskInfo.Paragraph.textGamepad🔗

MissionInterface.TaskInfo.Paragraph.textGamepad: string

MissionInterface.TaskInfo.Option🔗

record MissionInterface.TaskInfo.Option
  text: string
  key: any
end

MissionInterface.TaskInfo.Option.text🔗

MissionInterface.TaskInfo.Option.text: string

MissionInterface.TaskInfo.Option.key🔗

MissionInterface.TaskInfo.Option.key: any

MissionInterface.TaskInfo.LinkDef🔗

record MissionInterface.TaskInfo.LinkDef
  entity: Engine.Entity
  location: PosRadius
  getEntity: function(): Engine.Entity
  getLocation: function(): MissionInterface.PosRadius
end

MissionInterface.TaskInfo.LinkDef.entity🔗

MissionInterface.TaskInfo.LinkDef.entity: Engine.Entity

MissionInterface.TaskInfo.LinkDef.location🔗

MissionInterface.TaskInfo.LinkDef.location: PosRadius

MissionInterface.TaskInfo.LinkDef.getEntity🔗

function MissionInterface.TaskInfo.LinkDef.getEntity(): Engine.Entity

Returns

1. Engine.Entity

MissionInterface.TaskInfo.LinkDef.getLocation🔗

function MissionInterface.TaskInfo.LinkDef.getLocation(): MissionInterface.PosRadius

Returns

1. MissionInterface.PosRadius

MissionInterface.TaskInfo.links🔗

MissionInterface.TaskInfo.links: {string : LinkDef}

MissionInterface.TaskInfo.SubTaskInfo🔗

record MissionInterface.TaskInfo.SubTaskInfo
  name: string
  description: string
  progress: TaskProgressData
end

MissionInterface.TaskInfo.SubTaskInfo.name🔗

MissionInterface.TaskInfo.SubTaskInfo.name: string

MissionInterface.TaskInfo.SubTaskInfo.description🔗

MissionInterface.TaskInfo.SubTaskInfo.description: string

MissionInterface.TaskInfo.SubTaskInfo.progress🔗

MissionInterface.TaskInfo.SubTaskInfo.progress: TaskProgressData

MissionInterface.TaskInfo.name🔗

MissionInterface.TaskInfo.name: string

MissionInterface.TaskInfo.paragraphs🔗

MissionInterface.TaskInfo.paragraphs: {Paragraph}

MissionInterface.TaskInfo.options🔗

MissionInterface.TaskInfo.options: {Option}

MissionInterface.TaskInfo.camera🔗

MissionInterface.TaskInfo.camera: {LinkDef}

MissionInterface.TaskInfo.progress🔗

MissionInterface.TaskInfo.progress: TaskProgressData

MissionInterface.TaskInfo.subTasks🔗

MissionInterface.TaskInfo.subTasks: {SubTaskInfo}

MissionInterface.TaskInfo.instructionData🔗

MissionInterface.TaskInfo.instructionData: MissionDialogueData.InstructionData

MissionInterface.TaskInfo.makeInstructionData🔗

function MissionInterface.TaskInfo.makeInstructionData(string, any): MissionDialogueData.InstructionData

Parameters

• string
• any

Returns

1. MissionDialogueData.InstructionData

MissionInterface.TaskInfo.showTaskInGuiWithoutName🔗

MissionInterface.TaskInfo.showTaskInGuiWithoutName: boolean

MissionInterface.ProposalHandlerResult🔗

record MissionInterface.ProposalHandlerResult
  error: string
  warning: string
  priority: number
  isWhitelist: boolean
end

MissionInterface.ProposalHandlerResult.error🔗

MissionInterface.ProposalHandlerResult.error: string

MissionInterface.ProposalHandlerResult.warning🔗

MissionInterface.ProposalHandlerResult.warning: string

MissionInterface.ProposalHandlerResult.priority🔗

MissionInterface.ProposalHandlerResult.priority: number

MissionInterface.ProposalHandlerResult.isWhitelist🔗

MissionInterface.ProposalHandlerResult.isWhitelist: boolean

MissionInterface.TaskContext🔗

record MissionInterface.TaskContext<TaskSpecificState, TaskSepcificParams>
  state: TaskSpecificState
  genericState: GenericTaskState
  params: TaskSepcificParams
  guiTimeSeconds: number
end

Type Parameters

• TaskSpecificState
• TaskSepcificParams

MissionInterface.TaskContext.state🔗

MissionInterface.TaskContext.state: TaskSpecificState

MissionInterface.TaskContext.genericState🔗

MissionInterface.TaskContext.genericState: GenericTaskState

MissionInterface.TaskContext.params🔗

MissionInterface.TaskContext.params: TaskSepcificParams

MissionInterface.TaskContext.guiTimeSeconds🔗

MissionInterface.TaskContext.guiTimeSeconds: number

MissionInterface.TaskScript🔗

interface MissionInterface.TaskScript<TaskSpecificState, TaskParams>
  taskScriptName: string
  disableGuideSystem: boolean
  handleLegacy: function(TaskContext<TaskSpecificState, TaskParams>, integer): TaskContext<TaskSpecificState, TaskParams>
  onSpawn: function(TaskParams, number): TaskSpecificState | nil
  onStart: function(TaskContext<TaskSpecificState, TaskParams>)
  getInfo: function(TaskContext<TaskSpecificState, TaskParams>): TaskInfo
  isComplete: function(TaskContext<TaskSpecificState, TaskParams>): boolean
  onComplete: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi)
  onUpdate: function(TaskContext<TaskSpecificState, TaskParams>, MissionTaskReadOnlyApi)
  handleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi): any
  guiHandleEvent: function(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): any
  guiUpdate: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi)
  guiHandleProposal: function(string, string, ProposalEventData, boolean, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): ProposalHandlerResult
  onGuiKickOff: function(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): boolean
  getMarkers: function(TaskContext<TaskSpecificState, TaskParams>): {Marker}
  getZones: function(TaskContext<TaskSpecificState, TaskParams>): {Zone}
  getNonBulldozableEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity}
  getProtectedEntities: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}
  getSelectorEntityFilter: function(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : boolean}
  getVisibilityRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
  getEnableRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}
  getHighlightRules: function(TaskContext<TaskSpecificState, TaskParams>): {string : MissionInterface.HighlightStyle}
end

Type Parameters

• TaskSpecificState
• TaskParams

MissionInterface.TaskScript.taskScriptName🔗

MissionInterface.TaskScript.taskScriptName: string

MissionInterface.TaskScript.disableGuideSystem🔗

MissionInterface.TaskScript.disableGuideSystem: boolean

MissionInterface.TaskScript.handleLegacy🔗

function MissionInterface.TaskScript.handleLegacy(TaskContext<TaskSpecificState, TaskParams>, integer): TaskContext<TaskSpecificState, TaskParams>

Parameters

• TaskContext<TaskSpecificState, TaskParams>
• integer

Returns

1. TaskContext<TaskSpecificState, TaskParams>

MissionInterface.TaskScript.onSpawn🔗

function MissionInterface.TaskScript.onSpawn(TaskParams, number): TaskSpecificState | nil

Parameters

• TaskParams
• number

Returns

1. TaskSpecificState | nil

MissionInterface.TaskScript.onStart🔗

function MissionInterface.TaskScript.onStart(TaskContext<TaskSpecificState, TaskParams>)

Parameters

• TaskContext<TaskSpecificState, TaskParams>

MissionInterface.TaskScript.getInfo🔗

function MissionInterface.TaskScript.getInfo(TaskContext<TaskSpecificState, TaskParams>): TaskInfo

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. TaskInfo

MissionInterface.TaskScript.isComplete🔗

function MissionInterface.TaskScript.isComplete(TaskContext<TaskSpecificState, TaskParams>): boolean

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. boolean

MissionInterface.TaskScript.onComplete🔗

function MissionInterface.TaskScript.onComplete(TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi)

Parameters

• TaskContext<TaskSpecificState, TaskParams>
• MissionTaskApi

MissionInterface.TaskScript.onUpdate🔗

function MissionInterface.TaskScript.onUpdate(TaskContext<TaskSpecificState, TaskParams>, MissionTaskReadOnlyApi)

Parameters

• TaskContext<TaskSpecificState, TaskParams>
• MissionTaskReadOnlyApi

MissionInterface.TaskScript.handleEvent🔗

function MissionInterface.TaskScript.handleEvent(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, MissionTaskApi): any

Parameters

• string
• string
• string
• any
• TaskContext<TaskSpecificState, TaskParams>
• MissionTaskApi

Returns

1. any

MissionInterface.TaskScript.guiHandleEvent🔗

function MissionInterface.TaskScript.guiHandleEvent(string, string, string, any, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): any

Parameters

• string
• string
• string
• any
• TaskContext<TaskSpecificState, TaskParams>
• DeferredTaskApi

Returns

1. any

MissionInterface.TaskScript.guiUpdate🔗

function MissionInterface.TaskScript.guiUpdate(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi)

Parameters

• TaskContext<TaskSpecificState, TaskParams>
• DeferredTaskApi

MissionInterface.TaskScript.guiHandleProposal🔗

function MissionInterface.TaskScript.guiHandleProposal(string, string, ProposalEventData, boolean, TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): ProposalHandlerResult

Parameters

• string
• string
• ProposalEventData
• boolean
• TaskContext<TaskSpecificState, TaskParams>
• DeferredTaskApi

Returns

1. ProposalHandlerResult

MissionInterface.TaskScript.onGuiKickOff🔗

function MissionInterface.TaskScript.onGuiKickOff(TaskContext<TaskSpecificState, TaskParams>, DeferredTaskApi): boolean

Parameters

• TaskContext<TaskSpecificState, TaskParams>
• DeferredTaskApi

Returns

1. boolean

MissionInterface.TaskScript.getMarkers🔗

function MissionInterface.TaskScript.getMarkers(TaskContext<TaskSpecificState, TaskParams>): {Marker}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {Marker}

MissionInterface.TaskScript.getZones🔗

function MissionInterface.TaskScript.getZones(TaskContext<TaskSpecificState, TaskParams>): {Zone}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {Zone}

MissionInterface.TaskScript.getNonBulldozableEntities🔗

function MissionInterface.TaskScript.getNonBulldozableEntities(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {Engine.Entity}

MissionInterface.TaskScript.getProtectedEntities🔗

function MissionInterface.TaskScript.getProtectedEntities(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}

MissionInterface.TaskScript.getSelectorEntityFilter🔗

function MissionInterface.TaskScript.getSelectorEntityFilter(TaskContext<TaskSpecificState, TaskParams>): {Engine.Entity : boolean}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {Engine.Entity : boolean}

MissionInterface.TaskScript.getVisibilityRules🔗

function MissionInterface.TaskScript.getVisibilityRules(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {string : boolean}

MissionInterface.TaskScript.getEnableRules🔗

function MissionInterface.TaskScript.getEnableRules(TaskContext<TaskSpecificState, TaskParams>): {string : boolean}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {string : boolean}

MissionInterface.TaskScript.getHighlightRules🔗

function MissionInterface.TaskScript.getHighlightRules(TaskContext<TaskSpecificState, TaskParams>): {string : MissionInterface.HighlightStyle}

Parameters

• TaskContext<TaskSpecificState, TaskParams>

Returns

1. {string : MissionInterface.HighlightStyle}