Attach Rope (Bi-Entity Action Type)

Attaches a rope between the actor and the target. This is the same action as apoli:attach_rope in the entity context, registered again here so an endpoint can use "source": "target".

Type ID: apoli:attach_rope

Fields#

Field	Type	Default	Description
from	Rope Endpoint	{ "source": "self" }	One end of the rope. self is the actor.
to	Rope Endpoint	{ "source": "raycast", "blocks": true }	The other end. Use { "source": "target" } for the entity this action was run against.
slot	String	optional	A label for this rope. Attaching again with the same slot replaces the previous rope in it.
texture	Identifier	apoli:textures/rope/rope.png	The texture the rope is drawn with.
toggle	Boolean	true	When true and no slot is given, re-firing while the actor already holds a controllable rope releases it instead of adding another.
controllable	Boolean	true	Whether the built-in reel/swing keys drive this rope for its owner. Set false for tethers you cast on other entities.
mode	String	"leash"	leash, spring or rigid — see the entity action page.
break_beyond	Float	0.0	Snap the rope once its ends are farther apart than this many blocks. 0 never breaks.
min_length	Float	1.0	Shortest the rope can reel to.
max_length	Float	30.0	Longest the rope can be.
start_length	Float	see below	The length the rope is created at, clamped to min_length–max_length. Left out, a controllable rope starts taut at the current distance between its ends, and a rope that is not controllable starts at max_length.
stiffness	Float	0.1	How hard the rope yanks an end back once it passes its length.
radial_damping	Float	0.85	How much outward speed is bled off at the length limit.
spring_scaling	Float	0.65	Extra softening while swinging inward.
swing_boost	Float	1.08	Speed multiplier applied to a sprinting player’s swing.
max_swing_speed	Float	0.7	Cap on the sprint swing boost.
control_accel	Float	0.08	How hard the WASD swing keys push a controllable rope.
reel_step	Float	0.2	Blocks per tick the length changes while a reel key is held.
slack_pull_rate	Float	5.0	Multiplier applied to reeling in while there is slack.
constrain_from	Boolean	true	Whether the physics may pull the from end.
constrain_to	Boolean	true	Whether the physics may pull the to end.

Example#

{
  "type": "apoli:attach_rope",
  "to": { "source": "target" },
  "slot": "whip",
  "controllable": false,
  "max_length": 6,
  "break_beyond": 14
}

A whip that hooks whatever you hit and drags it along within 6 blocks until the two of you are pulled 14 blocks apart. Because it is not controllable, it starts at its full 6-block length.