Interface: SettingsEnumDropDown

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

SettingsEnumDropDown.AcceptsFocus(): boolean

No description provided.

AcceptsInput

SettingsEnumDropDown.AcceptsInput(): boolean

No description provided.

AddClass

SettingsEnumDropDown.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

SettingsEnumDropDown.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

SettingsEnumDropDown.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

SettingsEnumDropDown.CanSeeInParentScroll(): boolean

No description provided.

Children

SettingsEnumDropDown.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

SettingsEnumDropDown.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

SettingsEnumDropDown.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

SettingsEnumDropDown.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

SettingsEnumDropDown.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

SettingsEnumDropDown.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

SettingsEnumDropDown.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

SettingsEnumDropDown.FindChild(id: string): T

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

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

SettingsEnumDropDown.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

SettingsEnumDropDown.FindChildTraverse(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

SettingsEnumDropDown.GetChild(index: number): T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

SettingsEnumDropDown.GetChildCount(): number

No description provided.

GetChildIndex

SettingsEnumDropDown.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childGenericPanel No description provided.

GetFirstChild

SettingsEnumDropDown.GetFirstChild(): T

No description provided.

GetLastChild

SettingsEnumDropDown.GetLastChild(): T

No description provided.

GetLayoutFileDefine

SettingsEnumDropDown.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

SettingsEnumDropDown.GetParent(): T

No description provided.

GetPositionWithinWindow

SettingsEnumDropDown.GetPositionWithinWindow(): unknown

No description provided.

HasClass

SettingsEnumDropDown.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

SettingsEnumDropDown.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

SettingsEnumDropDown.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

SettingsEnumDropDown.HasKeyFocus(): boolean

No description provided.

IsDraggable

SettingsEnumDropDown.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

SettingsEnumDropDown.IsReadyForDisplay(): boolean

No description provided.

IsSelected

SettingsEnumDropDown.IsSelected(): boolean

No description provided.

IsSizeValid

SettingsEnumDropDown.IsSizeValid(): boolean

No description provided.

IsTransparent

SettingsEnumDropDown.IsTransparent(): boolean

No description provided.

IsValid

SettingsEnumDropDown.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

SettingsEnumDropDown.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

OnShow

SettingsEnumDropDown.OnShow(): void

No description provided.

RefreshDisplay

SettingsEnumDropDown.RefreshDisplay(): void

No description provided.

RegisterForReadyEvents

SettingsEnumDropDown.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

SettingsEnumDropDown.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

SettingsEnumDropDown.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

RestoreCVarDefault

SettingsEnumDropDown.RestoreCVarDefault(): void

Set the cvar back to default

ScrollParentToFitWhenFocused

SettingsEnumDropDown.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

SettingsEnumDropDown.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

SettingsEnumDropDown.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

SettingsEnumDropDown.ScrollToRightEdge(): void

No description provided.

ScrollToTop

SettingsEnumDropDown.ScrollToTop(): void

No description provided.

SetAcceptsFocus

SettingsEnumDropDown.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1stringNo description provided.

SetDialogVariableFloat

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableInt

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableTime

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1string | numberNo description provided.

SetDisableFocusOnMouseDown

SettingsEnumDropDown.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

SettingsEnumDropDown.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

SettingsEnumDropDown.SetFocus(focus: boolean): boolean

No description provided.

Parameter

NameTypeDescription
focusbooleanNo description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

SettingsEnumDropDown.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

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

SettingsEnumDropDown.SetParent(parent: GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentGenericPanel No description provided.

SetReadyForDisplay

SettingsEnumDropDown.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

SettingsEnumDropDown.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

SettingsEnumDropDown.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

SettingsEnumDropDown.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

SettingsEnumDropDown.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

SettingsEnumDropDown.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

SettingsEnumDropDown.UpdateFocusInContext(): boolean

No description provided.