Module wallmountedutil

Various functions and constants for working with the wallmounted value.

Functions

get_vector (id) Gets the vector for the given ID.
is_wallmounted (node) Checks if the given node is mounted to a wall or the ceiling.
to_facedir (wallmounted_id) Gets the corresponding facedir value for the given wallmounted value.

Tables

NEGATIVE_X_VECTOR The vector for the negative x direction.
NEGATIVE_Y_VECTOR The vector for the negative y direction.
NEGATIVE_Z_VECTOR The vector for the negative z direction.
POSITIVE_X_VECTOR The vector for the positive x direction.
POSITIVE_Y_VECTOR The vector for the positive y direction.
POSITIVE_Z_VECTOR The vector for the positive z direction.

Fields

NEGATIVE_X Attached to the node in the negative x direction.
NEGATIVE_Y Attached to the node in the negative y direction.
NEGATIVE_Z Attached to the node in the negative z direction.
POSITIVE_X Attached to the node in the positive y direction.
POSITIVE_Y Attached to the node in the positive y direction.
POSITIVE_Z Attached to the node in the positive y direction.


Functions

get_vector (id)
Gets the vector for the given ID.

Parameters:

  • id The ID for which to get the vector.

Returns:

    The vector for the given ID.
is_wallmounted (node)
Checks if the given node is mounted to a wall or the ceiling.

Parameters:

  • node The node.

Returns:

    true if the node is mounted at a wall or ceiling, false if it is mounted on the floor.
to_facedir (wallmounted_id)
Gets the corresponding facedir value for the given wallmounted value.

Parameters:

  • wallmounted_id The wallmounted value/ID.

Returns:

    The facedir value/ID.

Tables

NEGATIVE_X_VECTOR
The vector for the negative x direction.

Fields:

  • x
  • y
  • z
NEGATIVE_Y_VECTOR
The vector for the negative y direction.

Fields:

  • x
  • y
  • z
NEGATIVE_Z_VECTOR
The vector for the negative z direction.

Fields:

  • x
  • y
  • z
POSITIVE_X_VECTOR
The vector for the positive x direction.

Fields:

  • x
  • y
  • z
POSITIVE_Y_VECTOR
The vector for the positive y direction.

Fields:

  • x
  • y
  • z
POSITIVE_Z_VECTOR
The vector for the positive z direction.

Fields:

  • x
  • y
  • z

Fields

NEGATIVE_X
Attached to the node in the negative x direction.
NEGATIVE_Y
Attached to the node in the negative y direction.
NEGATIVE_Z
Attached to the node in the negative z direction.
POSITIVE_X
Attached to the node in the positive y direction.
POSITIVE_Y
Attached to the node in the positive y direction.
POSITIVE_Z
Attached to the node in the positive y direction.
generated by LDoc 1.4.2