DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|func_rotate|section}}

Rotate owned geometry as a door or a continuously moving object.

Placement: Geometry owned by the entity.

== Set it up ==

Parent the geometry beneath the marker and choose local Rotation Axes. Door mode moves between closed and Angle; continuous mode uses open/start to run and close/stop to pause. reverse and set_phase apply to continuous mode. Put a rotating child beneath a moving parent when it should move with that parent.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>rotation_axes</code> Rotation Axes || Y (<code>2</code>) || Local rotation axes. Select one or more axes. Choices: None (<code>0</code>), X (<code>1</code>), Y (<code>2</code>), Z (<code>4</code>), All (<code>7</code>).
|-
| <code>angle</code> Angle || <code>90</code> || Door mode only. Signed angle in degrees between closed and open.
|-
| <code>speed</code> Speed || <code>90</code> || Rotation speed in degrees per second. Minimum: <code>0.01</code>.
|-
| <code>loop_continuously</code> Loop Continuously || <code>false</code> || Rotate continuously on the server tick instead of moving between door-style endpoints. Open/Start runs the rotator; Close/Stop pauses it.
|-
| <code>start_phase</code> Start Phase || <code>0</code> || Continuous mode only. Initial rotation phase in degrees around every selected axis.
|-
| <code>start_active</code> Start Active || <code>true</code> || Continuous mode only. Start rotating as soon as the entity initializes.
|-
| <code>reverse_direction</code> Reverse Direction || <code>false</code> || Continuous mode only. Begin rotating in the negative direction.
|-
| <code>reset_delay</code> Reset Delay || <code>-1</code> || Door mode only. Automatically close after this delay. -1 never closes automatically. Minimum: <code>-1</code>.
|-
| <code>start_locked</code> Start Locked || <code>false</code> || Value type: <code>bool</code>.
|-
| <code>start_open</code> Start Open || <code>false</code> || Door mode only. Begin at the open endpoint.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>true</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>close</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>lock</code> || <code>string</code> || Server
|-
| Input || <code>open</code> || <code>string</code> || Server
|-
| Input || <code>reverse</code> || <code>string</code> || Server
|-
| Input || <code>set_angle</code> || <code>float</code> || Server
|-
| Input || <code>set_phase</code> || <code>float</code> || Server
|-
| Input || <code>set_speed</code> || <code>float</code> || Server
|-
| Input || <code>start</code> || <code>string</code> || Server
|-
| Input || <code>stop</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>string</code> || Server
|-
| Input || <code>unlock</code> || <code>string</code> || Server
|-
| Output || <code>close</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>open</code> || <code>string</code> || Server
|-
| Output || <code>started</code> || <code>string</code> || Server
|-
| Output || <code>stopped</code> || <code>string</code> || Server
|-
| Property || <code>angle</code> || <code>float</code> || Server; read/write
|-
| Property || <code>is_active</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>is_locked</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>is_open</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>is_reversed</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>phase</code> || <code>float</code> || Server; read/write
|-
| Property || <code>speed</code> || <code>float</code> || Server; read/write
|-
| State || <code>state</code> || <code>RotateEntityState</code> || Server; read/write
|}

Capture <code>ref.state</code> from one matching entity and use <code>ref.restore(saved_state)</code> to restore a compatible snapshot.

[[Category:Grimwar entities]]

Grimwar/Entities/func rotate - Revision history

DocumentationBot: Version 1