Rope

From Frictional Wiki
< HPL3‎ | Areas
Jump to navigation Jump to search

Rope is an area class defined in editor/userclasses/AreaClasses.def 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.

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

See also

Documentation to expand

Creation workflow, runtime behavior and a worked map example need expansion.