Class default

Hierarchy

default

Index

Constructors

Accessors

scaleNativeFactor

Methods

apply checkScaleFactor get getClamped getFloor getMaximum getMinimum getUserSetting scaleDown scaleUp setUserSetting update

Constructors

constructor

new default(): default
Returns default
- Defined in src/game/ui/util/ScaleManager.ts:22

Accessors

scaleNativeFactor

get scaleNativeFactor(): number
Returns number
- Defined in src/game/ui/util/ScaleManager.ts:18

Methods

apply

apply(value: number, floor?: number | "pixel"): number
Parameters
- value: number
- Optional floor: number | "pixel"
Returns number
- Defined in src/game/ui/util/ScaleManager.ts:26

checkScaleFactor

checkScaleFactor(): void
Returns void
- Defined in src/game/ui/util/ScaleManager.ts:136

get

get(): number
Returns the current UI scale (after being clamped by min & max).

Returns number
- Defined in src/game/ui/util/ScaleManager.ts:59

getClamped

getClamped(scale?: number): number
Parameters
- scale: number = ...
Returns number
- Defined in src/game/ui/util/ScaleManager.ts:67

getFloor

getFloor(floor?: number): number
Parameters
- floor: number = 1
Returns number
- Defined in src/game/ui/util/ScaleManager.ts:63

getMaximum

getMaximum(): number
Returns the maximum scale the screen size will allow.

Returns number
- Defined in src/game/ui/util/ScaleManager.ts:44

getMinimum

getMinimum(): number
Returns the minimum scale we allow, 0.5.

Returns number
- Defined in src/game/ui/util/ScaleManager.ts:37

getUserSetting

getUserSetting(): number
Returns the currently "requested" UI scale.

Returns number
- Defined in src/game/ui/util/ScaleManager.ts:74

scaleDown

scaleDown(): boolean
Returns boolean
- Defined in src/game/ui/util/ScaleManager.ts:101

scaleUp

scaleUp(): boolean
Returns boolean
- Defined in src/game/ui/util/ScaleManager.ts:91

setUserSetting

setUserSetting(scale: number): void
Requests a new UI scale, a multiplier of the default size.
Parameters
- scale: number
Returns void
- Defined in src/game/ui/util/ScaleManager.ts:86

update

update(force?: boolean): void
Updates the UI scale based on the current viewport.
Parameters
- force: boolean = false
Returns void
- Defined in src/game/ui/util/ScaleManager.ts:114

Generated using TypeDoc