Interface: StaticConsoleMessageTarget

A console message target.

Properties

Name Type Description
activationenabled boolean No description provided.
actuallayoutheight number No description provided.
actuallayoutwidth number No description provided.
actualuiscale_x number No description provided.
actualuiscale_y number No description provided.
actualxoffset number No description provided.
actualyoffset number No description provided.
checked boolean No description provided.
contentheight number No description provided.
contentwidth number No description provided.
defaultfocus string No description provided.
desiredlayoutheight number No description provided.
desiredlayoutwidth number No description provided.
enabled boolean No description provided.
hittest boolean No description provided.
hittestchildren boolean No description provided.
id string No description provided.
inputnamespace string No description provided.
layoutfile string No description provided.
paneltype StaticConsoleMessageTarget No description provided.
rememberchildfocus boolean No description provided.
scrolloffset_x number No description provided.
scrolloffset_y number No description provided.
selectionpos_x number No description provided.
selectionpos_y number No description provided.
style Style No description provided.
tabindex number No description provided.
visible boolean No description provided.

Functions

AcceptsFocus

StaticConsoleMessageTarget.AcceptsFocus(): boolean

No description provided.

AcceptsInput

StaticConsoleMessageTarget.AcceptsInput(): boolean

No description provided.

AddClass

StaticConsoleMessageTarget.AddClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ApplyStyles

StaticConsoleMessageTarget.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

BAscendantHasClass

StaticConsoleMessageTarget.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

CanSeeInParentScroll

StaticConsoleMessageTarget.CanSeeInParentScroll(): boolean

No description provided.

Children

StaticConsoleMessageTarget.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

StaticConsoleMessageTarget.ClearPanelEvent(event: string): void

No description provided.

Parameter

Name Type Description
event string No description provided.

ClearPropertyFromCode

StaticConsoleMessageTarget.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

Name Type Description
arg0 unknown No description provided.

CreateChildren

StaticConsoleMessageTarget.CreateChildren(elements: string): boolean

No description provided.

Parameter

Name Type Description
elements string No description provided.

CreateCopyOfCSSKeyframes

StaticConsoleMessageTarget.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

Name Type Description
animation string No description provided.

Data

StaticConsoleMessageTarget.Data(...args: any[]): void

No description provided.

Parameter

Name Type Description
...args any[] No description provided.

DeleteAsync

StaticConsoleMessageTarget.DeleteAsync(delay: number): void

No description provided.

Parameter

Name Type Description
delay number No description provided.

DeleteKeyframes

StaticConsoleMessageTarget.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

FindChild

StaticConsoleMessageTarget.FindChild(id: string): T

Searches this element's direct children and returns a child with the specified id.

Parameter

Name Type Description
id string No description provided.

FindChildInLayoutFile

StaticConsoleMessageTarget.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

FindChildrenWithClassTraverse

StaticConsoleMessageTarget.FindChildrenWithClassTraverse(classname: string): T[]

No description provided.

Parameter

Name Type Description
classname string No description provided.

FindChildTraverse

StaticConsoleMessageTarget.FindChildTraverse(id: string): T

No description provided.

Parameter

Name Type Description
id string No description provided.

GetAttributeInt

StaticConsoleMessageTarget.GetAttributeInt(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetAttributeString

StaticConsoleMessageTarget.GetAttributeString(attribute: string, fallback: string): string

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback string No description provided.

GetAttributeUInt32

StaticConsoleMessageTarget.GetAttributeUInt32(attribute: string, fallback: number): number

No description provided.

Parameters

Name Type Description
attribute string No description provided.
fallback number No description provided.

GetChild

StaticConsoleMessageTarget.GetChild(index: number): T

No description provided.

Parameter

Name Type Description
index number No description provided.

GetChildCount

StaticConsoleMessageTarget.GetChildCount(): number

No description provided.

GetChildIndex

StaticConsoleMessageTarget.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

Name Type Description
child GenericPanel No description provided.

GetFirstChild

StaticConsoleMessageTarget.GetFirstChild(): T

No description provided.

GetLastChild

StaticConsoleMessageTarget.GetLastChild(): T

No description provided.

GetLayoutFileDefine

StaticConsoleMessageTarget.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

Name Type Description
def string No description provided.

GetParent

StaticConsoleMessageTarget.GetParent(): T

No description provided.

GetPositionWithinWindow

StaticConsoleMessageTarget.GetPositionWithinWindow(): unknown

No description provided.

HasClass

StaticConsoleMessageTarget.HasClass(classname: string): boolean

No description provided.

Parameter

Name Type Description
classname string No description provided.

HasDescendantKeyFocus

StaticConsoleMessageTarget.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

StaticConsoleMessageTarget.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

StaticConsoleMessageTarget.HasKeyFocus(): boolean

No description provided.

IsDraggable

StaticConsoleMessageTarget.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

StaticConsoleMessageTarget.IsReadyForDisplay(): boolean

No description provided.

IsSelected

StaticConsoleMessageTarget.IsSelected(): boolean

No description provided.

IsSizeValid

StaticConsoleMessageTarget.IsSizeValid(): boolean

No description provided.

IsTransparent

StaticConsoleMessageTarget.IsTransparent(): boolean

No description provided.

IsValid

StaticConsoleMessageTarget.IsValid(): boolean

Check if this panel is still valid

LoadLayout

StaticConsoleMessageTarget.LoadLayout(url: string, override: boolean, partial: boolean): boolean

No description provided.

Parameters

Name Type Description
url string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutAsync

StaticConsoleMessageTarget.LoadLayoutAsync(url: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
url string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutFromString

StaticConsoleMessageTarget.LoadLayoutFromString(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
layout string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutFromStringAsync

StaticConsoleMessageTarget.LoadLayoutFromStringAsync(layout: string, override: boolean, partial: boolean): void

No description provided.

Parameters

Name Type Description
layout string No description provided.
override boolean No description provided.
partial boolean No description provided.

LoadLayoutSnippet

StaticConsoleMessageTarget.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

Name Type Description
snippet string No description provided.

MoveChildAfter

StaticConsoleMessageTarget.MoveChildAfter(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

MoveChildBefore

StaticConsoleMessageTarget.MoveChildBefore(arg0: unknown, arg1: unknown): void

No description provided.

Parameters

Name Type Description
arg0 unknown No description provided.
arg1 unknown No description provided.

RegisterForReadyEvents

StaticConsoleMessageTarget.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

Name Type Description
enable boolean Should this panel receive ready/unready events?

RemoveAndDeleteChildren

StaticConsoleMessageTarget.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

StaticConsoleMessageTarget.RemoveClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

ScrollParentToFitWhenFocused

StaticConsoleMessageTarget.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

StaticConsoleMessageTarget.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void

No description provided.

Parameters

Name Type Description
arg0 number No description provided.
arg1 boolean No description provided.

ScrollToBottom

StaticConsoleMessageTarget.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

StaticConsoleMessageTarget.ScrollToFitRegion(arg0: number, arg1: number, arg2: number, arg3: number, arg4: unknown, arg5: boolean, arg6: boolean): void

No description provided.

Parameters

Name Type Description
arg0 number No description provided.
arg1 number No description provided.
arg2 number No description provided.
arg3 number No description provided.
arg4 unknown No description provided.
arg5 boolean No description provided.
arg6 boolean No description provided.

ScrollToLeftEdge

StaticConsoleMessageTarget.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

StaticConsoleMessageTarget.ScrollToRightEdge(): void

No description provided.

ScrollToTop

StaticConsoleMessageTarget.ScrollToTop(): void

No description provided.

SetAcceptsFocus

StaticConsoleMessageTarget.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetAttributeInt

StaticConsoleMessageTarget.SetAttributeInt(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetAttributeString

StaticConsoleMessageTarget.SetAttributeString(attribute: string, value: string): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value string No description provided.

SetAttributeUInt32

StaticConsoleMessageTarget.SetAttributeUInt32(attribute: string, value: number): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
value number No description provided.

SetDialogVariable

StaticConsoleMessageTarget.SetDialogVariable(arg0: string, arg1: string): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 string No description provided.

SetDialogVariableFloat

StaticConsoleMessageTarget.SetDialogVariableFloat(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableInt

StaticConsoleMessageTarget.SetDialogVariableInt(arg0: string, arg1: number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 number No description provided.

SetDialogVariableTime

StaticConsoleMessageTarget.SetDialogVariableTime(arg0: string, arg1: string | number): void

No description provided.

Parameters

Name Type Description
arg0 string No description provided.
arg1 string | number No description provided.

SetDisableFocusOnMouseDown

StaticConsoleMessageTarget.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetDraggable

StaticConsoleMessageTarget.SetDraggable(istrue: boolean): void

No description provided.

Parameter

Name Type Description
istrue boolean No description provided.

SetFocus

StaticConsoleMessageTarget.SetFocus(focus: boolean): boolean

No description provided.

Parameter

Name Type Description
focus boolean No description provided.

SetHasClass

StaticConsoleMessageTarget.SetHasClass(classname: string, hasclass: boolean): void

No description provided.

Parameters

Name Type Description
classname string No description provided.
hasclass boolean No description provided.

SetInputNamespace

StaticConsoleMessageTarget.SetInputNamespace(arg0: string): void

No description provided.

Parameter

Name Type Description
arg0 string No description provided.

SetPanelEvent

StaticConsoleMessageTarget.SetPanelEvent(event: string, callback: Func<any[], void>): void

Sets an event trigger for this panel.

Example

latestUpdateImage.SetPanelEvent('onactivate', () => SteamOverlayAPI.OpenURLModal(item.link));

Parameters

Name Type Description
event string No description provided.
callback Func<any[], void> No description provided.

See also

SetParent

StaticConsoleMessageTarget.SetParent(parent: GenericPanel): void

No description provided.

Parameter

Name Type Description
parent GenericPanel No description provided.

SetReadyForDisplay

StaticConsoleMessageTarget.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetScrollParentToFitWhenFocused

StaticConsoleMessageTarget.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SetTopOfInputContext

StaticConsoleMessageTarget.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

Name Type Description
arg0 boolean No description provided.

SortChildrenOnAttribute

StaticConsoleMessageTarget.SortChildrenOnAttribute(attribute: string, ascending: boolean): void

No description provided.

Parameters

Name Type Description
attribute string No description provided.
ascending boolean No description provided.

SwitchClass

StaticConsoleMessageTarget.SwitchClass(oldclass: string, newclass: string): void

No description provided.

Parameters

Name Type Description
oldclass string No description provided.
newclass string No description provided.

ToggleClass

StaticConsoleMessageTarget.ToggleClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

TriggerClass

StaticConsoleMessageTarget.TriggerClass(classname: string): void

No description provided.

Parameter

Name Type Description
classname string No description provided.

UpdateCurrentAnimationKeyframes

StaticConsoleMessageTarget.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

Name Type Description
animation unknown No description provided.

UpdateFocusInContext

StaticConsoleMessageTarget.UpdateFocusInContext(): boolean

No description provided.