Class GraphicsSettings`Beta`

Settings category that manages GraphicsSettingsProperty configurations.

Index

Methods

get getAll set setAll

Methods

get

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

Remarks
Retrieves a graphics settings property value.
- Defined in tmp/package/index.d.ts:3810

getAll

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

Remarks
Retrieves all graphics settings properties and their values.
- Defined in tmp/package/index.d.ts:3818

set

set<T extends keyof GraphicsSettingsPropertyTypeMap>(
property: T,
value: GraphicsSettingsPropertyTypeMap[T],
): void
Beta
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.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:3831

setAll

setAll(properties: GraphicsSettingsPropertyTypeMap): void
Beta
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.

Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:3843