⛓️ Cable

A Cable represents a Physics Constraint which joins two Actors with a rope-like visual representation between them

info

🟦 Authority: This class can only be spawned on Server.

⏬ Inheritance: This class inherits from Actor and Paintable.

nanos world Cables are composed primarily of two Unreal Engine components: a Cable and a PhysicsConstraint. The first is used for visual purposes only and the second one gives the effective physical effects that are applied to each end of the Cable.

info

Cable visuals can be tweaked with :SetForces(), :SetCableSettings() and :SetRenderingSettings() methods. Those methods don’t have effect on the physics being applied and only have effects on the visual representation.

Cable physics can be tweaked with :SetAngularLimits() and :SetLinearLimits().

After attaching the two sides of your cable, the physics can be tweaked to affect how the constraint will affect the objects.

tip

Cables are automatically destroyed when one of the sides are detached

tip

You can find more useful information regarding physical properties of the joint in the end of this page.

Usage

Server/Index.lua

local my_cable: = Cable()
local cube_01 = Prop(Vector(100, 100, 100), Rotator(), "nanos-world::SM_Cube")
local cube_02 = Prop(Vector(200, 0, 100), Rotator(), "nanos-world::SM_Cube")

my_cable::AttachStartTo(cube_01)
my_cable::AttachEndTo(cube_02)

Constructor Parameters

Type	Name	Default	Description
Vector	location	Vector(0, 0, 0)
boolean	enable_visuals	true	Toggles the cable visuals

Functions

Inherited Paintable Functions

Base Paintablescripting-reference/classes/base-classes/paintable

	Returns	Name	Description
		SetMaterial	Sets the material at the specified index of this Actor
		SetMaterialFromWebUI	Sets the material at the specified index of this Actor to a WebUI object
		SetMaterialFromSceneCapture	Sets the material at the specified index of this Actor to a SceneCapture object
		ResetMaterial	Resets the material from the specified index to the original one
		SetMaterialColorParameter	Sets a Color parameter in this Actor’s material
		SetMaterialScalarParameter	Sets a scalar parameter in this Actor’s material
		SetMaterialTextureParameter	Sets a texture parameter in this Actor's material to an image on disk
		SetMaterialVectorParameter	Sets a Vector parameter in this Actor’s material
		SetPhysicalMaterial	Overrides this Actor's Physical Material with a new one

	Returns	Name	Description
		AttachStartTo	Attached the beginning of this cable to another Actor at a specific bone or relative location
		AttachEndTo	Attached the end of this cable to another Actor at a specific bone or relative location
		DetachEnd	Detaches the End of this Cable
		DetachStart	Detaches the Start of this Cable
		SetAngularLimits	Sets the Physics Angular Limits of this cable
		SetLinearLimits	Sets the Physics Linear Limits of this cable
		SetCableSettings	Set the overall settings for this cable (visuals only)
		SetForces	Set the forces the cable has applied (visuals only)
		SetRenderingSettings	Set the rendering settings of this cable (visuals only)
		SetLocation	Sets the actor's location in the game world
		GetLocation	Gets the actor's location in the game world
		GetAttachedStartTo	Gets the actor’s attached to Start of this Cable
		GetAttachedEndTo	Gets the actor’s attached to End of this Cable

AttachStartTo

Attached the beginning of this cable to another Actor at a specific bone or relative location

my_cable:AttachStartTo(other, relative_location, bone_name)

Type	Parameter	Default Value	Description
Actor	other
Vector	relative_location	Vector()
string	bone_name	``

AttachEndTo

Attached the end of this cable to another Actor at a specific bone or relative location

my_cable:AttachEndTo(other, relative_location, bone_name)

Type	Parameter	Default Value	Description
Actor	other
Vector	relative_location	Vector()
string	bone_name	``

DetachEnd

Detaches the End of this Cable

my_cable:DetachEnd()

DetachStart

Detaches the Start of this Cable

my_cable:DetachStart()

SetCableSettings

Set the overall settings for this cable (visuals only)

my_cable:SetCableSettings(length, num_segments, solver_iterations)

Type	Parameter	Default Value	Description
number	length		Rest length of the cable
number	num_segments		How many segments the cable has
number	solver_iterations		The number of solver iterations controls how 'stiff' the cable is

SetForces

Set the forces the cable has applied (visuals only)

my_cable:SetForces(force, gravity_scale)

Type	Parameter	Default Value	Description
Vector	force		Force vector (world space) applied to all particles in cable
number	gravity_scale	1	Scaling applied to world gravity affecting this cable

SetAngularLimits

Sets the Physics Angular Limits of this cable

my_cable:SetAngularLimits(swing_1_motion, swing_2_motion, twist_motion, swing_1_limit, swing_2_limit, twist_limit)

Type	Parameter	Default Value	Description
ConstraintMotion	swing_1_motion		Indicates whether the Swing1 limit is used
ConstraintMotion	swing_2_motion		Indicates whether the Swing2 limit is used
ConstraintMotion	twist_motion		Indicates whether the Twist limit is used
number	swing_1_limit		Angle of movement along the XY plane. This defines the first symmetric angle of the cone
number	swing_2_limit		Angle of movement along the XZ plane. This defines the second symmetric angle of the cone
number	twist_limit		Symmetric angle of roll along the X-axis

SetLinearLimits

Sets the Physics Linear Limits of this cable. If use_soft_constraint is enabled, then stiffness and damping will be used, otherwise restitution will be used.

my_cable:SetLinearLimits(x_motion, y_motion, z_motion, limit, restitution, use_soft_constraint, stiffness, damping)

Type	Parameter	Default Value	Description
ConstraintMotion	x_motion		Indicates the linear constraint applied along the X-axis. Free implies no constraint at all. Locked implies no movement along X is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided
ConstraintMotion	y_motion		Indicates the linear constraint applied along the Y-axis. Free implies no constraint at all. Locked implies no movement along Y is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided
ConstraintMotion	z_motion		Indicates the linear constraint applied along theZX-axis. Free implies no constraint at all. Locked implies no movement along Z is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided
number	limit		The distance allowed between between the two joint reference frames. Distance applies on all axes enabled (one axis means line, two axes implies circle, three axes implies sphere)
number	restitution	0	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead
boolean	use_soft_constraint	false	Whether we want to use a soft constraint (spring)
number	stiffness	0	Stiffness of the soft constraint. Only used when Soft Constraint is on
number	damping	0	Damping of the soft constraint. Only used when Soft Constraint is on

SetRenderingSettings

Set the rendering settings of this cable (visuals only)

my_cable:SetRenderingSettings(width, num_sides, tile_material)

Type	Parameter	Default Value	Description
number	width		How wide the cable geometry is
number	num_sides		Number of sides of the cable geometry
number	tile_material		How many times to repeat the material along the length of the cable

GetAttachedStartTo

Gets the actor attached to Start

Returns any

entity:GetAttachedStartTo()

GetAttachedEndTo

Gets the actor attached to End

Returns any

entity:GetAttachedEndTo()

Events

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	Destroy	Triggered when an Actor is destroyed
	Spawn	Triggered when an Actor is spawned/created
	ValueChange	Triggered when an Actor has a value changed with :SetValue()