Module content.mission.mission_task_util🔗

global type MissionLocalization = {{Engine.Entity, string}}
[Expand All] [Collapse All]
global record MissionTaskUtil
  
record FollowupDef
    taskKey: string
    condition: function(MissionInterface.TaskContext<<any type>, <any type>>, function(string) : MissionInterface.TaskState<<any type>, <any type>>)
end
  
record StaticTaskInfo
    isBonusTask: boolean
    taskScript: MissionInterface.TaskScript<<any type>, <any type>>
    taskKey: string
    taskParams: any
    medals: {string : boolean}
    stars: {string : boolean}
    visible: {string}
    invisible: {string}
    enabled: {string}
    disabled: {string}
    highlightRules: {{string, MissionInterface.HighlightStyle}}
    taskInfo: MissionInterface.TaskInfo
    guideInfo: MissionInterface.GuideInfo
    omitNotificationOnComplete: boolean
    disableGuideSystem: boolean
    startSoundtrack: string
    soundtrack: MissionInterface.MissionSoundtrack
    playlistOverride: ResName
    allowBuyVehicles: {string : integer}
    allowBuyVehicleGroups: {string : {{string}, integer}}
    lockedVehicles: {Engine.Entity}
    followup: {FollowupDef}
    vehicleFilter: GameContext.Filters.VehicleFilter
    notificationFilter: {string : boolean}
    menuFilter: GameContext.Filters.MenuFilter
    selectorEntityFilter: {Engine.Entity : boolean}
    disableFeatures: {DisableFeatures : boolean}
    requiredTaskToComplete: string
    allowSimultaneousUiTasks: {string}
    showInHistory: boolean
    suppressAutoOpen: boolean
    financialReward: integer
end
  makeTaskKey: function(string, string): string
  makeJoinParams: function({string}, string, boolean): MissionTaskJoin.Params
  locationButDistance: function(Engine.Entity, number): MissionInterface.PosRadius
  disallowAllVehicles: function({<any type> : string}): {string : {integer, integer}}
  makeBoundingSphereFromEntity: function(Engine.Entity): MissionInterface.PosRadius
  mergeBoundingVolumes: function({Engine.Entity}, number): MissionInterface.PosRadius
  mergeAreas: function({MissionInterface.PosRadius}, number): MissionInterface.PosRadius
  extractGenericParams: function(string, function(string) : StaticTaskInfo): MissionInterface.GenericTaskParams
  getTaskInfo: function(string, MissionInterface.TaskContext<<any type>, <any type>>, function(string) : StaticTaskInfo): MissionInterface.TaskInfo
  getNonBulldozableEntitiesFromParams: function({<any type> : <any type>}): {Engine.Entity}
end

Category: globals🔗

MissionLocalization🔗

global type MissionLocalization = {{Engine.Entity, string}}

MissionTaskUtil🔗

[Expand All] [Collapse All]
global record MissionTaskUtil
  
record FollowupDef
    taskKey: string
    condition: function(MissionInterface.TaskContext<<any type>, <any type>>, function(string) : MissionInterface.TaskState<<any type>, <any type>>)
end
  
record StaticTaskInfo
    isBonusTask: boolean
    taskScript: MissionInterface.TaskScript<<any type>, <any type>>
    taskKey: string
    taskParams: any
    medals: {string : boolean}
    stars: {string : boolean}
    visible: {string}
    invisible: {string}
    enabled: {string}
    disabled: {string}
    highlightRules: {{string, MissionInterface.HighlightStyle}}
    taskInfo: MissionInterface.TaskInfo
    guideInfo: MissionInterface.GuideInfo
    omitNotificationOnComplete: boolean
    disableGuideSystem: boolean
    startSoundtrack: string
    soundtrack: MissionInterface.MissionSoundtrack
    playlistOverride: ResName
    allowBuyVehicles: {string : integer}
    allowBuyVehicleGroups: {string : {{string}, integer}}
    lockedVehicles: {Engine.Entity}
    followup: {FollowupDef}
    vehicleFilter: GameContext.Filters.VehicleFilter
    notificationFilter: {string : boolean}
    menuFilter: GameContext.Filters.MenuFilter
    selectorEntityFilter: {Engine.Entity : boolean}
    disableFeatures: {DisableFeatures : boolean}
    requiredTaskToComplete: string
    allowSimultaneousUiTasks: {string}
    showInHistory: boolean
    suppressAutoOpen: boolean
    financialReward: integer
end
  makeTaskKey: function(string, string): string
  makeJoinParams: function({string}, string, boolean): MissionTaskJoin.Params
  locationButDistance: function(Engine.Entity, number): MissionInterface.PosRadius
  disallowAllVehicles: function({<any type> : string}): {string : {integer, integer}}
  makeBoundingSphereFromEntity: function(Engine.Entity): MissionInterface.PosRadius
  mergeBoundingVolumes: function({Engine.Entity}, number): MissionInterface.PosRadius
  mergeAreas: function({MissionInterface.PosRadius}, number): MissionInterface.PosRadius
  extractGenericParams: function(string, function(string) : StaticTaskInfo): MissionInterface.GenericTaskParams
  getTaskInfo: function(string, MissionInterface.TaskContext<<any type>, <any type>>, function(string) : StaticTaskInfo): MissionInterface.TaskInfo
  getNonBulldozableEntitiesFromParams: function({<any type> : <any type>}): {Engine.Entity}
end

MissionTaskUtil.FollowupDef🔗

record MissionTaskUtil.FollowupDef
  taskKey: string
  condition: function(MissionInterface.TaskContext<<any type>, <any type>>, function(string) : MissionInterface.TaskState<<any type>, <any type>>)
end

MissionTaskUtil.FollowupDef.taskKey🔗

MissionTaskUtil.FollowupDef.taskKey: string

MissionTaskUtil.FollowupDef.condition🔗

function MissionTaskUtil.FollowupDef.condition(MissionInterface.TaskContext<<any type>, <any type>>, function(string) : MissionInterface.TaskState<<any type>, <any type>>)

Parameters

• MissionInterface.TaskContext<<any type>, <any type>>
• function(string): MissionInterface.TaskState<<any type>, <any type>>

MissionTaskUtil.StaticTaskInfo🔗

record MissionTaskUtil.StaticTaskInfo
  isBonusTask: boolean
  taskScript: MissionInterface.TaskScript<<any type>, <any type>>
  taskKey: string
  taskParams: any
  medals: {string : boolean}
  stars: {string : boolean}
  visible: {string}
  invisible: {string}
  enabled: {string}
  disabled: {string}
  highlightRules: {{string, MissionInterface.HighlightStyle}}
  taskInfo: MissionInterface.TaskInfo
  guideInfo: MissionInterface.GuideInfo
  omitNotificationOnComplete: boolean
  disableGuideSystem: boolean
  startSoundtrack: string
  soundtrack: MissionInterface.MissionSoundtrack
  playlistOverride: ResName
  allowBuyVehicles: {string : integer}
  allowBuyVehicleGroups: {string : {{string}, integer}}
  lockedVehicles: {Engine.Entity}
  followup: {FollowupDef}
  vehicleFilter: GameContext.Filters.VehicleFilter
  notificationFilter: {string : boolean}
  menuFilter: GameContext.Filters.MenuFilter
  selectorEntityFilter: {Engine.Entity : boolean}
  disableFeatures: {DisableFeatures : boolean}
  requiredTaskToComplete: string
  allowSimultaneousUiTasks: {string}
  showInHistory: boolean
  suppressAutoOpen: boolean
  financialReward: integer
end

MissionTaskUtil.StaticTaskInfo.isBonusTask🔗

MissionTaskUtil.StaticTaskInfo.isBonusTask: boolean

MissionTaskUtil.StaticTaskInfo.taskScript🔗

MissionTaskUtil.StaticTaskInfo.taskScript: MissionInterface.TaskScript<<any type>, <any type>>

MissionTaskUtil.StaticTaskInfo.taskKey🔗

MissionTaskUtil.StaticTaskInfo.taskKey: string

MissionTaskUtil.StaticTaskInfo.taskParams🔗

MissionTaskUtil.StaticTaskInfo.taskParams: any

MissionTaskUtil.StaticTaskInfo.medals🔗

MissionTaskUtil.StaticTaskInfo.medals: {string : boolean}

MissionTaskUtil.StaticTaskInfo.stars🔗

MissionTaskUtil.StaticTaskInfo.stars: {string : boolean}

MissionTaskUtil.StaticTaskInfo.visible🔗

MissionTaskUtil.StaticTaskInfo.visible: {string}

MissionTaskUtil.StaticTaskInfo.invisible🔗

MissionTaskUtil.StaticTaskInfo.invisible: {string}

MissionTaskUtil.StaticTaskInfo.enabled🔗

MissionTaskUtil.StaticTaskInfo.enabled: {string}

MissionTaskUtil.StaticTaskInfo.disabled🔗

MissionTaskUtil.StaticTaskInfo.disabled: {string}

MissionTaskUtil.StaticTaskInfo.highlightRules🔗

MissionTaskUtil.StaticTaskInfo.highlightRules: {{string, MissionInterface.HighlightStyle}}

MissionTaskUtil.StaticTaskInfo.taskInfo🔗

MissionTaskUtil.StaticTaskInfo.taskInfo: MissionInterface.TaskInfo

MissionTaskUtil.StaticTaskInfo.guideInfo🔗

MissionTaskUtil.StaticTaskInfo.guideInfo: MissionInterface.GuideInfo

MissionTaskUtil.StaticTaskInfo.omitNotificationOnComplete🔗

MissionTaskUtil.StaticTaskInfo.omitNotificationOnComplete: boolean

MissionTaskUtil.StaticTaskInfo.disableGuideSystem🔗

MissionTaskUtil.StaticTaskInfo.disableGuideSystem: boolean

MissionTaskUtil.StaticTaskInfo.startSoundtrack🔗

MissionTaskUtil.StaticTaskInfo.startSoundtrack: string

MissionTaskUtil.StaticTaskInfo.soundtrack🔗

MissionTaskUtil.StaticTaskInfo.soundtrack: MissionInterface.MissionSoundtrack

MissionTaskUtil.StaticTaskInfo.playlistOverride🔗

MissionTaskUtil.StaticTaskInfo.playlistOverride: ResName

MissionTaskUtil.StaticTaskInfo.allowBuyVehicles🔗

MissionTaskUtil.StaticTaskInfo.allowBuyVehicles: {string : integer}

MissionTaskUtil.StaticTaskInfo.allowBuyVehicleGroups🔗

MissionTaskUtil.StaticTaskInfo.allowBuyVehicleGroups: {string : {{string}, integer}}

MissionTaskUtil.StaticTaskInfo.lockedVehicles🔗

MissionTaskUtil.StaticTaskInfo.lockedVehicles: {Engine.Entity}

MissionTaskUtil.StaticTaskInfo.followup🔗

MissionTaskUtil.StaticTaskInfo.followup: {FollowupDef}

MissionTaskUtil.StaticTaskInfo.vehicleFilter🔗

MissionTaskUtil.StaticTaskInfo.vehicleFilter: GameContext.Filters.VehicleFilter

MissionTaskUtil.StaticTaskInfo.notificationFilter🔗

MissionTaskUtil.StaticTaskInfo.notificationFilter: {string : boolean}

MissionTaskUtil.StaticTaskInfo.menuFilter🔗

MissionTaskUtil.StaticTaskInfo.menuFilter: GameContext.Filters.MenuFilter

MissionTaskUtil.StaticTaskInfo.selectorEntityFilter🔗

MissionTaskUtil.StaticTaskInfo.selectorEntityFilter: {Engine.Entity : boolean}

MissionTaskUtil.StaticTaskInfo.disableFeatures🔗

MissionTaskUtil.StaticTaskInfo.disableFeatures: {DisableFeatures : boolean}

MissionTaskUtil.StaticTaskInfo.requiredTaskToComplete🔗

MissionTaskUtil.StaticTaskInfo.requiredTaskToComplete: string

MissionTaskUtil.StaticTaskInfo.allowSimultaneousUiTasks🔗

MissionTaskUtil.StaticTaskInfo.allowSimultaneousUiTasks: {string}

MissionTaskUtil.StaticTaskInfo.showInHistory🔗

MissionTaskUtil.StaticTaskInfo.showInHistory: boolean

MissionTaskUtil.StaticTaskInfo.suppressAutoOpen🔗

MissionTaskUtil.StaticTaskInfo.suppressAutoOpen: boolean

MissionTaskUtil.StaticTaskInfo.financialReward🔗

MissionTaskUtil.StaticTaskInfo.financialReward: integer

MissionTaskUtil.makeTaskKey🔗

function MissionTaskUtil.makeTaskKey(string, string): string

Parameters

• string
• string

Returns

1. string

MissionTaskUtil.makeJoinParams🔗

function MissionTaskUtil.makeJoinParams({string}, string, boolean): MissionTaskJoin.Params

Parameters

• {string}
• string
• boolean

Returns

1. MissionTaskJoin.Params

MissionTaskUtil.locationButDistance🔗

function MissionTaskUtil.locationButDistance(Engine.Entity, number): MissionInterface.PosRadius

Parameters

• Engine.Entity
• number

Returns

1. MissionInterface.PosRadius

MissionTaskUtil.disallowAllVehicles🔗

function MissionTaskUtil.disallowAllVehicles({<any type> : string}): {string : {integer, integer}}

Parameters

• {<any type> : string}

Returns

1. {string : {integer, integer}}

MissionTaskUtil.makeBoundingSphereFromEntity🔗

function MissionTaskUtil.makeBoundingSphereFromEntity(Engine.Entity): MissionInterface.PosRadius

Parameters

• Engine.Entity

Returns

1. MissionInterface.PosRadius

MissionTaskUtil.mergeBoundingVolumes🔗

function MissionTaskUtil.mergeBoundingVolumes({Engine.Entity}, number): MissionInterface.PosRadius

Parameters

• {Engine.Entity}
• number

Returns

1. MissionInterface.PosRadius

MissionTaskUtil.mergeAreas🔗

function MissionTaskUtil.mergeAreas({MissionInterface.PosRadius}, number): MissionInterface.PosRadius

Parameters

• {MissionInterface.PosRadius}
• number

Returns

1. MissionInterface.PosRadius

MissionTaskUtil.extractGenericParams🔗

function MissionTaskUtil.extractGenericParams(string, function(string) : StaticTaskInfo): MissionInterface.GenericTaskParams

Parameters

• string
• function(string): StaticTaskInfo

Returns

1. MissionInterface.GenericTaskParams

MissionTaskUtil.getTaskInfo🔗

function MissionTaskUtil.getTaskInfo(string, MissionInterface.TaskContext<<any type>, <any type>>, function(string) : StaticTaskInfo): MissionInterface.TaskInfo

Parameters

• string
• MissionInterface.TaskContext<<any type>, <any type>>
• function(string): StaticTaskInfo

Returns

1. MissionInterface.TaskInfo

MissionTaskUtil.getNonBulldozableEntitiesFromParams🔗

function MissionTaskUtil.getNonBulldozableEntitiesFromParams({<any type> : <any type>}): {Engine.Entity}

Parameters

• {<any type> : <any type>}

Returns

1. {Engine.Entity}