Lift
A userdata object representing a lift in the game.
Values:
-
Get: Returns the id of a lift.
-
Get: Returns the level of a lift.
-
worldPosition[ Vec3 ]Get: Returns the world position of a lift.
Operations:
| Operation | Returns | Description |
|---|---|---|
Lift == Lift |
boolean | Checks if two instances of Lift refer to the same Lift. |
Server + Client
getId
lift:getId( )
Returns the id of a lift.
Parameters:
| Name | Type | Description |
|---|---|---|
lift |
Lift | The lift. |
Returns:
| Type | Description |
|---|---|
| integer | The lift's id. |
getLevel
lift:getLevel( )
Returns the level of a lift.
Parameters:
| Name | Type | Description |
|---|---|---|
lift |
Lift | The lift. |
Returns:
| Type | Description |
|---|---|
| integer | The lift's level. |
getWorldPosition
lift:getWorldPosition( )
Returns the world position of a lift.
Parameters:
| Name | Type | Description |
|---|---|---|
lift |
Lift | The lift. |
Returns:
| Type | Description |
|---|---|
| Vec3 | The lift's world position. |
hasBodies
lift:hasBodies( )
Returns whether there's a body on the lift.
Parameters:
| Name | Type | Description |
|---|---|---|
lift |
Lift | The lift. |
Returns:
| Type | Description |
|---|---|
| boolean | Returns true if the lift has a body. |
Server-only
destroy
lift:destroy( )
Destroys a lift.
Parameters:
| Name | Type | Description |
|---|---|---|
lift |
Lift | The lift. |