Interface | unrail-engine

Hierarchy

Interface

Index

Constructors

constructor

Accessors

updateInterval

Methods

Constructors

constructor

new Interface(): Interface

Returns Interface

Accessors

Static updateInterval

get updateInterval(): number

- Defined in src/render/interface.ts:99
Returns number

Methods

Static addButton

addButton(callback: string | InterfaceTextFunction, onClick?: InterfaceClickCallback, position?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom", options?: Object): void

- Defined in src/render/interface.ts:29
Parameters
- callback: string | InterfaceTextFunction
- Optional onClick: InterfaceClickCallback
- Optional position: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom"
- Optional options: Object
Returns void

Static addItem

addItem(callback: string | InterfaceTextFunction, position?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom", options?: Object): void

- Defined in src/render/interface.ts:25
Parameters
- callback: string | InterfaceTextFunction
- Optional position: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom"
- Optional options: Object
Returns void

Static Private addStyle

addStyle(style: string): void

- Defined in src/render/interface.ts:55
Parameters
- style: string
Returns void

Static Private addToDom

addToDom(item: InterfaceItem, index: number): void

- Defined in src/render/interface.ts:61
Parameters
- item: InterfaceItem
- index: number
Returns void

Static getItems

getItems(): InterfaceItem[]

- Defined in src/render/interface.ts:102
Returns InterfaceItem[]

Static init

init(): void

- Defined in src/render/interface.ts:42
Returns void

Static Private internalAddItem

internalAddItem(callback: string | InterfaceTextFunction, position?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom", options?: Object, onClick?: InterfaceClickCallback): void

- Defined in src/render/interface.ts:33
Parameters
- callback: string | InterfaceTextFunction
- Optional position: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "custom"
- Optional options: Object
- Optional onClick: InterfaceClickCallback
Returns void

Static setUpdateInterval

setUpdateInterval(rate: number): void

- Defined in src/render/interface.ts:95
Parameters
- rate: number
Returns void

Static statsShift

statsShift(height: number): void

- Defined in src/render/interface.ts:88
Parameters
- height: number
Returns void

Static update

update(): void

- Defined in src/render/interface.ts:77
Returns void

Generated using TypeDoc