⛓️ Cable

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

---

💂Authority

This class can only be spawned on 🟦 Server side.

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

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

🎒 Examples

Server/Index.lua

local my_cable = Cable(Vector())
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)

🛠 Constructors

Default Constructor

No description provided

local my_cable = Cable(location, enable_visuals?)

Type	Name	Default	Description
Vector	location	Required parameter	No description provided
boolean	enable_visuals	true	Toggles the cable visuals

🗿 Static Functions

Inherited Entity Static Functions

Cable inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity

	Returns	Name	Description
	table of Base Entity	GetAll	Returns a table containing all Entities of the class this is called on
	Base Entity	GetByIndex	Returns a specific Entity of this class at an index
	integer	GetCount	Returns how many Entities of this class exist
	table of table	GetInheritedClasses	Gets a list of all directly inherited classes from this Class created with the Inheriting System
	iterator	GetPairs	Returns an iterator with all Entities of this class to be used with pairs()
	table or nil	GetParentClass	Gets the parent class if this Class was created with the Inheriting System
	table	Inherit	Inherits this class with the Inheriting System
	boolean	IsChildOf	Gets if this Class is child of another class if this Class was created with the Inheriting System
	function	Subscribe	Subscribes to an Event for all entities of this Class
	function	SubscribeRemote	Subscribes to a custom event called from server
		Unsubscribe	Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

This class doesn't have own static functions.

🦠 Functions

Inherited Entity Functions

Cable inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity

	Returns	Name	Description
		BroadcastRemoteEvent	Calls a custom remote event directly on this entity to all Players
		CallRemoteEvent	Calls a custom remote event directly on this entity to a specific Player
		CallRemoteEvent	Calls a custom remote event directly on this entity
		Destroy	Destroys this Entity
	table of string	GetAllValuesKeys	Gets a list of all values keys
	table	GetClass	Gets the class of this entity
	integer	GetID	Gets the universal network ID of this Entity (same on both client and server)
	any	GetValue	Gets a Value stored on this Entity at the given key
	boolean	IsA	Recursively checks if this entity is inherited from a Class
	boolean	IsValid	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
		SetValue	Sets a Value in this Entity
	function	Subscribe	Subscribes to an Event on this specific entity
	function	SubscribeRemote	Subscribes to a custom event called from server on this specific entity
		Unsubscribe	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

Inherited Actor Functions

Cable inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/Actor

	Returns	Name	Description
		AddActorTag	Adds an Unreal Actor Tag to this Actor
		AddImpulse	Applies a force in world world to this Actor
		AttachTo	Attaches this Actor to any other Actor, optionally at a specific bone
		Detach	Detaches this Actor from AttachedTo Actor
	table of string	GetActorTags	Gets all Unreal Actor Tags on this Actor
	table of Base Actor	GetAttachedEntities	Gets all Actors attached to this Actor
	Base Actor or nil	GetAttachedTo	Gets the Actor this Actor is attached to
	table	GetBounds	Gets this Actor's bounds
	CollisionType	GetCollision	Gets this Actor's collision type
	integer	GetDimension	Gets this Actor's dimension
	float	GetDistanceFromCamera	Gets the distance of this Actor from the Camera
	Vector	GetForce	Gets this Actor's force (set by SetForce())
	Vector	GetLocation	Gets this Actor's location in the game world
	Player or nil	GetNetworkAuthority	Gets this Actor's Network Authority Player
	Vector	GetRelativeLocation	Gets this Actor's Relative Location if it's attached
	Rotator	GetRelativeRotation	Gets this Actor's Relative Rotation if it's attached
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetScale	Gets this Actor's scale
	float	GetScreenPercentage	Gets the percentage of this Actor size in the screen
	table	GetSocketTransform	Gets a Socket Transform in world space given a bone or socket name
	Vector	GetVelocity	Gets this Actor's current velocity
	boolean	HasAuthority	Gets if this Actor was spawned by the client side
	boolean	HasNetworkAuthority	Returns true if the local Player is currently the Network Authority of this Actor
	boolean	IsBeingDestroyed	Returns true if this Actor is being destroyed
	boolean	IsGravityEnabled	Returns true if gravity is enabled on this Actor
	boolean	IsInWater	Returns true if this Actor is in water
	boolean	IsNetworkDistributed	Returns true if this Actor is currently network distributed
	boolean	IsVisible	Returns true if this Actor is visible
		RemoveActorTag	Removes an Unreal Actor Tag from this Actor
		RotateTo	Smoothly rotates this actor to an angle over a certain time
		SetCollision	Sets this Actor's collision type
		SetDimension	Sets this Actor's Dimension
		SetForce	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight index to use
		SetLifeSpan	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
		SetLocation	Sets this Actor's location in the game world
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetNetworkAuthorityAutoDistributed	Sets if this Actor will auto distribute the network authority between players
		SetOutlineEnabled	Sets whether the outline is enabled on this Actor, and which outline index to use
		SetRelativeLocation	Sets this Actor's relative location in local space (only if this actor is attached)
		SetRelativeRotation	Sets this Actor's relative rotation in local space (only if this actor is attached)
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetVisibility	Sets whether the actor is visible or not
		TranslateTo	Smoothly moves this actor to a location over a certain time
	boolean	WasRecentlyRendered	Gets if this Actor was recently rendered on screen

Inherited Paintable Functions

Cable inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/Paintable

	Returns	Name	Description
		ResetMaterial	Resets the material from the specified index to the original one
		SetMaterial	Sets the material at the specified index of this Actor
		SetMaterialColorParameter	Sets a Color parameter in this Actor's material
		SetMaterialFromCanvas	Sets the material at the specified index of this Actor to a Canvas object
		SetMaterialFromSceneCapture	Sets the material at the specified index of this Actor to a SceneCapture object
		SetMaterialFromWebUI	Sets the material at the specified index of this Actor to a WebUI object
		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
		AttachEndTo	Attached the end of this cable to another Actor at a specific bone or relative location
		AttachStartTo	Attached the beginning 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
	Base Actor	GetAttachedEndTo	Gets the Actor attached to End
	Base Actor	GetAttachedStartTo	Gets the Actor attached to Start
		SetAngularLimits	Sets the Physics Angular Limits of this cable
		SetCableSettings	Set the overall settings for this cable (visuals only)
		SetForces	Set the forces the cable has applied (visuals only)
		SetLinearLimits	Sets the Physics Linear Limits of this cable
		SetRenderingSettings	Set the rendering settings of this cable (visuals only)

---

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	Description
Base Actor	other	Required parameter	No description provided
Vector	relative_location?	Vector(0, 0, 0)	No description provided
string	bone_name?		Which bone to attach to. If empty it will be attached to the Actor, otherwise to the Mesh at the bone/socket

---

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	Description
Base Actor	other	Required parameter	No description provided
Vector	relative_location?	Vector(0, 0, 0)	No description provided
string	bone_name?		Which bone to attach to. If empty it will be attached to the Actor, otherwise to the Mesh at the bone/socket

---

DetachEnd

Detaches the End of this Cable

my_cable:DetachEnd()

---

DetachStart

Detaches the Start of this Cable

my_cable:DetachStart()

---

GetAttachedEndTo

Gets the Actor attached to End

— Returns Base Actor (the Actor or nil).

local ret = my_cable:GetAttachedEndTo()

---

GetAttachedStartTo

Gets the Actor attached to Start

— Returns Base Actor (the Actor or nil).

local ret = my_cable:GetAttachedStartTo()

---

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	Description
ConstraintMotion	swing_1_motion	Required parameter	Indicates whether the Swing1 limit is used
ConstraintMotion	swing_2_motion	Required parameter	Indicates whether the Swing2 limit is used
ConstraintMotion	twist_motion	Required parameter	Indicates whether the Twist limit is used
float	swing_1_limit?	0	Angle of movement along the XY plane. This defines the first symmetric angle of the cone
float	swing_2_limit?	0	Angle of movement along the XZ plane. This defines the second symmetric angle of the cone
float	twist_limit?	0	Symmetric angle of roll along the X-axis

---

SetCableSettings

Set the overall settings for this cable (visuals only)

my_cable:SetCableSettings(length, num_segments, solver_iterations)

Type	Parameter	Default	Description
float	length	Required parameter	Rest length of the cable. Default is 100
integer	num_segments	Required parameter	How many segments the cable has. Default is 10
integer	solver_iterations	Required parameter	The number of solver iterations controls how 'stiff' the cable is. Default is 0

---

SetForces

Set the forces the cable has applied (visuals only)

my_cable:SetForces(force, gravity_scale?)

Type	Parameter	Default	Description
Vector	force	Required parameter	Force vector (world space) applied to all particles in cable. Default is Vector(0, 0, 0)
float	gravity_scale?	1	Scaling applied to world gravity affecting this cable. Default is 1

---

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	Description
ConstraintMotion	x_motion	Required parameter	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	Required parameter	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	Required parameter	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
float	limit?	0	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)
float	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)
float	stiffness?	0	Stiffness of the soft constraint. Only used when Soft Constraint is on
float	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	Description
float	width	Required parameter	How wide the cable geometry is. Default is 6
integer	num_sides	Required parameter	Number of sides of the cable geometry. Default is 4
integer	tile_material	Required parameter	How many times to repeat the material along the length of the cable. Default is 1

🚀 Events

Inherited Entity Events

Cable inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/Entity

	Name	Description
	ClassRegister	Triggered when a new Class is registered with the Inheriting System
	Destroy	Triggered when an Entity is destroyed
	Spawn	Triggered when an Entity is spawned/created
	ValueChange	Triggered when an Entity has a value changed with :SetValue()

Inherited Actor Events

Cable inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/Actor

	Name	Description
	DimensionChange	Triggered when an Actor changes it's dimension

This class doesn't have own events.