Class GraphicsSettings

Settings category that manages GraphicsSettingsProperty configurations.

Index

Constructors

Methods

get getAll set setAll

Constructors

`Private`constructor

new GraphicsSettings(): GraphicsSettings
Returns GraphicsSettings

Methods

get

get<T extends keyof GraphicsSettingsPropertyTypeMap>(
property: T,
): GraphicsSettingsPropertyTypeMap[T]
Type Parameters
- T extends keyof GraphicsSettingsPropertyTypeMap
Parameters
- property: T
  Property identifier.
Returns GraphicsSettingsPropertyTypeMap[T]
Returns the property value if it is found. If the property is not available, it returns undefined.

Remarks
Retrieves a graphics settings property value.

getAll

getAll(): GraphicsSettingsPropertyTypeMap
Returns GraphicsSettingsPropertyTypeMap
Returns a property value map for all available properties.

Remarks
Retrieves all graphics settings properties and their values.

set

set<T extends keyof GraphicsSettingsPropertyTypeMap>(
property: T,
value: GraphicsSettingsPropertyTypeMap[T],
): void
Type Parameters
- T extends keyof GraphicsSettingsPropertyTypeMap
Parameters
- property: T
  Property identifier.
- value: GraphicsSettingsPropertyTypeMap[T]
  New property value.
Returns void
Remarks
Modifies a graphics settings property value.

This function can't be called in read-only mode.

Throws
This function can throw errors.

setAll

setAll(properties: GraphicsSettingsPropertyTypeMap): void
Parameters
- properties: GraphicsSettingsPropertyTypeMap
  Property map to set available property values. If the property is not defined in the map, it will not be modified.
Returns void
Remarks
Modify multiple graphics settings properties.

This function can't be called in read-only mode.

Throws
This function can throw errors.