Class PedalLegsHelper

Inheritance

Object

CustomHelper

PedalLegsHelper

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

Constructors

PedalLegsHelper(Ped)

Creates a new Instance of the PedalLegsHelper for sending a PedalLegs Message to a given Ped.

Declaration

public PedalLegsHelper(Ped ped)

Parameters

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

Properties

AdaptivePedal4Dragging

Will pedal in the direction of travel (if backPedal = false, against travel if backPedal = true) and with an angular velocity relative to speed upto a maximum of 13(rads/sec). Use when being dragged by a car. Overrides angularSpeed.

Declaration

public bool AdaptivePedal4Dragging { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

AngSpeedMultiplier4Dragging

NewAngularSpeed = Clamp(angSpeedMultiplier4Dragging * linear_speed/pedalRadius, 0.0, angularSpeed).

Declaration

public float AngSpeedMultiplier4Dragging { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.3f. Min value = 0.0f. Max value = 100.0f.

AngularSpeed

Rate of pedaling. If adaptivePedal4Dragging is true then the legsAngularSpeed calculated to match the linear speed of the character can have a maximum value of angularSpeed (this max used to be hard coded to 13.0).

Declaration

public float AngularSpeed { set; }

Property Value

Type	Description
Single

Remarks

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

BackPedal

Pedal forwards or backwards.

Declaration

public bool BackPedal { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

CentreForwards

Move the center of the pedal for both legs forward (or backward -ve).

Declaration

public float CentreForwards { set; }

Property Value

Type	Description
Single

Remarks

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

CentreSideways

Move the center of the pedal for both legs sideways (+ve = right). NB: not applied to hula.

Declaration

public float CentreSideways { set; }

Property Value

Type	Description
Single

Remarks

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

CentreUp

Move the center of the pedal for both legs up (or down -ve).

Declaration

public float CentreUp { set; }

Property Value

Type	Description
Single

Remarks

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

DragReduction

How much to account for the target moving through space rather than being static.

Declaration

public float DragReduction { set; }

Property Value

Type	Description
Single

Remarks

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

Ellipse

Turn the circle into an ellipse. Ellipse has horizontal radius a and vertical radius b. If ellipse is +ve then a=radiusellipse and b=radius. If ellipse is -ve then a=radius and b = radiusellipse. 0.0 = vertical line of length 2radius, 0.0:1.0 circle squashed horizontally (vertical radius = radius), 1.0=circle. -0.001 = horizontal line of length 2radius, -0.0:-1.0 circle squashed vertically (horizontal radius = radius), -1.0 = circle.

Declaration

public float Ellipse { set; }

Property Value

Type	Description
Single

Remarks

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

Hula

If true circle the legs in a hula motion.

Declaration

public bool Hula { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

LegAngleVariance

0-1 value used to vary the angle of the legs from the hips during the pedal.

Declaration

public float LegAngleVariance { set; }

Property Value

Type	Description
Single

Remarks

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

LegStiffness

Stiffness of legs.

Declaration

public float LegStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

PedalLeftLeg

Pedal with this leg or not.

Declaration

public bool PedalLeftLeg { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

PedalOffset

Move the center of the pedal for the left leg up by this amount, the right leg down by this amount.

Declaration

public float PedalOffset { set; }

Property Value

Type	Description
Single

Remarks

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

PedalRightLeg

Pedal with this leg or not.

Declaration

public bool PedalRightLeg { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

Radius

Base radius of pedal action.

Declaration

public float Radius { set; }

Property Value

Type	Description
Single

Remarks

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

RadiusVariance

0-1 value used to add variance to the radius value while pedalling, to desynchonize the legs' movement and provide some variety.

Declaration

public float RadiusVariance { set; }

Property Value

Type	Description
Single

Remarks

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

RandomSeed

Random seed used to generate speed changes.

Declaration

public int RandomSeed { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 100. Min value = 0.

SpeedAsymmetry

Random offset applied per leg to the angular speed to desynchronize the pedaling - set to 0 to disable, otherwise should be set to less than the angularSpeed value.

Declaration

public float SpeedAsymmetry { set; }

Property Value

Type	Description
Single

Remarks

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

Spread

Spread legs.

Declaration

public float Spread { set; }

Property Value

Type	Description
Single

Remarks

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