Class PointArmHelper

BEHAVIOURS REFERENCED: AnimPose - allows animPose to override body parts: Arms (useLeftArm, useRightArm).

Inheritance

Object

CustomHelper

PointArmHelper

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 PointArmHelper : CustomHelper

Constructors

| Improve this Doc View Source

PointArmHelper(Ped)

Creates a new Instance of the PointArmHelper for sending a PointArm Message to a given Ped.

Declaration

public PointArmHelper(Ped ped)

Parameters

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

Remarks

BEHAVIOURS REFERENCED: AnimPose - allows animPose to override body parts: Arms (useLeftArm, useRightArm).

Properties

| Improve this Doc View Source

ArmDampingLeft

Damping value for arm used to point.

Declaration

public float ArmDampingLeft { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ArmDampingRight

Damping value for arm used to point.

Declaration

public float ArmDampingRight { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ArmStiffnessLeft

Stiffness of arm.

Declaration

public float ArmStiffnessLeft { set; }

Property Value

Type	Description
Single

Remarks

Default value = 15.0f. Min value = 6.0f. Max value = 16.0f.

| Improve this Doc View Source

ArmStiffnessRight

Stiffness of arm.

Declaration

public float ArmStiffnessRight { set; }

Property Value

Type	Description
Single

Remarks

Default value = 15.0f. Min value = 6.0f. Max value = 16.0f.

| Improve this Doc View Source

ArmStraightnessLeft

Values less than 1 can give the arm a more bent look.

Declaration

public float ArmStraightnessLeft { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ArmStraightnessRight

Values less than 1 can give the arm a more bent look.

Declaration

public float ArmStraightnessRight { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

InstanceIndexLeft

Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

Declaration

public int InstanceIndexLeft { set; }

Property Value

Type	Description
Int32

Remarks

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

| Improve this Doc View Source

InstanceIndexRight

Level index of thing to point at, or -1 for none. if -1, target is specified in world space, otherwise it is an offset from the object specified by this index.

Declaration

public int InstanceIndexRight { set; }

Property Value

Type	Description
Int32

Remarks

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

| Improve this Doc View Source

PointSwingLimitLeft

Swing limit.

Declaration

public float PointSwingLimitLeft { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

| Improve this Doc View Source

PointSwingLimitRight

Swing limit.

Declaration

public float PointSwingLimitRight { set; }

Property Value

Type	Description
Single

Remarks

Default value = 1.5f. Min value = 0.0f. Max value = 3.0f.

| Improve this Doc View Source

TargetLeft

Point to point to (in world space).

Declaration

public Vector3 TargetLeft { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f).

| Improve this Doc View Source

TargetRight

Point to point to (in world space).

Declaration

public Vector3 TargetRight { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f).

| Improve this Doc View Source

TwistLeft

Twist of the arm around point direction.

Declaration

public float TwistLeft { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

TwistRight

Twist of the arm around point direction.

Declaration

public float TwistRight { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

UseLeftArm

Declaration

public bool UseLeftArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

UseRightArm

Declaration

public bool UseRightArm { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

UseZeroPoseWhenNotPointingLeft

Declaration

public bool UseZeroPoseWhenNotPointingLeft { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

| Improve this Doc View Source

UseZeroPoseWhenNotPointingRight

Declaration

public bool UseZeroPoseWhenNotPointingRight { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.