Class Rope

Inheritance
Object
PoolObject
Rope
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class Rope : PoolObject, INativeValue, IDeletable, IExistable

Constructors

| Improve this Doc View Source

Rope(Int32)

Declaration
public Rope(int handle)
Parameters
Type Name Description
Int32 handle

Properties

| Improve this Doc View Source

Length

Gets or sets the length of this Rope.

Declaration
public float Length { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VertexCount

Gets the number of vertices of this Rope.

Declaration
public int VertexCount { get; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

ActivatePhysics()

Activates physics interactions for this Rope.

Declaration
public void ActivatePhysics()
| Improve this Doc View Source

Attach(Entity)

Attaches a single Entity to this Rope.

Declaration
public void Attach(Entity entity)
Parameters
Type Name Description
Entity entity

The entity to attach.
| Improve this Doc View Source

Attach(Entity, Vector3)

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

Declaration
public void Attach(Entity entity, Vector3 position)
Parameters
Type Name Description
Entity entity

The entity to attach.
Vector3 position

The position in world coordinates to attach to.
| Improve this Doc View Source

Connect(Entity, Entity, Single)

Connects two Entitys with this Rope.

Declaration
public void Connect(Entity entity1, Entity entity2, float length)
Parameters
Type Name Description
Entity entity1

The first entity to attach.
Entity entity2

The second entity to attach.
Single length

The rope length.
| Improve this Doc View Source

Connect(Entity, Vector3, Entity, Vector3, Single)

Connects two Entitys with this Rope at the specified positions.

Declaration
public void Connect(Entity entity1, Vector3 position1, Entity entity2, Vector3 position2, float length)
Parameters
Type Name Description
Entity entity1

The first entity to attach.
Vector3 position1

The position in world coordinates to attach the first entity to.
Entity entity2

The second entity to attach.
Vector3 position2

The position in world coordinates to attach the second entity to.
Single length

The rope length.
| Improve this Doc View Source

Delete()

Destroys this Rope.

Declaration
public override void Delete()
Overrides
| Improve this Doc View Source

Detach(Entity)

Detaches a single Entity from this Rope.

Declaration
public void Detach(Entity entity)
Parameters
Type Name Description
Entity entity

The entity to detach.
| Improve this Doc View Source

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to check.
Returns
Type Description
Boolean

true if the obj is the same rope as this Rope; otherwise, false.
Overrides
| Improve this Doc View Source

Exists()

Determines if this Rope exists.

Declaration
public override bool Exists()
Returns
Type Description
Boolean

true if this Rope exists; otherwise, false.
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

GetVertexCoord(Int32)

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

Declaration
public Vector3 GetVertexCoord(int vertex)
Parameters
Type Name Description
Int32 vertex

The index of the vertex.
Returns
Type Description
Vector3

The position of the vertex in world coordinates.
| Improve this Doc View Source

PinVertex(Int32, Vector3)

Pin a vertex of this Rope to a position.

Declaration
public void PinVertex(int vertex, Vector3 position)
Parameters
Type Name Description
Int32 vertex

The index of the vertex.
Vector3 position

The position in world coordinates to pin to.
| Improve this Doc View Source

UnpinVertex(Int32)

Unpin a vertex of this Rope.

Declaration
public void UnpinVertex(int vertex)
Parameters
Type Name Description
Int32 vertex

The index of the vertex.

Operators

| Improve this Doc View Source

Equality(Rope, Rope)

Determines if two Ropes refer to the same rope.

Declaration
public static bool operator ==(Rope left, Rope right)
Parameters
Type Name Description
Rope left

The left Rope.
Rope right

The right Rope.
Returns
Type Description
Boolean

true if left is the same rope as right; otherwise, false.
| Improve this Doc View Source

Implicit(Rope to InputArgument)

Converts a Rope to a native input argument.

Declaration
public static implicit operator InputArgument(Rope value)
Parameters
Type Name Description
Rope value
Returns
Type Description
InputArgument
| Improve this Doc View Source

Inequality(Rope, Rope)

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

Declaration
public static bool operator !=(Rope left, Rope right)
Parameters
Type Name Description
Rope left

The left Rope.
Rope right

The right Rope.
Returns
Type Description
Boolean

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

Implements