Interface: SteamInputAction
Interface describing base panel properties that all other panels extend.
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 | SteamInputAction | 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 | pano-typed.Style | No description provided. |
tabindex | number | No description provided. |
visible | boolean | No description provided. |
Functions
AcceptsFocus
SteamInputAction.AcceptsFocus(): boolean
No description provided.
AcceptsInput
SteamInputAction.AcceptsInput(): boolean
No description provided.
AddClass
SteamInputAction.AddClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ApplyStyles
SteamInputAction.ApplyStyles(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
BAscendantHasClass
SteamInputAction.BAscendantHasClass(arg0: string): boolean
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
CanSeeInParentScroll
SteamInputAction.CanSeeInParentScroll(): boolean
No description provided.
Children
SteamInputAction.Children(): pano-typed.GenericPanel[]
No description provided.
ClearPanelEvent
SteamInputAction.ClearPanelEvent(event: string): void
No description provided.
Parameter
| Name | Type | Description |
event | string | No description provided. |
ClearPropertyFromCode
SteamInputAction.ClearPropertyFromCode(arg0: unknown): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | unknown | No description provided. |
CreateChildren
SteamInputAction.CreateChildren(elements: string): boolean
No description provided.
Parameter
| Name | Type | Description |
elements | string | No description provided. |
CreateCopyOfCSSKeyframes
SteamInputAction.CreateCopyOfCSSKeyframes(animation: string): unknown
No description provided.
Parameter
| Name | Type | Description |
animation | string | No description provided. |
Data
SteamInputAction.Data(...args: any[]): void
No description provided.
Parameter
| Name | Type | Description |
...args | any[] | No description provided. |
DeleteAsync
SteamInputAction.DeleteAsync(delay: number): void
No description provided.
Parameter
| Name | Type | Description |
delay | number | No description provided. |
DeleteKeyframes
SteamInputAction.DeleteKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
FindChild
SteamInputAction.FindChild(id: string): pano-typed.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
SteamInputAction.FindChildInLayoutFile(id: string): pano-typed.T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
FindChildrenWithClassTraverse
SteamInputAction.FindChildrenWithClassTraverse(classname: string): pano-typed.T[]
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
FindChildTraverse
SteamInputAction.FindChildTraverse(id: string): pano-typed.T
No description provided.
Parameter
| Name | Type | Description |
id | string | No description provided. |
GetAttributeInt
SteamInputAction.GetAttributeInt(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetAttributeString
SteamInputAction.GetAttributeString(attribute: string, fallback: string): string
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | string | No description provided. |
GetAttributeUInt32
SteamInputAction.GetAttributeUInt32(attribute: string, fallback: number): number
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
fallback | number | No description provided. |
GetChild
SteamInputAction.GetChild(index: number): pano-typed.T
No description provided.
Parameter
| Name | Type | Description |
index | number | No description provided. |
GetChildCount
SteamInputAction.GetChildCount(): number
No description provided.
GetChildIndex
SteamInputAction.GetChildIndex(child: pano-typed.GenericPanel): number
No description provided.
Parameter
| Name | Type | Description |
child | pano-typed.GenericPanel | No description provided. |
GetFirstChild
SteamInputAction.GetFirstChild(): pano-typed.T
No description provided.
GetLastChild
SteamInputAction.GetLastChild(): pano-typed.T
No description provided.
GetLayoutFileDefine
SteamInputAction.GetLayoutFileDefine(def: string): unknown
No description provided.
Parameter
| Name | Type | Description |
def | string | No description provided. |
GetParent
SteamInputAction.GetParent(): pano-typed.T
No description provided.
GetPositionWithinWindow
SteamInputAction.GetPositionWithinWindow(): unknown
No description provided.
HasClass
SteamInputAction.HasClass(classname: string): boolean
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
HasDescendantKeyFocus
SteamInputAction.HasDescendantKeyFocus(): boolean
No description provided.
HasHoverStyle
SteamInputAction.HasHoverStyle(): boolean
No description provided.
HasKeyFocus
SteamInputAction.HasKeyFocus(): boolean
No description provided.
IsDraggable
SteamInputAction.IsDraggable(): boolean
No description provided.
IsReadyForDisplay
SteamInputAction.IsReadyForDisplay(): boolean
No description provided.
IsSelected
SteamInputAction.IsSelected(): boolean
No description provided.
IsSizeValid
SteamInputAction.IsSizeValid(): boolean
No description provided.
IsTransparent
SteamInputAction.IsTransparent(): boolean
No description provided.
IsValid
SteamInputAction.IsValid(): boolean
Check if this panel is still valid
LoadLayout
SteamInputAction.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
SteamInputAction.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
SteamInputAction.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
SteamInputAction.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
SteamInputAction.LoadLayoutSnippet(snippet: string): boolean
No description provided.
Parameter
| Name | Type | Description |
snippet | string | No description provided. |
MoveChildAfter
SteamInputAction.MoveChildAfter(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
MoveChildBefore
SteamInputAction.MoveChildBefore(arg0: unknown, arg1: unknown): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | unknown | No description provided. |
arg1 | unknown | No description provided. |
RegisterForReadyEvents
SteamInputAction.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
SteamInputAction.RemoveAndDeleteChildren(): void
No description provided.
RemoveClass
SteamInputAction.RemoveClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
ScrollParentToFitWhenFocused
SteamInputAction.ScrollParentToFitWhenFocused(): boolean
No description provided.
ScrollParentToMakePanelFit
SteamInputAction.ScrollParentToMakePanelFit(arg0: number, arg1: boolean): void
No description provided.
Parameters
| Name | Type | Description |
arg0 | number | No description provided. |
arg1 | boolean | No description provided. |
ScrollToBottom
SteamInputAction.ScrollToBottom(): void
No description provided.
ScrollToFitRegion
SteamInputAction.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
SteamInputAction.ScrollToLeftEdge(): void
No description provided.
ScrollToRightEdge
SteamInputAction.ScrollToRightEdge(): void
No description provided.
ScrollToTop
SteamInputAction.ScrollToTop(): void
No description provided.
SetAcceptsFocus
SteamInputAction.SetAcceptsFocus(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetAttributeInt
SteamInputAction.SetAttributeInt(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetAttributeString
SteamInputAction.SetAttributeString(attribute: string, value: string): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | string | No description provided. |
SetAttributeUInt32
SteamInputAction.SetAttributeUInt32(attribute: string, value: number): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
value | number | No description provided. |
SetDialogVariable
SteamInputAction.SetDialogVariable(name: string, value: string): void
Sets a dialog variable for the Panel.
Parameters
| Name | Type | Description |
name | string | No description provided. |
value | string | No description provided. |
See also
SetDialogVariableFloat
SteamInputAction.SetDialogVariableFloat(name: string, value: number): void
Sets a float dialog variable for the Panel.
Parameters
| Name | Type | Description |
name | string | No description provided. |
value | number | No description provided. |
See also
SetDialogVariableInt
SteamInputAction.SetDialogVariableInt(name: string, value: number): void
Sets an integer dialog variable for the Panel.
Parameters
| Name | Type | Description |
name | string | No description provided. |
value | number | No description provided. |
See also
SetDialogVariableTime
SteamInputAction.SetDialogVariableTime(name: string, value: string | number): void
Sets a time dialog variable for the Panel.
Parameters
| Name | Type | Description |
name | string | No description provided. |
value | string | number | No description provided. |
See also
SetDisableFocusOnMouseDown
SteamInputAction.SetDisableFocusOnMouseDown(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetDraggable
SteamInputAction.SetDraggable(istrue: boolean): void
No description provided.
Parameter
| Name | Type | Description |
istrue | boolean | No description provided. |
SetFocus
SteamInputAction.SetFocus(): boolean
No description provided.
SetHasClass
SteamInputAction.SetHasClass(classname: string, hasclass: boolean): void
No description provided.
Parameters
| Name | Type | Description |
classname | string | No description provided. |
hasclass | boolean | No description provided. |
SetInputNamespace
SteamInputAction.SetInputNamespace(arg0: string): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | string | No description provided. |
SetPanelEvent
SteamInputAction.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
| Name | Type | Description |
event | string | No description provided. |
callback | pano-typed.Func<any[], void> | No description provided. |
See also
SetParent
SteamInputAction.SetParent(parent: pano-typed.GenericPanel): void
No description provided.
Parameter
| Name | Type | Description |
parent | pano-typed.GenericPanel | No description provided. |
SetReadyForDisplay
SteamInputAction.SetReadyForDisplay(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetScrollParentToFitWhenFocused
SteamInputAction.SetScrollParentToFitWhenFocused(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SetTopOfInputContext
SteamInputAction.SetTopOfInputContext(arg0: boolean): void
No description provided.
Parameter
| Name | Type | Description |
arg0 | boolean | No description provided. |
SortChildrenOnAttribute
SteamInputAction.SortChildrenOnAttribute(attribute: string, ascending: boolean): void
No description provided.
Parameters
| Name | Type | Description |
attribute | string | No description provided. |
ascending | boolean | No description provided. |
SwitchClass
SteamInputAction.SwitchClass(oldclass: string, newclass: string): void
No description provided.
Parameters
| Name | Type | Description |
oldclass | string | No description provided. |
newclass | string | No description provided. |
ToggleClass
SteamInputAction.ToggleClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
TriggerClass
SteamInputAction.TriggerClass(classname: string): void
No description provided.
Parameter
| Name | Type | Description |
classname | string | No description provided. |
UpdateCurrentAnimationKeyframes
SteamInputAction.UpdateCurrentAnimationKeyframes(animation: unknown): void
No description provided.
Parameter
| Name | Type | Description |
animation | unknown | No description provided. |
UpdateFocusInContext
SteamInputAction.UpdateFocusInContext(): boolean
No description provided.