Interface: SettingsEnumBitField

Interface describing base panel properties that all other panels extend.

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.
convarstringNo 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.
paneltypeSettingsEnumBitFieldNo description provided.
rememberchildfocusbooleanNo description provided.
scrolloffset_xnumberNo description provided.
scrolloffset_ynumberNo description provided.
selectionpos_xnumberNo description provided.
selectionpos_ynumberNo description provided.
stylepano-typed.StyleNo description provided.
tabindexnumberNo description provided.
visiblebooleanNo description provided.

Functions

AcceptsFocus

SettingsEnumBitField.AcceptsFocus(): boolean

No description provided.

AcceptsInput

SettingsEnumBitField.AcceptsInput(): boolean

No description provided.

AddClass

SettingsEnumBitField.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

SettingsEnumBitField.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

SettingsEnumBitField.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

SettingsEnumBitField.CanSeeInParentScroll(): boolean

No description provided.

Children

SettingsEnumBitField.Children(): pano-typed.GenericPanel[]

No description provided.

ClearPanelEvent

SettingsEnumBitField.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

SettingsEnumBitField.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

SettingsEnumBitField.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

SettingsEnumBitField.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

SettingsEnumBitField.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

SettingsEnumBitField.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

SettingsEnumBitField.FindChild(id: string): pano-typed.T

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

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

SettingsEnumBitField.FindChildInLayoutFile(id: string): pano-typed.T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

SettingsEnumBitField.FindChildrenWithClassTraverse(classname: string): pano-typed.T[]

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

SettingsEnumBitField.FindChildTraverse(id: string): pano-typed.T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

SettingsEnumBitField.GetChild(index: number): pano-typed.T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

SettingsEnumBitField.GetChildCount(): number

No description provided.

GetChildIndex

SettingsEnumBitField.GetChildIndex(child: pano-typed.GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childpano-typed.GenericPanelNo description provided.

GetFirstChild

SettingsEnumBitField.GetFirstChild(): pano-typed.T

No description provided.

GetLastChild

SettingsEnumBitField.GetLastChild(): pano-typed.T

No description provided.

GetLayoutFileDefine

SettingsEnumBitField.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

SettingsEnumBitField.GetParent(): pano-typed.T

No description provided.

GetPositionWithinWindow

SettingsEnumBitField.GetPositionWithinWindow(): unknown

No description provided.

HasClass

SettingsEnumBitField.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

SettingsEnumBitField.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

SettingsEnumBitField.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

SettingsEnumBitField.HasKeyFocus(): boolean

No description provided.

IsDraggable

SettingsEnumBitField.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

SettingsEnumBitField.IsReadyForDisplay(): boolean

No description provided.

IsSelected

SettingsEnumBitField.IsSelected(): boolean

No description provided.

IsSizeValid

SettingsEnumBitField.IsSizeValid(): boolean

No description provided.

IsTransparent

SettingsEnumBitField.IsTransparent(): boolean

No description provided.

IsValid

SettingsEnumBitField.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

SettingsEnumBitField.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

SettingsEnumBitField.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

SettingsEnumBitField.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

SettingsEnumBitField.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

SettingsEnumBitField.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

SettingsEnumBitField.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

SettingsEnumBitField.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

SettingsEnumBitField.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

SettingsEnumBitField.ScrollToRightEdge(): void

No description provided.

ScrollToTop

SettingsEnumBitField.ScrollToTop(): void

No description provided.

SetAcceptsFocus

SettingsEnumBitField.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

SettingsEnumBitField.SetDialogVariable(name: string, value: string): void

Sets a dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestringNo description provided.

SetDialogVariableFloat

SettingsEnumBitField.SetDialogVariableFloat(name: string, value: number): void

Sets a float dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableInt

SettingsEnumBitField.SetDialogVariableInt(name: string, value: number): void

Sets an integer dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuenumberNo description provided.

SetDialogVariableTime

SettingsEnumBitField.SetDialogVariableTime(name: string, value: string | number): void

Sets a time dialog variable for the Panel.

Parameters

NameTypeDescription
namestringNo description provided.
valuestring | numberNo description provided.

SetDisableFocusOnMouseDown

SettingsEnumBitField.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

SettingsEnumBitField.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

SettingsEnumBitField.SetFocus(): boolean

No description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

SettingsEnumBitField.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

SettingsEnumBitField.SetPanelEvent(event: string, callback: pano-typed.Func<any[], void>): void

Sets an event trigger for this panel.

Example

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

Parameters

NameTypeDescription
eventstringNo description provided.
callbackpano-typed.Func<any[], void>No description provided.

See also

SetParent

SettingsEnumBitField.SetParent(parent: pano-typed.GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentpano-typed.GenericPanelNo description provided.

SetReadyForDisplay

SettingsEnumBitField.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

SettingsEnumBitField.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

SettingsEnumBitField.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

SettingsEnumBitField.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

SettingsEnumBitField.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

SettingsEnumBitField.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

SettingsEnumBitField.UpdateFocusInContext(): boolean

No description provided.