Class default<PATHTYPE>

Type Parameters

PATHTYPE extends PathType = PathType

Hierarchy

default

Index

Methods

apply get refresh serialize setArgs setCustomPath setExtension setType applyPath cachebust deserialize equals of

Methods

apply

apply(component: default<HTMLElement>, variableName: string): default<PATHTYPE>
Parameters
- component: default<HTMLElement>
- variableName: string
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:189

get

get(isVariable?: boolean): null | string
Parameters
- isVariable: boolean = false
Returns null | string
- Defined in src/game/ui/util/ImagePath.ts:154

refresh

refresh(): void
Returns void
- Defined in src/game/ui/util/ImagePath.ts:146

serialize

serialize(): ISerializedImagePath
Returns ISerializedImagePath
- Defined in src/game/ui/util/ImagePath.ts:100

setArgs

setArgs(args?: ResourceOptionsMap[PATHTYPE]): default<PATHTYPE>
Parameters
- Optional args: ResourceOptionsMap[PATHTYPE]
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:134

setCustomPath

setCustomPath(customPath?: GetterOfOr<undefined | string | default<PathType>>): default<PATHTYPE>
Parameters
- Optional customPath: GetterOfOr<undefined | string | default<PathType>>
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:140

setExtension

setExtension(extension?: string): default<PATHTYPE>
Parameters
- extension: string = "png"
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:128

setType

setType(type: number): default<PATHTYPE>
Parameters
- type: number
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:118

`Static` applyPath

applyPath(component: default<HTMLElement>, path: undefined | string | default<PathType> | ISerializedImagePath, variableName: string): void
Parameters
- component: default<HTMLElement>
- path: undefined | string | default<PathType> | ISerializedImagePath
- variableName: string
Returns void
- Defined in src/game/ui/util/ImagePath.ts:59

`Static` cachebust

cachebust(): void
Returns void
- Defined in src/game/ui/util/ImagePath.ts:40

`Static` deserialize

deserialize(serialized: default<PathType> | ISerializedImagePath): default<PathType>
Parameters
- serialized: default<PathType> | ISerializedImagePath
Returns default<PathType>
- Defined in src/game/ui/util/ImagePath.ts:53

`Static` equals

equals(imagePath?: string | default<PathType> | ISerializedImagePath, imagePath2?: string | default<PathType> | ISerializedImagePath): boolean
Parameters
- Optional imagePath: string | default<PathType> | ISerializedImagePath
- Optional imagePath2: string | default<PathType> | ISerializedImagePath
Returns boolean
- Defined in src/game/ui/util/ImagePath.ts:89

`Static` of

of<PATHTYPE>(pathType: PATHTYPE, id: number): default<PATHTYPE>
Type Parameters
- PATHTYPE extends PathType
Parameters
- pathType: PATHTYPE
- id: number
Returns default<PATHTYPE>
- Defined in src/game/ui/util/ImagePath.ts:47
of(path: string): default<PathType>
Parameters
- path: string
Returns default<PathType>
- Defined in src/game/ui/util/ImagePath.ts:48

Generated using TypeDoc