Class ArmsWindmillHelper

Inheritance

Object

CustomHelper

ArmsWindmillHelper

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

Constructors

| Improve this Doc View Source

ArmsWindmillHelper(Ped)

Creates a new Instance of the ArmsWindmillHelper for sending a ArmsWindmill Message to a given Ped.

Declaration

public ArmsWindmillHelper(Ped ped)

Parameters

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

Properties

| Improve this Doc View Source

AdaptiveMode

Declaration

public AdaptiveMode AdaptiveMode { set; }

Property Value

Type	Description
AdaptiveMode

Remarks

Default value = NotAdaptive.

| Improve this Doc View Source

AngVelGain

Multiplies angular speed of character to get speed of arms.

Declaration

public float AngVelGain { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

AngVelThreshold

Value of character angular speed above which adaptive arm motion starts.

Declaration

public float AngVelThreshold { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

DisableOnImpact

If true, each arm will stop windmilling if it hits the ground.

Declaration

public bool DisableOnImpact { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

DragReduction

How much to compensate for movement of character/target.

Declaration

public float DragReduction { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ElbowDamping

Damping applied to the elbows.

Declaration

public float ElbowDamping { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ElbowStiffness

Stiffness applied to the elbows.

Declaration

public float ElbowStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ForceSync

Toggles phase synchronization.

Declaration

public bool ForceSync { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

IKtwist

Angle of elbow around twist axis ?.

Declaration

public float IKtwist { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -3.1f. Max value = 3.1f.

| Improve this Doc View Source

LeftCentre

Centre of circle in the space of partID.

Declaration

public Vector3 LeftCentre { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.5f, -0.1f).

| Improve this Doc View Source

LeftElbowMin

Minimum left elbow bend.

Declaration

public float LeftElbowMin { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.5f. Min value = 0.0f. Max value = 1.7f.

| Improve this Doc View Source

LeftNormal

Euler Angles orientation of circle in space of part with part ID.

Declaration

public Vector3 LeftNormal { set; }

Property Value

Type	Description
Vector3

Remarks

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

| Improve this Doc View Source

LeftPartID

ID of part that the circle uses as local space for positioning.

Declaration

public int LeftPartID { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 10. Min value = 0. Max value = 21.

| Improve this Doc View Source

LeftRadius1

Radius for first axis of ellipse.

Declaration

public float LeftRadius1 { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

LeftRadius2

Radius for second axis of ellipse.

Declaration

public float LeftRadius2 { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

LeftSpeed

Speed of target around the circle.

Declaration

public float LeftSpeed { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

MirrorMode

Declaration

public MirrorMode MirrorMode { set; }

Property Value

Type	Description
MirrorMode

Remarks

Default value = Mirrored. If Parallel leftArm parameters are used.

| Improve this Doc View Source

PhaseOffset

Phase offset(degrees) when phase synchronization is turned on.

Declaration

public float PhaseOffset { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.0f. Min value = -360.0f. Max value = 360.0f.

| Improve this Doc View Source

RightCentre

Centre of circle in the space of partID.

Declaration

public Vector3 RightCentre { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, -0.5f, -0.1f).

| Improve this Doc View Source

RightElbowMin

Minimum right elbow bend.

Declaration

public float RightElbowMin { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.5f. Min value = 0.0f. Max value = 1.7f.

| Improve this Doc View Source

RightNormal

Euler Angles orientation of circle in space of part with part ID.

Declaration

public Vector3 RightNormal { set; }

Property Value

Type	Description
Vector3

Remarks

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

| Improve this Doc View Source

RightPartID

ID of part that the circle uses as local space for positioning.

Declaration

public int RightPartID { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 10. Min value = 0. Max value = 21.

| Improve this Doc View Source

RightRadius1

Radius for first axis of ellipse.

Declaration

public float RightRadius1 { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

RightRadius2

Radius for second axis of ellipse.

Declaration

public float RightRadius2 { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

RightSpeed

Speed of target around the circle.

Declaration

public float RightSpeed { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ShoulderDamping

Damping applied to the shoulders.

Declaration

public float ShoulderDamping { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

ShoulderStiffness

Stiffness applied to the shoulders.

Declaration

public float ShoulderStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

| Improve this Doc View Source

UseLeft

Use the left arm.

Declaration

public bool UseLeft { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

| Improve this Doc View Source

UseRight

Use the right arm.

Declaration

public bool UseRight { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.