Settlements

Settlements

new Settlements()

Creates an instance of the SkyCiv Settlements class.

Source:

Extends

Methods

(static) add(node, tx, ty, tz, rx, ry, rz)

Create a settlement with the next available ID.

Parameters:
Name Type Description
node number

The ID of the node at which the settlement is applied.

tx number

Settlement displacement in the global x-axis.

ty number

Settlement displacement in the global y-axis.

tz number

Settlement displacement in the global z-axis.

rx number

Settlement rotation about the global x-axis.

ry number

Settlement rotation about the global y-axis.

rz number

Settlement rotation about the global z-axis.

Source:

(static) idFromNodeId(node_id)

Find an settlements's ID from the node ID which it is located.

Parameters:
Name Type Description
node_id number

The node ID of the settlement to find.

Source: