Class EntityBone

Inheritance

Object

EntityBone

PedBone

Inherited Members

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA

Assembly: ScriptHookVDotNet3.dll

Syntax

public class EntityBone

Properties

ForwardVector

Gets the vector that points in front of this EntityBone relative to the world.

Declaration

public Vector3 ForwardVector { get; }

Property Value

Type	Description
Vector3

FragmentGroupIndex

Gets the fragment group index of this EntityBone. -1 will be returned if the Entity does not exist or Index is invalid.

Declaration

public int FragmentGroupIndex { get; }

Property Value

Type	Description
Int32

Index

Gets the bone index of this EntityBone.

Declaration

public int Index { get; }

Property Value

Type	Description
Int32

IsValid

Determines if this EntityBone is valid.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
Boolean

Owner

Gets the owner Entity this bone belongs to.

Declaration

public Entity Owner { get; }

Property Value

Type	Description
Entity

Pose

Gets or sets the current pose offset (dynamic position) of this EntityBone relative to the Entity its part of.

Declaration

public Vector3 Pose { get; set; }

Property Value

Type	Description
Vector3

PoseMatrix

Gets or sets the dynamic Matrix of this EntityBone relative to the Entity its part of.

Declaration

public Matrix PoseMatrix { get; set; }

Property Value

Type	Description
Matrix

Position

Gets the position of this EntityBone in world coordinates.

Declaration

public Vector3 Position { get; }

Property Value

Type	Description
Vector3

RelativeForwardVector

Gets the vector that points in front of this EntityBone relative to the Entity its part of.

Declaration

public Vector3 RelativeForwardVector { get; }

Property Value

Type	Description
Vector3

RelativeMatrix

Gets the Matrix of this EntityBone relative to the Entity its part of.

Declaration

public Matrix RelativeMatrix { get; }

Property Value

Type	Description
Matrix

RelativePosition

Gets the position of this EntityBone relative to the Entity its part of.

Declaration

public Vector3 RelativePosition { get; }

Property Value

Type	Description
Vector3

RelativeRightVector

Gets the vector that points to the right of this EntityBone relative to the Entity its part of.

Declaration

public Vector3 RelativeRightVector { get; }

Property Value

Type	Description
Vector3

RelativeUpVector

Gets the vector that points above this EntityBone relative to the Entity its part of.

Declaration

public Vector3 RelativeUpVector { get; }

Property Value

Type	Description
Vector3

RightVector

Gets the vector that points to the right of this EntityBone relative to the world.

Declaration

public Vector3 RightVector { get; }

Property Value

Type	Description
Vector3

UpVector

Gets the vector that points above this EntityBone relative to the world.

Declaration

public Vector3 UpVector { get; }

Property Value

Type	Description
Vector3

Methods

Equals(Object)

Determines if an Object refers to the same bone as this EntityBone.

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 bone as this EntityBone; otherwise, false.

Overrides

Object.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetOffsetPosition(Vector3)

Gets the position in world coordinates of an offset relative this EntityBone

Declaration

public Vector3 GetOffsetPosition(Vector3 offset)

Parameters

Type	Name	Description
Vector3	offset	The offset from this EntityBone.

Returns

Type	Description
Vector3

GetPositionOffset(Vector3)

Gets the relative offset of this EntityBone from a world coordinates position

Declaration

public Vector3 GetPositionOffset(Vector3 worldCoords)

Parameters

Type	Name	Description
Vector3	worldCoords	The world coordinates.

Returns

Type	Description
Vector3

GetRelativeOffsetPosition(Vector3)

Gets the position relative to the Entity of an offset relative this EntityBone

Declaration

public Vector3 GetRelativeOffsetPosition(Vector3 offset)

Parameters

Type	Name	Description
Vector3	offset	The offset from this EntityBone.

Returns

Type	Description
Vector3

GetRelativePositionOffset(Vector3)

Gets the relative offset of this EntityBone from an offset from the Entity

Declaration

public Vector3 GetRelativePositionOffset(Vector3 entityOffset)

Parameters

Type	Name	Description
Vector3	entityOffset	The Entity offset.

Returns

Type	Description
Vector3

Operators

Equality(EntityBone, Bone)

Determines if an EntityBone refers to a specific bone.

Declaration

public static bool operator ==(EntityBone entityBone, Bone boneId)

Parameters

Type	Name	Description
EntityBone	entityBone	The EntityBone to check.
Bone	boneId	The Bone ID to check against.

Returns

Type	Description
Boolean	true if entityBone refers to the boneId; otherwise, false.

Equality(EntityBone, EntityBone)

Determines if two EntityBones refer to the same bone.

Declaration

public static bool operator ==(EntityBone left, EntityBone right)

Parameters

Type	Name	Description
EntityBone	left	The left EntityBone.
EntityBone	right	The right EntityBone.

Returns

Type	Description
Boolean	true if left is the same bone as right; otherwise, false.

Implicit(EntityBone to InputArgument)

Converts an EntityBone to a native input argument.

Declaration

public static implicit operator InputArgument(EntityBone entityBone)

Parameters

Type	Name	Description
EntityBone	entityBone

Returns

Type	Description
InputArgument

Implicit(EntityBone to Int32)

Converts an EntityBone to a bone index.

Declaration

public static implicit operator int (EntityBone entityBone)

Parameters

Type	Name	Description
EntityBone	entityBone

Returns

Type	Description
Int32

Inequality(EntityBone, Bone)

Determines if an EntityBone doesn't refer to a specific bone.

Declaration

public static bool operator !=(EntityBone entityBone, Bone boneId)

Parameters

Type	Name	Description
EntityBone	entityBone	The EntityBone to check.
Bone	boneId	The Bone ID to check against.

Returns

Type	Description
Boolean	true if entityBone does not refer to the boneId; otherwise, false.

Inequality(EntityBone, EntityBone)

Determines if two EntityBones don't refer to the same bone.

Declaration

public static bool operator !=(EntityBone left, EntityBone right)

Parameters

Type	Name	Description
EntityBone	left	The left EntityBone.
EntityBone	right	The right EntityBone.

Returns

Type	Description
Boolean	true if left is not the same bone as right; otherwise, false.