Skip to content

@pumpkin-plugins/dynamic-lights-pumpkin API / lights/player-preferences / PlayerLightPreferences

Class: PlayerLightPreferences ​

Defined in: packages/dynamic-lights-pumpkin/src/lights/player-preferences.ts:7

Stores the players who have chosen to hide dynamic lights.

Methods ​

isEnabled() ​

isEnabled(playerName): boolean

Defined in: packages/dynamic-lights-pumpkin/src/lights/player-preferences.ts:15

Returns whether a player has dynamic lights enabled.

Parameters ​

playerName ​

string

Returns ​

boolean


toggle() ​

toggle(playerName): boolean

Defined in: packages/dynamic-lights-pumpkin/src/lights/player-preferences.ts:20

Toggles a player's setting and returns whether dynamic lights are now enabled.

Parameters ​

playerName ​

string

Returns ​

boolean

Pumpkin Plugins documentation