Interface: StaticConsoleMessageTarget

A console message target.

Properties

NameTypeDescription
activationenabledbooleanNo description provided.
actuallayoutheightnumberNo description provided.
actuallayoutwidthnumberNo description provided.
actualuiscale_xnumberNo description provided.
actualuiscale_ynumberNo description provided.
actualxoffsetnumberNo description provided.
actualyoffsetnumberNo description provided.
checkedbooleanNo description provided.
contentheightnumberNo description provided.
contentwidthnumberNo description provided.
defaultfocusstringNo description provided.
desiredlayoutheightnumberNo description provided.
desiredlayoutwidthnumberNo description provided.
enabledbooleanNo description provided.
hittestbooleanNo description provided.
hittestchildrenbooleanNo description provided.
idstringNo description provided.
inputnamespacestringNo description provided.
layoutfilestringNo description provided.
paneltypeStaticConsoleMessageTargetNo description provided.
rememberchildfocusbooleanNo description provided.
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
styleStyle No description provided.
tabindexnumberNo description provided.
visiblebooleanNo 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

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

StaticConsoleMessageTarget.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

StaticConsoleMessageTarget.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo 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

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

StaticConsoleMessageTarget.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

StaticConsoleMessageTarget.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

StaticConsoleMessageTarget.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

StaticConsoleMessageTarget.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

StaticConsoleMessageTarget.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

StaticConsoleMessageTarget.FindChild(id: string): T

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

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

StaticConsoleMessageTarget.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

StaticConsoleMessageTarget.FindChildTraverse(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

StaticConsoleMessageTarget.GetChild(index: number): T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

StaticConsoleMessageTarget.GetChildCount(): number

No description provided.

GetChildIndex

StaticConsoleMessageTarget.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childGenericPanel 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

NameTypeDescription
defstringNo 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

NameTypeDescription
classnamestringNo 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

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutAsync

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

No description provided.

Parameters

NameTypeDescription
urlstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromString

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

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutFromStringAsync

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

No description provided.

Parameters

NameTypeDescription
layoutstringNo description provided.
overridebooleanNo description provided.
partialbooleanNo description provided.

LoadLayoutSnippet

StaticConsoleMessageTarget.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

StaticConsoleMessageTarget.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

StaticConsoleMessageTarget.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

StaticConsoleMessageTarget.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

StaticConsoleMessageTarget.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo 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

NameTypeDescription
arg0numberNo description provided.
arg1numberNo description provided.
arg2numberNo description provided.
arg3numberNo description provided.
arg4unknownNo description provided.
arg5booleanNo description provided.
arg6booleanNo 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

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1stringNo description provided.

SetDialogVariableFloat

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableInt

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableTime

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1string | numberNo description provided.

SetDisableFocusOnMouseDown

StaticConsoleMessageTarget.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

StaticConsoleMessageTarget.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

StaticConsoleMessageTarget.SetFocus(focus: boolean): boolean

No description provided.

Parameter

NameTypeDescription
focusbooleanNo description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

StaticConsoleMessageTarget.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo 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

NameTypeDescription
eventstringNo description provided.
callbackFunc<any[], void>No description provided.

See also

SetParent

StaticConsoleMessageTarget.SetParent(parent: GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentGenericPanel No description provided.

SetReadyForDisplay

StaticConsoleMessageTarget.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

StaticConsoleMessageTarget.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

StaticConsoleMessageTarget.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

StaticConsoleMessageTarget.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

StaticConsoleMessageTarget.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

StaticConsoleMessageTarget.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

StaticConsoleMessageTarget.UpdateFocusInContext(): boolean

No description provided.