GTA.Rope Class Reference

Inheritance diagram for GTA.Rope:

Public Member Functions
	Rope (int handle)
void	ActivatePhysics ()
	Activates physics interactions for this Rope. More...
void	Attach (Entity entity)
	Attaches a single Entity to this Rope. More...
void	Attach (Entity entity, Vector3 position)
	Attaches a single Entity to this Rope at the specified position . More...
void	Detach (Entity entity)
	Detaches a single Entity from this Rope. More...
void	Connect (Entity entity1, Entity entity2, float length)
	Connects two Entitys with this Rope. More...
void	Connect (Entity entity1, Vector3 position1, Entity entity2, Vector3 position2, float length)
	Connects two Entitys with this Rope at the specified positions. More...
void	PinVertex (int vertex, Vector3 position)
	Pin a vertex of this Rope to a position . More...
void	UnpinVertex (int vertex)
	Unpin a vertex of this Rope. More...
Vector3	GetVertexCoord (int vertex)
	Gets the world coordinates of a single vertex of this Rope. More...
override void	Delete ()
	Destroys this Rope. More...
override bool	Exists ()
	Determines if this Rope exists. More...
override bool	Equals (object obj)
	Determines if an object refers to the same rope as this Rope. More...
override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (Rope left, Rope right)
	Determines if two Ropes refer to the same rope. More...
static bool	operator!= (Rope left, Rope right)
	Determines if two Ropes don't refer to the same rope. More...
static implicit	operator InputArgument (Rope value)
	Converts a Rope to a native input argument. More...

Public Attributes
int	VertexCount => Function.Call<int>(Hash.GET_ROPE_VERTEX_COUNT, Handle)
	Gets the number of vertices of this Rope. More...

Properties
float	Length [get, set]
	Gets or sets the length of this Rope. More...
Properties inherited from GTA.PoolObject
int	Handle [get, protected set]
	The handle of the object. More...
ulong	NativeValue [get, set]
	The handle of the object translated to a native value. More...
Properties inherited from GTA.Native.INativeValue
ulong	NativeValue [get, set]

Additional Inherited Members
Protected Member Functions inherited from GTA.PoolObject
	PoolObject (int handle)

Constructor & Destructor Documentation

Rope()

GTA.Rope.Rope

(

int

handle

)

Member Function Documentation

ActivatePhysics()

void GTA.Rope.ActivatePhysics

(

)

Activates physics interactions for this Rope.

Attach() [1/2]

void GTA.Rope.Attach

(

Entity

entity

)

Attaches a single Entity to this Rope.

Parameters

entity

The entity to attach.

Attach() [2/2]

void GTA.Rope.Attach	(	Entity	entity,
		Vector3	position
	)

Attaches a single Entity to this Rope at the specified position .

Parameters

entity	The entity to attach.
position	The position in world coordinates to attach to.

Connect() [1/2]

void GTA.Rope.Connect	(	Entity	entity1,
		Entity	entity2,
		float	length
	)

Connects two Entitys with this Rope.

Parameters

entity1	The first entity to attach.
entity2	The second entity to attach.
length	The rope length.

Connect() [2/2]

void GTA.Rope.Connect	(	Entity	entity1,
		Vector3	position1,
		Entity	entity2,
		Vector3	position2,
		float	length
	)

Connects two Entitys with this Rope at the specified positions.

Parameters

entity1	The first entity to attach.
entity2	The second entity to attach.
position1	The position in world coordinates to attach the first entity to.
position2	The position in world coordinates to attach the second entity to.
length	The rope length.

Delete()

override void GTA.Rope.Delete ( )

virtual

Destroys this Rope.

Implements GTA.PoolObject.

Detach()

void GTA.Rope.Detach

(

Entity

entity

)

Detaches a single Entity from this Rope.

Parameters

entity

The entity to detach.

Equals()

override bool GTA.Rope.Equals

(

object

obj

)

Determines if an object refers to the same rope as this Rope.

Parameters

obj	The object to check.

Returns

true if the obj is the same rope as this Rope; otherwise, false.

Exists()

override bool GTA.Rope.Exists ( )

virtual

Determines if this Rope exists.

Returns

true if this Rope exists; otherwise, false.

Implements GTA.PoolObject.

GetHashCode()

override int GTA.Rope.GetHashCode

(

)

GetVertexCoord()

Vector3 GTA.Rope.GetVertexCoord

(

int

vertex

)

Gets the world coordinates of a single vertex of this Rope.

Parameters

vertex

The index of the vertex.

Returns

The position of the vertex in world coordinates.

operator InputArgument()

static implicit GTA.Rope.operator InputArgument ( Rope  value )

static

Converts a Rope to a native input argument.

operator!=()

static bool GTA.Rope.operator!= ( Rope  left, Rope  right  )

static

Determines if two Ropes don't refer to the same rope.

Parameters

left	The left Rope.
right	The right Rope.

Returns

true if left is not the same rope as right ; otherwise, false.

operator==()

static bool GTA.Rope.operator== ( Rope  left, Rope  right  )

static

Determines if two Ropes refer to the same rope.

Parameters

left	The left Rope.
right	The right Rope.

Returns

true if left is the same rope as right ; otherwise, false.

PinVertex()

void GTA.Rope.PinVertex	(	int	vertex,
		Vector3	position
	)

Pin a vertex of this Rope to a position .

Parameters

vertex	The index of the vertex.
position	The position in world coordinates to pin to.

UnpinVertex()

void GTA.Rope.UnpinVertex

(

int

vertex

)

Unpin a vertex of this Rope.

Parameters

vertex

The index of the vertex.

Member Data Documentation

VertexCount

int GTA.Rope.VertexCount => Function.Call<int>(Hash.GET_ROPE_VERTEX_COUNT, Handle)

Gets the number of vertices of this Rope.

Property Documentation

Length

float GTA.Rope.Length

getset

Gets or sets the length of this Rope.

---

The documentation for this class was generated from the following file:

• C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA/Rope.cs