DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|func_tracktrain|section}}

Move owned geometry along an authored path.

Placement: Geometry owned by the entity.

== Set it up ==

Parent moving geometry beneath the entity. Edit Path Points in the inspector or viewport; they are local metre coordinates relative to the authored pivot. Use at least two distinct consecutive points. The compiler creates the external spline, so you do not need to create a Unity SplineContainer in Vertex. Choose Stop, Loop, or Ping Pong for end behavior. set_progress takes 0..1 and fails while locked. Signed set_speed selects direction. Locking blocks control inputs but does not stop motion already in progress.

== Settings ==

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

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>path_smooth</code> Smooth curves || <code>false</code> || Smooth the path through its points. Turn off for straight segments and sharp corners.
|-
| <code>path_closed</code> Closed path || <code>false</code> || Join the last point to the first. Movement and end behaviour are configured separately.
|-
| <code>spline_container</code> Path points || <code>[[0, 0, 0], [0, 0, -4]]</code> || Ordered points relative to the authored pivot. The generated path stays outside the moving entity. Drag points in a viewport or enter their coordinates below. Ordered list. At least 2 entries. Units: metres.
|-
| <code>start_progress01</code> Start Progress 01 || <code>0</code> || Initial position along the spline, using its normalized 0-1 parameter. Minimum: <code>0</code>. Maximum: <code>1</code>.
|-
| <code>follow_spline_rotation</code> Follow Spline Rotation || <code>true</code> || Rotate the train to follow the spline tangent and up direction.
|-
| <code>rotation_offset</code> Rotation Offset || <code>[0, 0, 0]</code> || Euler offset applied after the spline rotation. Use this when the authored model faces a different local axis.
|-
| <code>speed</code> Speed || <code>4</code> || World units per second along the spline. Runtime set_speed accepts a signed value. Minimum: <code>0.01</code>.
|-
| <code>end_behavior</code> End Behavior || Stop (<code>0</code>) || What happens when the train reaches either end of the spline. Choices: Stop (<code>0</code>), Loop (<code>1</code>), Ping Pong (<code>2</code>).
|-
| <code>damage</code> Damage || <code>0</code> || Damage dealt when the moving train drives into a damageable target. Separating and tangential contacts do not deal damage. 0 disables it. Minimum: <code>0</code>.
|-
| <code>damage_cooldown_seconds</code> Damage Cooldown Seconds || <code>0.25</code> || Minimum seconds between collision-damage events against the same target. Minimum: <code>0.01</code>.
|-
| <code>start_active</code> Start Active || <code>true</code> || Start moving as soon as the entity initializes.
|-
| <code>reverse_direction</code> Reverse Direction || <code>false</code> || Start by moving toward spline progress 0 instead of 1.
|-
| <code>start_locked</code> Start Locked || <code>false</code> || Ignore movement-control inputs until unlocked. Existing motion is not paused by locking.
|-
| <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>kill</code> || <code>none</code> || Server
|-
| Input || <code>lock</code> || <code>string</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>reverse</code> || <code>string</code> || Server
|-
| Input || <code>set_progress</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>killed</code> || <code>none</code> || Server
|-
| Output || <code>loop</code> || <code>string</code> || Server
|-
| Output || <code>progress</code> || <code>float</code> || Server
|-
| Output || <code>reached_end</code> || <code>string</code> || Server
|-
| Output || <code>reached_start</code> || <code>string</code> || Server
|-
| Output || <code>reversed</code> || <code>string</code> || Server
|-
| Output || <code>started</code> || <code>string</code> || Server
|-
| Output || <code>stopped</code> || <code>string</code> || Server
|-
| 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_reversed</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>progress</code> || <code>float</code> || Server; read/write
|-
| Property || <code>speed</code> || <code>float</code> || Server; read/write
|-
| State || <code>state</code> || <code>TrackTrainEntityState</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 tracktrain - Revision history

DocumentationBot: Version 1