For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/GraphicsSettings.md.

Class: GraphicsSettings experimental

Beta

Settings category that manages GraphicsSettingsProperty configurations.

Methods

get()

get<T>(property): GraphicsSettingsPropertyTypeMap[T] | undefined

Beta

Type Parameters

T

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.


getAll()

getAll(): GraphicsSettingsPropertyTypeMap

Beta

Returns

GraphicsSettingsPropertyTypeMap

Returns a property value map for all available properties.

Remarks

Retrieves all graphics settings properties and their values.


set()

set<T>(property, value): void

World Mutation Beta

Type Parameters

T

T extends keyof GraphicsSettingsPropertyTypeMap

Parameters

property

T

Property identifier.

value

GraphicsSettingsPropertyTypeMap[T]

New property value.

Returns

void

Remarks

Modifies a graphics settings property value.

Throws

This function can throw errors.


setAll()

setAll(properties): void

World Mutation 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.

Throws

This function can throw errors.