Module content.gui.main.game_context🔗
global record CalloutApi
open: function<R is IRecipeParamWithMeta>(CalloutParamsT<R>) close: function(any) endrecord CalloutParamsT<R is IRecipeParamWithMeta>
recipe: Recipe<R> recipeParam: R anchor: Vec2f parent: any gravity: Vec2f getPositionFn: function(): Vec2f recipeParamCompareFn: function(R, R): boolean delay: number endglobal record DialogueOverlayApi
isPlaying: function(): boolean getPlayingForTask: function(): string areCreditsPlaying: function(): boolean stopCredits: function(): boolean abortCurrent: function() skipCurrentLine: function() enqueueUnlessExisting: function(string, string, function() : MissionDialogueData.InstructionData) endglobal record GameContext
rendererComponent: ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI> windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI> toolStack: ReactRefWrapApiT<Builtin.ToolStackParam, Builtin.ToolStackAPI> accessNotificationCacheFn: function(Engine.Entity): {Notification} metroMode: ReactStateT<boolean> preferredLayerConfig: ReactRefT<LayerConfig> dialogueOverlayRef: ReactRefWrapApi0<DialogueOverlayApi> calloutContainerRef: ReactRefWrapApi0<CalloutApi> filters: ReactRefT<Filters> disableFeatures: ReactRefT<{DisableFeatures : boolean}> focusGameBar: function() endrecord Filters
menuFilter: MenuFilter vehicleFilter: VehicleFilter protectedEntities: {Engine.Entity : ProtectionConfig | boolean} selectorEntityFilter: {Engine.Entity : boolean} endglobal record GameSpeedApi
isEnabled: function(): boolean getSpeed: function(): integer setSpeed: function(integer) togglePause: function() cycleSpeed: function() end
Category: globals🔗
CalloutApi🔗
global record CalloutApi
open: function<R is IRecipeParamWithMeta>(CalloutParamsT<R>) close: function(any) endrecord CalloutParamsT<R is IRecipeParamWithMeta>
recipe: Recipe<R> recipeParam: R anchor: Vec2f parent: any gravity: Vec2f getPositionFn: function(): Vec2f recipeParamCompareFn: function(R, R): boolean delay: number end
CalloutApi.CalloutParamsT🔗
record CalloutApi.CalloutParamsT<R is IRecipeParamWithMeta>
recipe: Recipe<R> recipeParam: R anchor: Vec2f parent: any gravity: Vec2f getPositionFn: function(): Vec2f recipeParamCompareFn: function(R, R): boolean delay: number end
Type Parameters
R( isIRecipeParamWithMeta)
CalloutApi.CalloutParamsT.recipe🔗
CalloutApi.CalloutParamsT.recipe: Recipe<R>
CalloutApi.CalloutParamsT.recipeParam🔗
CalloutApi.CalloutParamsT.recipeParam: R
CalloutApi.CalloutParamsT.anchor🔗
CalloutApi.CalloutParamsT.anchor: Vec2f
CalloutApi.CalloutParamsT.parent🔗
CalloutApi.CalloutParamsT.parent: any
CalloutApi.CalloutParamsT.gravity🔗
CalloutApi.CalloutParamsT.gravity: Vec2f
CalloutApi.CalloutParamsT.getPositionFn🔗
function CalloutApi.CalloutParamsT.getPositionFn(): Vec2fReturns
Vec2f
CalloutApi.CalloutParamsT.recipeParamCompareFn🔗
function CalloutApi.CalloutParamsT.recipeParamCompareFn(R, R): booleanParameters
RR
boolean
CalloutApi.CalloutParamsT.delay🔗
CalloutApi.CalloutParamsT.delay: number
CalloutApi.open🔗
function CalloutApi.open<R is IRecipeParamWithMeta>(CalloutParamsT<R>)
Type Parameters
R( isIRecipeParamWithMeta)
CalloutParamsT<R>
CalloutApi.close🔗
function CalloutApi.close(any)Parameters
any
DialogueOverlayApi🔗
global record DialogueOverlayApi
isPlaying: function(): boolean getPlayingForTask: function(): string areCreditsPlaying: function(): boolean stopCredits: function(): boolean abortCurrent: function() skipCurrentLine: function() enqueueUnlessExisting: function(string, string, function() : MissionDialogueData.InstructionData) end
DialogueOverlayApi.isPlaying🔗
function DialogueOverlayApi.isPlaying(): booleanReturns
boolean
DialogueOverlayApi.getPlayingForTask🔗
function DialogueOverlayApi.getPlayingForTask(): stringReturns
string
DialogueOverlayApi.areCreditsPlaying🔗
function DialogueOverlayApi.areCreditsPlaying(): booleanReturns
boolean
DialogueOverlayApi.stopCredits🔗
function DialogueOverlayApi.stopCredits(): booleanReturns
boolean
DialogueOverlayApi.abortCurrent🔗
function DialogueOverlayApi.abortCurrent()
DialogueOverlayApi.skipCurrentLine🔗
function DialogueOverlayApi.skipCurrentLine()
DialogueOverlayApi.enqueueUnlessExisting🔗
function DialogueOverlayApi.enqueueUnlessExisting(string, string, function() : MissionDialogueData.InstructionData)Parameters
stringstringfunction(): MissionDialogueData.InstructionData
GameContext🔗
global record GameContext
rendererComponent: ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI> windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI> toolStack: ReactRefWrapApiT<Builtin.ToolStackParam, Builtin.ToolStackAPI> accessNotificationCacheFn: function(Engine.Entity): {Notification} metroMode: ReactStateT<boolean> preferredLayerConfig: ReactRefT<LayerConfig> dialogueOverlayRef: ReactRefWrapApi0<DialogueOverlayApi> calloutContainerRef: ReactRefWrapApi0<CalloutApi> filters: ReactRefT<Filters> disableFeatures: ReactRefT<{DisableFeatures : boolean}> focusGameBar: function() endrecord Filters
menuFilter: MenuFilter vehicleFilter: VehicleFilter protectedEntities: {Engine.Entity : ProtectionConfig | boolean} selectorEntityFilter: {Engine.Entity : boolean} end
GameContext.Filters🔗
record GameContext.Filters
menuFilter: MenuFilter vehicleFilter: VehicleFilter protectedEntities: {Engine.Entity : ProtectionConfig | boolean} selectorEntityFilter: {Engine.Entity : boolean} end
GameContext.Filters.MenuFilter🔗
record GameContext.Filters.MenuFilter
enabledItems: {string} disabledItems: {string} disabledParams: {string} end
GameContext.Filters.MenuFilter.enabledItems🔗
GameContext.Filters.MenuFilter.enabledItems: {string}
GameContext.Filters.MenuFilter.disabledItems🔗
GameContext.Filters.MenuFilter.disabledItems: {string}
GameContext.Filters.MenuFilter.disabledParams🔗
GameContext.Filters.MenuFilter.disabledParams: {string}
GameContext.Filters.VehicleFilter🔗
GameContext.Filters.VehicleFilter.enabledVehicles🔗
GameContext.Filters.VehicleFilter.enabledVehicles: {string}
GameContext.Filters.VehicleFilter.disabledVehicles🔗
GameContext.Filters.VehicleFilter.disabledVehicles: {string}
GameContext.Filters.ProtectionConfig🔗
GameContext.Filters.ProtectionConfig.Line🔗
GameContext.Filters.ProtectionConfig.Line.stationGroups🔗
GameContext.Filters.ProtectionConfig.Line.stationGroups: {Engine.Entity : boolean}
GameContext.Filters.ProtectionConfig.line🔗
GameContext.Filters.ProtectionConfig.line: Line
GameContext.Filters.menuFilter🔗
GameContext.Filters.menuFilter: MenuFilter
GameContext.Filters.vehicleFilter🔗
GameContext.Filters.vehicleFilter: VehicleFilter
GameContext.Filters.protectedEntities🔗
GameContext.Filters.protectedEntities: {Engine.Entity : ProtectionConfig | boolean}
GameContext.Filters.selectorEntityFilter🔗
GameContext.Filters.selectorEntityFilter: {Engine.Entity : boolean}
GameContext.rendererComponent🔗
GameContext.rendererComponent: ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>
GameContext.windowContainer🔗
GameContext.windowContainer: ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>
GameContext.toolStack🔗
GameContext.toolStack: ReactRefWrapApiT<Builtin.ToolStackParam, Builtin.ToolStackAPI>
GameContext.accessNotificationCacheFn🔗
function GameContext.accessNotificationCacheFn(Engine.Entity): {Notification}Parameters
Engine.Entity
{Notification}
GameContext.metroMode🔗
GameContext.metroMode: ReactStateT<boolean>
GameContext.preferredLayerConfig🔗
GameContext.preferredLayerConfig: ReactRefT<LayerConfig>
GameContext.dialogueOverlayRef🔗
GameContext.dialogueOverlayRef: ReactRefWrapApi0<DialogueOverlayApi>
GameContext.calloutContainerRef🔗
GameContext.calloutContainerRef: ReactRefWrapApi0<CalloutApi>
GameContext.filters🔗
GameContext.filters: ReactRefT<Filters>
GameContext.disableFeatures🔗
GameContext.disableFeatures: ReactRefT<{DisableFeatures : boolean}>
GameContext.focusGameBar🔗
function GameContext.focusGameBar()
GameSpeedApi🔗
global record GameSpeedApi
isEnabled: function(): boolean getSpeed: function(): integer setSpeed: function(integer) togglePause: function() cycleSpeed: function() end
GameSpeedApi.isEnabled🔗
function GameSpeedApi.isEnabled(): booleanReturns
boolean
GameSpeedApi.getSpeed🔗
function GameSpeedApi.getSpeed(): integerReturns
integer
GameSpeedApi.setSpeed🔗
function GameSpeedApi.setSpeed(integer)Parameters
integer
GameSpeedApi.togglePause🔗
function GameSpeedApi.togglePause()
GameSpeedApi.cycleSpeed🔗
function GameSpeedApi.cycleSpeed()