Interface: NumberEntry

An interactive number input. Values are all integers internally.

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.
incrementnumberNo description provided.
inputnamespacestringNo description provided.
layoutfilestringNo description provided.
maxnumberNo description provided.
minnumberNo description provided.
paneltypeNumberEntryNo 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.
valuenumberNo description provided.
visiblebooleanNo description provided.

Functions

AcceptsFocus

NumberEntry.AcceptsFocus(): boolean

No description provided.

AcceptsInput

NumberEntry.AcceptsInput(): boolean

No description provided.

AddClass

NumberEntry.AddClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ApplyStyles

NumberEntry.ApplyStyles(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

BAscendantHasClass

NumberEntry.BAscendantHasClass(arg0: string): boolean

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

CanSeeInParentScroll

NumberEntry.CanSeeInParentScroll(): boolean

No description provided.

Children

NumberEntry.Children(): GenericPanel[]

No description provided.

ClearPanelEvent

NumberEntry.ClearPanelEvent(event: string): void

No description provided.

Parameter

NameTypeDescription
eventstringNo description provided.

ClearPropertyFromCode

NumberEntry.ClearPropertyFromCode(arg0: unknown): void

No description provided.

Parameter

NameTypeDescription
arg0unknownNo description provided.

CreateChildren

NumberEntry.CreateChildren(elements: string): boolean

No description provided.

Parameter

NameTypeDescription
elementsstringNo description provided.

CreateCopyOfCSSKeyframes

NumberEntry.CreateCopyOfCSSKeyframes(animation: string): unknown

No description provided.

Parameter

NameTypeDescription
animationstringNo description provided.

Data

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

No description provided.

Parameter

NameTypeDescription
...argsany[]No description provided.

DeleteAsync

NumberEntry.DeleteAsync(delay: number): void

No description provided.

Parameter

NameTypeDescription
delaynumberNo description provided.

DeleteKeyframes

NumberEntry.DeleteKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

FindChild

NumberEntry.FindChild(id: string): T

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

Parameter

NameTypeDescription
idstringNo description provided.

FindChildInLayoutFile

NumberEntry.FindChildInLayoutFile(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

FindChildrenWithClassTraverse

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

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

FindChildTraverse

NumberEntry.FindChildTraverse(id: string): T

No description provided.

Parameter

NameTypeDescription
idstringNo description provided.

GetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbackstringNo description provided.

GetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
fallbacknumberNo description provided.

GetChild

NumberEntry.GetChild(index: number): T

No description provided.

Parameter

NameTypeDescription
indexnumberNo description provided.

GetChildCount

NumberEntry.GetChildCount(): number

No description provided.

GetChildIndex

NumberEntry.GetChildIndex(child: GenericPanel): number

No description provided.

Parameter

NameTypeDescription
childGenericPanel No description provided.

GetFirstChild

NumberEntry.GetFirstChild(): T

No description provided.

GetLastChild

NumberEntry.GetLastChild(): T

No description provided.

GetLayoutFileDefine

NumberEntry.GetLayoutFileDefine(def: string): unknown

No description provided.

Parameter

NameTypeDescription
defstringNo description provided.

GetParent

NumberEntry.GetParent(): T

No description provided.

GetPositionWithinWindow

NumberEntry.GetPositionWithinWindow(): unknown

No description provided.

HasClass

NumberEntry.HasClass(classname: string): boolean

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

HasDescendantKeyFocus

NumberEntry.HasDescendantKeyFocus(): boolean

No description provided.

HasHoverStyle

NumberEntry.HasHoverStyle(): boolean

No description provided.

HasKeyFocus

NumberEntry.HasKeyFocus(): boolean

No description provided.

IsDraggable

NumberEntry.IsDraggable(): boolean

No description provided.

IsReadyForDisplay

NumberEntry.IsReadyForDisplay(): boolean

No description provided.

IsSelected

NumberEntry.IsSelected(): boolean

No description provided.

IsSizeValid

NumberEntry.IsSizeValid(): boolean

No description provided.

IsTransparent

NumberEntry.IsTransparent(): boolean

No description provided.

IsValid

NumberEntry.IsValid(): boolean

Check if this panel is still valid

LoadLayout

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

No description provided.

Parameters

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

LoadLayoutAsync

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

No description provided.

Parameters

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

LoadLayoutFromString

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

No description provided.

Parameters

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

LoadLayoutFromStringAsync

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

No description provided.

Parameters

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

LoadLayoutSnippet

NumberEntry.LoadLayoutSnippet(snippet: string): boolean

No description provided.

Parameter

NameTypeDescription
snippetstringNo description provided.

MoveChildAfter

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

MoveChildBefore

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

No description provided.

Parameters

NameTypeDescription
arg0unknownNo description provided.
arg1unknownNo description provided.

RegisterForReadyEvents

NumberEntry.RegisterForReadyEvents(enable: boolean): void

Registers this panel to receive ready/unready events.

Parameter

NameTypeDescription
enablebooleanShould this panel receive ready/unready events?

RemoveAndDeleteChildren

NumberEntry.RemoveAndDeleteChildren(): void

No description provided.

RemoveClass

NumberEntry.RemoveClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

ScrollParentToFitWhenFocused

NumberEntry.ScrollParentToFitWhenFocused(): boolean

No description provided.

ScrollParentToMakePanelFit

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

No description provided.

Parameters

NameTypeDescription
arg0numberNo description provided.
arg1booleanNo description provided.

ScrollToBottom

NumberEntry.ScrollToBottom(): void

No description provided.

ScrollToFitRegion

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

NumberEntry.ScrollToLeftEdge(): void

No description provided.

ScrollToRightEdge

NumberEntry.ScrollToRightEdge(): void

No description provided.

ScrollToTop

NumberEntry.ScrollToTop(): void

No description provided.

SetAcceptsFocus

NumberEntry.SetAcceptsFocus(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetAttributeInt

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetAttributeString

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuestringNo description provided.

SetAttributeUInt32

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
valuenumberNo description provided.

SetDialogVariable

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1stringNo description provided.

SetDialogVariableFloat

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableInt

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1numberNo description provided.

SetDialogVariableTime

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

No description provided.

Parameters

NameTypeDescription
arg0stringNo description provided.
arg1string | numberNo description provided.

SetDisableFocusOnMouseDown

NumberEntry.SetDisableFocusOnMouseDown(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetDraggable

NumberEntry.SetDraggable(istrue: boolean): void

No description provided.

Parameter

NameTypeDescription
istruebooleanNo description provided.

SetFocus

NumberEntry.SetFocus(focus: boolean): boolean

No description provided.

Parameter

NameTypeDescription
focusbooleanNo description provided.

SetHasClass

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

No description provided.

Parameters

NameTypeDescription
classnamestringNo description provided.
hasclassbooleanNo description provided.

SetInputNamespace

NumberEntry.SetInputNamespace(arg0: string): void

No description provided.

Parameter

NameTypeDescription
arg0stringNo description provided.

SetPanelEvent

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

NumberEntry.SetParent(parent: GenericPanel): void

No description provided.

Parameter

NameTypeDescription
parentGenericPanel No description provided.

SetReadyForDisplay

NumberEntry.SetReadyForDisplay(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetScrollParentToFitWhenFocused

NumberEntry.SetScrollParentToFitWhenFocused(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SetTopOfInputContext

NumberEntry.SetTopOfInputContext(arg0: boolean): void

No description provided.

Parameter

NameTypeDescription
arg0booleanNo description provided.

SortChildrenOnAttribute

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

No description provided.

Parameters

NameTypeDescription
attributestringNo description provided.
ascendingbooleanNo description provided.

SwitchClass

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

No description provided.

Parameters

NameTypeDescription
oldclassstringNo description provided.
newclassstringNo description provided.

ToggleClass

NumberEntry.ToggleClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

TriggerClass

NumberEntry.TriggerClass(classname: string): void

No description provided.

Parameter

NameTypeDescription
classnamestringNo description provided.

UpdateCurrentAnimationKeyframes

NumberEntry.UpdateCurrentAnimationKeyframes(animation: unknown): void

No description provided.

Parameter

NameTypeDescription
animationunknownNo description provided.

UpdateFocusInContext

NumberEntry.UpdateFocusInContext(): boolean

No description provided.