Class AnimPoseHelper

Inheritance

Object

CustomHelper

AnimPoseHelper

Inherited Members

CustomHelper.Start()

CustomHelper.Start(Int32)

CustomHelper.Stop()

CustomHelper.SetArgument(String, Boolean)

CustomHelper.SetArgument(String, Int32)

CustomHelper.SetArgument(String, Single)

CustomHelper.SetArgument(String, String)

CustomHelper.SetArgument(String, Vector3)

CustomHelper.ResetArguments()

CustomHelper.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: GTA.NaturalMotion

Assembly: ScriptHookVDotNet3.dll

Syntax

public sealed class AnimPoseHelper : CustomHelper

Constructors

AnimPoseHelper(Ped)

Creates a new Instance of the AnimPoseHelper for sending a AnimPose Message to a given Ped.

Declaration

public AnimPoseHelper(Ped ped)

Parameters

Type	Name	Description
Ped	ped	The Ped to send the AnimPose Message to.

Properties

AnimSource

Declaration

public AnimSource AnimSource { set; }

Property Value

Type	Description
AnimSource

ConnectedLeftFoot

Is the left foot constrained to the world/ an object: -2=do not set in animpose (e.g. let the balancer decide), -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Declaration

public int ConnectedLeftFoot { set; }

Property Value

Type	Description
Int32

Remarks

Default value = -2. Min value = -2. Max value = 2.

ConnectedLeftHand

Is the left hand constrained to the world/ an object: -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Declaration

public int ConnectedLeftHand { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = -1. Max value = 2.

ConnectedRightFoot

Is the right foot constrained to the world/ an object: -2=do not set in animpose (e.g. let the balancer decide),-1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Declaration

public int ConnectedRightFoot { set; }

Property Value

Type	Description
Int32

Remarks

Default value = -2. Min value = -2. Max value = 2.

ConnectedRightHand

Is the right hand constrained to the world/ an object: -1=auto decide by impact info, 0=no, 1=part fully constrained (not implemented:, 2=part point constraint, 3=line constraint).

Declaration

public int ConnectedRightHand { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = -1. Max value = 2.

DampenSideMotionInstanceIndex

LevelIndex of object to dampen side motion relative to. -1 means not used.

Declaration

public int DampenSideMotionInstanceIndex { set; }

Property Value

Type	Description
Int32

Remarks

Default value = -1. Min value = -1.

Damping

Damping of masked joints.

Declaration

public float Damping { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

DampingLeftArm

Damping applied to left arm (applied after stiffness). If stiffness -ve then not applied (use current setting).

Declaration

public float DampingLeftArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

DampingLeftLeg

Damping applied to left leg (applied after stiffness). If stiffness-ve then not applied (use current setting).

Declaration

public float DampingLeftLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

DampingRightArm

Damping applied to right arm (applied after stiffness). If stiffness -ve then not applied (use current setting).

Declaration

public float DampingRightArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

DampingRightLeg

Damping applied to right leg (applied after stiffness). If stiffness -ve then not applied (use current setting).

Declaration

public float DampingRightLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

DampingSpine

Damping applied to spine (applied after stiffness). If stiffness-ve then not applied (use current setting).

Declaration

public float DampingSpine { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.0f. Min value = 0.0f. Max value = 2.0f.

EffectorMask

Two character body-masking value, bitwise joint mask or bitwise logic string of two character body-masking value (see notes for explanation).

Declaration

public string EffectorMask { set; }

Property Value

Type	Description
String

Remarks

Default value = "ub".

GravCompLeftArm

Gravity compensation applied to left arm (applied after gravityCompensation). If -ve then not applied (use current setting).

Declaration

public float GravCompLeftArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

GravCompLeftLeg

Gravity compensation applied to left leg (applied after gravityCompensation). If -ve then not applied (use current setting).

Declaration

public float GravCompLeftLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

GravCompRightArm

Gravity compensation applied to right arm (applied after gravityCompensation). If -ve then not applied (use current setting).

Declaration

public float GravCompRightArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

GravCompRightLeg

Gravity compensation applied to right leg (applied after gravityCompensation). If -ve then not applied (use current setting).

Declaration

public float GravCompRightLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

GravCompSpine

Gravity compensation applied to spine (applied after gravityCompensation). If -ve then not applied (use current setting).

Declaration

public float GravCompSpine { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

GravityCompensation

Gravity compensation applied to joints in the effectorMask. If -ve then not applied (use current setting).

Declaration

public float GravityCompensation { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 14.0f.

MuscleStiffness

Muscle stiffness of masked joints. -values mean don't apply (just use defaults or ones applied by behaviors - safer if you are going to return to a behavior).

Declaration

public float MuscleStiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.1f. Max value = 10.0f.

MuscleStiffnessLeftArm

Muscle stiffness applied to left arm (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float MuscleStiffnessLeftArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

MuscleStiffnessLeftLeg

Muscle stiffness applied to left leg (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float MuscleStiffnessLeftLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

MuscleStiffnessRightArm

Muscle stiffness applied to right arm (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float MuscleStiffnessRightArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

MuscleStiffnessRightLeg

Muscle stiffness applied to right leg (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float MuscleStiffnessRightLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

MuscleStiffnessSpine

Muscle stiffness applied to spine (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float MuscleStiffnessSpine { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 10.0f.

OverideHeadlook

Overide Headlook behavior (if animPose includes the head).

Declaration

public bool OverideHeadlook { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

OveridePointArm

Overide PointArm behavior (if animPose includes the arm/arms).

Declaration

public bool OveridePointArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

OveridePointGun

Overide PointGun behavior (if animPose includes the arm/arms)//mmmmtodo not used at moment.

Declaration

public bool OveridePointGun { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

Stiffness

Stiffness of masked joints. -ve values mean don't apply stiffness or damping (just use defaults or ones applied by behaviors). If you are using animpose fullbody on its own then this gives the opprtunity to use setStffness and setMuscle stiffness messages to set up the character's muscles. Mmmmtodo get rid of this -ve.

Declaration

public float Stiffness { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.1f. Max value = 16.0f.

StiffnessLeftArm

Stiffness applied to left arm (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float StiffnessLeftArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

StiffnessLeftLeg

Stiffness applied to left leg (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float StiffnessLeftLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

StiffnessRightArm

Stiffness applied to right arm (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float StiffnessRightArm { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

StiffnessRightLeg

Stiffness applied to right leg (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float StiffnessRightLeg { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

StiffnessSpine

Stiffness applied to spine (applied after stiffness). If -ve then not applied (use current setting).

Declaration

public float StiffnessSpine { set; }

Property Value

Type	Description
Single

Remarks

Default value = -1.0f. Min value = -1.0f. Max value = 16.0f.

UseZMPGravityCompensation

If true then modify gravity compensation based on stance (can reduce gravity compensation to zero if cofm is outside of balance area).

Declaration

public bool UseZMPGravityCompensation { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.