Walking Light

• Index

Contents

• Functions

Topics

• methods
• commands
• settings
• readme

Topic methods

wlight Methods

Functions

wlight.set_debug (enabled)	Sets debugging mode.
wlight.register_item (iname[, radius])	Registers an item to emit light when wielded.
wlight.addLightItem (item)	DEPRECATED
wlight.register_armor (iname[, radius[, litem]])	Registers an item to emit light when equipped in armor inventory.
wlight.get_light_items ()	Retrieves list of items registered as emitting light when wielded.
wlight.getLightItems ()	DEPRECATED
wlight.mt_add_node (pos, sometable)	Adds a node to the world.
mt_add_node (pos, sometable)	DEPRECATED
wlight.poseq (pos1, pos2)
poseq (pos1, pos2)	DEPRECATED
wlight.remove_light ([player], pos)	Removes light at the given position.
remove_light (player, pos)	DEPRECATED
wlight.is_light_item (iname)	Checks if an item is registered as emitting light when wielded.
wlight.is_light_armor (iname)	Checks if an item is registered as emitting light when equipped in armor inventory.
wlight.wields_light (player)	Checks if player is wielding a light-emitting item.
wlight.update_node ()	Updates light node texture.

Functions

wlight.set_debug (enabled)

Sets debugging mode.

Parameters:

• enabled bool Determines if debugging is enabled.

wlight.register_item (iname[, radius])

Registers an item to emit light when wielded.

Parameters:

• iname string Item technical name.
• radius int Distance light will reach (max: 10). (optional)

wlight.addLightItem (item)

DEPRECATED Use wlight.register_item

Parameters:

• item

wlight.register_armor (iname[, radius[, litem]])

Registers an item to emit light when equipped in armor inventory.

Note: light radius will be overridden by light-emitting item being wielded.

Parameters:

• iname string Item technical name.
• radius int Distance light will reach (max: 10). (optional)
• litem bool Whether or not this item should also be registered with wlight.register_item. (optional)

wlight.get_light_items ()

Retrieves list of items registered as emitting light when wielded.

Returns:

table Table indexed by key.

wlight.getLightItems ()

DEPRECATED Use wlight.get_light_items

wlight.mt_add_node (pos, sometable)

Adds a node to the world.

Parameters:

• pos table Position.
• sometable table

mt_add_node (pos, sometable)

DEPRECATED Use wlight.mt_add_node

Parameters:

• pos
• sometable

wlight.poseq (pos1, pos2)

Parameters:

• pos1 table
• pos2 table

Returns:

bool

poseq (pos1, pos2)

DEPRECATED Use wlight.poseq

Parameters:

• pos1
• pos2

wlight.remove_light ([player], pos)

Removes light at the given position.

Parameters:

• player ObjectRef (optional)
• pos table Posistion where light will be removed.

remove_light (player, pos)

DEPRECATED Use wlight.remove_light

Parameters:

• player
• pos

wlight.is_light_item (iname)

Checks if an item is registered as emitting light when wielded.

Parameters:

• iname string Item technical name.

Returns:

bool true if item is registered.

wlight.is_light_armor (iname)

Checks if an item is registered as emitting light when equipped in armor inventory.

Parameters:

• iname string Item technical name.

Returns:

bool true if item is registered.

wlight.wields_light (player)

Checks if player is wielding a light-emitting item.

Parameters:

• player ObjectRef Player to be checked.

Returns:

bool true if player is wielding registered item.

wlight.update_node ()

Updates light node texture.

If debugging, node will display a marker, otherwise will be transparent.