Skip to content

@pumpkin-plugins/dynamic-lights-pumpkin API / platform/player-lights / readHeldLight

Function: readHeldLight() ​

readHeldLight(player, levels): object

Defined in: packages/dynamic-lights-pumpkin/src/platform/player-lights.ts:10

Reads the held source and its safe client position from the player's current world.

Parameters ​

player ​

Player

levels ​

HeldItemLightLevels | undefined

Returns ​

object

level ​

level: number

lightPosition ​

lightPosition: BlockPosition

position ​

position: BlockPosition

worldId ​

worldId: string

Pumpkin Plugins documentation