Inheritance diagram for GTA.EntityBone:

Public Member Functions
Vector3	GetOffsetPosition (Vector3 offset)
	Gets the position in world coordinates of an offset relative this EntityBone More...

Vector3	GetRelativeOffsetPosition (Vector3 offset)
	Gets the position relative to the Entity of an offset relative this EntityBone More...

Vector3	GetPositionOffset (Vector3 worldCoords)
	Gets the relative offset of this EntityBone from a world coordinates position More...

Vector3	GetRelativePositionOffset (Vector3 entityOffset)
	Gets the relative offset of this EntityBone from an offset from the Entity More...

override bool	Equals (object obj)
	Determines if an object refers to the same bone as this EntityBone. More...

override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (EntityBone left, EntityBone right)
	Determines if two EntityBones refer to the same bone. More...

static bool	operator!= (EntityBone left, EntityBone right)
	Determines if two EntityBones don't refer to the same bone. More...

static bool	operator== (EntityBone entityBone, Bone boneId)
	Determines if an EntityBone refers to a specific bone. More...

static bool	operator!= (EntityBone entityBone, Bone boneId)
	Determines if an EntityBone doesn't refer to a specific bone. More...

static implicit	operator int (EntityBone entityBone)
	Converts an EntityBone to a bone index. More...

static implicit	operator InputArgument (EntityBone entityBone)
	Converts an EntityBone to a native input argument. More...

Public Attributes
bool	IsValid => Owner.Exists() && Index != -1
	Determines if this EntityBone is valid. More...

Vector3	Position => Function.Call<Vector3>(Hash.GET_WORLD_POSITION_OF_ENTITY_BONE, Owner.Handle, Index)
	Gets the position of this EntityBone in world coordinates. More...

Properties
int	Index `[get]`
	Gets the bone index of this EntityBone. More...

Entity	Owner `[get]`
	Gets the owner Entity this bone belongs to. More...

Matrix	PoseMatrix `[get, set]`
	Gets or sets the dynamic Matrix of this EntityBone relative to the Entity its part of. More...

Matrix	RelativeMatrix `[get]`
	Gets the Matrix of this EntityBone relative to the Entity its part of. More...

Vector3	Pose `[get, set]`
	Gets or sets the current pose offset (dynamic position) of this EntityBone relative to the Entity its part of. More...

Vector3	RelativePosition `[get]`
	Gets the position of this EntityBone relative to the Entity its part of. More...

Vector3	UpVector `[get]`
	Gets the vector that points above this EntityBone relative to the world. More...

Vector3	RightVector `[get]`
	Gets the vector that points to the right of this EntityBone relative to the world. More...

Vector3	ForwardVector `[get]`
	Gets the vector that points in front of this EntityBone relative to the world. More...

Vector3	RelativeUpVector `[get]`
	Gets the vector that points above this EntityBone relative to the Entity its part of. More...

Vector3	RelativeRightVector `[get]`
	Gets the vector that points to the right of this EntityBone relative to the Entity its part of. More...

Vector3	RelativeForwardVector `[get]`
	Gets the vector that points in front of this EntityBone relative to the Entity its part of. More...

Member Function Documentation

◆ Equals()

override bool GTA.EntityBone.Equals ( object obj )

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

Parameters

obj	The object to check.

Returns: true if the obj is the same bone as this EntityBone; otherwise, false.

◆ GetHashCode()

override int GTA.EntityBone.GetHashCode ( )

◆ GetOffsetPosition()

Vector3 GTA.EntityBone.GetOffsetPosition ( Vector3 offset )

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

Parameters

offset The offset from this EntityBone.

◆ GetPositionOffset()

Vector3 GTA.EntityBone.GetPositionOffset ( Vector3 worldCoords )

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

Parameters

worldCoords The world coordinates.

◆ GetRelativeOffsetPosition()

Vector3 GTA.EntityBone.GetRelativeOffsetPosition ( Vector3 offset )

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

Parameters

offset The offset from this EntityBone.

◆ GetRelativePositionOffset()

Vector3 GTA.EntityBone.GetRelativePositionOffset ( Vector3 entityOffset )

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

Parameters

entityOffset The Entity offset.

◆ operator InputArgument()

static implicit GTA.EntityBone.operator InputArgument ( EntityBone entityBone )

static

Converts an EntityBone to a native input argument.

◆ operator int()

static implicit GTA.EntityBone.operator int ( EntityBone entityBone )

static

Converts an EntityBone to a bone index.

◆ operator!=() [1/2]

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

static

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

Parameters

entityBone	The EntityBone to check.
boneId	The Bone ID to check against.

Returns: true if entityBone does not refer to the boneId ; otherwise, false.

◆ operator!=() [2/2]

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

static

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

Parameters

left	The left EntityBone.
right	The right EntityBone.

Returns: true if left is not the same bone as right ; otherwise, false.

◆ operator==() [1/2]

static bool GTA.EntityBone.operator==	(	EntityBone	entityBone,
		Bone	boneId
	)

static

Determines if an EntityBone refers to a specific bone.

Parameters

entityBone	The EntityBone to check.
boneId	The Bone ID to check against.

Returns: true if entityBone refers to the boneId ; otherwise, false.

◆ operator==() [2/2]

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

static

Determines if two EntityBones refer to the same bone.

Parameters

left	The left EntityBone.
right	The right EntityBone.

Returns: true if left is the same bone as right ; otherwise, false.

Member Data Documentation

◆ IsValid

bool GTA.EntityBone.IsValid => Owner.Exists() && Index != -1

Determines if this EntityBone is valid.

◆ Position

Vector3 GTA.EntityBone.Position => Function.Call<Vector3>(Hash.GET_WORLD_POSITION_OF_ENTITY_BONE, Owner.Handle, Index)

Gets the position of this EntityBone in world coordinates.

Property Documentation

◆ ForwardVector

Vector3 GTA.EntityBone.ForwardVector

get

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

◆ Index

int GTA.EntityBone.Index

get

Gets the bone index of this EntityBone.

◆ Owner

Entity GTA.EntityBone.Owner

get

Gets the owner Entity this bone belongs to.

◆ Pose

Vector3 GTA.EntityBone.Pose

getset

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

◆ PoseMatrix

Matrix GTA.EntityBone.PoseMatrix

getset

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

◆ RelativeForwardVector

Vector3 GTA.EntityBone.RelativeForwardVector

get

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

◆ RelativeMatrix

Matrix GTA.EntityBone.RelativeMatrix

get

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

◆ RelativePosition

Vector3 GTA.EntityBone.RelativePosition

get

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

◆ RelativeRightVector

Vector3 GTA.EntityBone.RelativeRightVector

get

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

◆ RelativeUpVector

Vector3 GTA.EntityBone.RelativeUpVector

get

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

◆ RightVector

Vector3 GTA.EntityBone.RightVector

get

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

◆ UpVector

Vector3 GTA.EntityBone.UpVector

get

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

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

C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA/Entities/EntityBone.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Member Function Documentation

◆ Equals()

◆ GetHashCode()

◆ GetOffsetPosition()

◆ GetPositionOffset()

◆ GetRelativeOffsetPosition()

◆ GetRelativePositionOffset()

◆ operator InputArgument()

◆ operator int()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

Member Data Documentation

◆ IsValid

◆ Position

Property Documentation

◆ ForwardVector

◆ Index

◆ Owner

◆ Pose

◆ PoseMatrix

◆ RelativeForwardVector

◆ RelativeMatrix

◆ RelativePosition

◆ RelativeRightVector

◆ RelativeUpVector

◆ RightVector

◆ UpVector