TiMan: Add source-verified reference and identify information needing expansion.

2026-10-02T11:35:31Z

Add source-verified reference and identify information needing expansion.

New page

{{shortPageTitle}}
{{stub}}

<code>Rope</code> is an area class defined in <code>editor/userclasses/AreaClasses.def</code> in SOMA, Amnesia: Rebirth and Amnesia: The Bunker.

== Class variables ==
The following table records the shared class variables and their definition defaults. Descriptions are taken from the class definitions.

{| class="wikitable"
! Variable !! Type !! Definition default !! Description
|-
| <code>EndPosNode</code> || <code>String</code> || <code>""</code> || A PosNode area that sets the end of the rope
|-
| <code>StartBody</code> || <code>String</code> || <code>""</code> || The body at the start of the rope. Game first looks for Body with name, and then for entity. Can be empty
|-
| <code>EndBody</code> || <code>String</code> || <code>""</code> || The body at the end of the rope. Game first looks for Body with name, and then for entity.
|-
| <code>MinTotalLength</code> || <code>Float</code> || <code>0.5</code> || The minimum length of the rope.
|-
| <code>MaxTotalLength</code> || <code>Float</code> || <code>10</code> || The maximum length for the rope
|-
| <code>AutoMove</code> || <code>Bool</code> || <code>false</code> || If the rope automoves.
|-
| <code>AutoMoveAcc</code> || <code>Float</code> || <code>5</code> || Acceleration of automovement.
|-
| <code>AutoMoveMaxSpeed</code> || <code>Float</code> || <code>3</code> || The maximum speed for automovement.
|-
| <code>RopeFile</code> || <code>File</code> || <code>""</code> || If set, it overrides all of the settings below.
|-
| <code>SegmentLength</code> || <code>Float</code> || <code>0.3</code> || Length of each segment.
|-
| <code>Damping</code> || <code>Float</code> || <code>0.1</code> || The amount of air resitance. The higher the faster it slows down
|-
| <code>Strength</code> || <code>Float</code> || <code>200</code> || How much the rope pulls on the connected bodies
|-
| <code>Stiffness</code> || <code>Float</code> || <code>3</code> || How much slacking is allowed in the rope. The higher the less slacking.
|-
| <code>Material</code> || <code>File</code> || <code>textures/ropes/default.mat</code> || The material used
|-
| <code>Radius</code> || <code>Float</code> || <code>0.025</code> || Radius of each segment
|-
| <code>LengthTileAmount</code> || <code>Float</code> || <code>1</code> || How many times each material is tiled in a segment
|-
| <code>LengthTileSize</code> || <code>Float</code> || <code>0.5</code> || Only used is SegmentLength=0. The length (in m) where material repeats.
|-
| <code>Sound</code> || <code>File</code> || <code>""</code> || Sound played when moving
|-
| <code>SoundStartSpeed</code> || <code>Float</code> || <code>0.49</code> || Speed when sound starts playing.
|-
| <code>SoundStopSpeed</code> || <code>Float</code> || <code>0.45</code> || Speed when sound stops playing.
|}

== See also ==
* [[HPL3/SOMA/Areas|SOMA areas]]

== Documentation to expand ==
Creation workflow, runtime behavior and a worked map example need expansion.

[[Category:English]]

HPL3/Areas/Rope - Revision history

TiMan: Add source-verified reference and identify information needing expansion.