Public Member Functions | |
| PedalLegsHelper (Ped ped) | |
| Creates a new Instance of the PedalLegsHelper for sending a PedalLegs Message to a given Ped. More... | |
 Public Member Functions inherited from GTA.NaturalMotion.CustomHelper | |
| void | Start () |
| Starts this Natural Motion behavior on the Ped that will loop until manually aborted. More... | |
| void | Start (int duration) |
| Starts this Natural Motion behavior on the Ped for a specified duration. More... | |
| void | Stop () |
| Stops this Natural Motion behavior on the Ped. More... | |
| void | SetArgument (string argName, bool value) |
| Sets a Message argument to a bool value. More... | |
| void | SetArgument (string argName, int value) |
| Sets a Message argument to a int value. More... | |
| void | SetArgument (string argName, float value) |
| Sets a Message argument to a float value. More... | |
| void | SetArgument (string argName, string value) |
| Sets a Message argument to a string value. More... | |
| void | SetArgument (string argName, Vector3 value) |
| Sets a Message argument to a Vector3 value. More... | |
| void | ResetArguments () |
| Resets all arguments to their default values. More... | |
| override string | ToString () |
| Returns the internal message name. More... | |
Properties | |
| bool | PedalLeftLeg [set] |
| Pedal with this leg or not. More... | |
| bool | PedalRightLeg [set] |
| Pedal with this leg or not. More... | |
| bool | BackPedal [set] |
| Pedal forwards or backwards. More... | |
| float | Radius [set] |
| Base radius of pedal action. More... | |
| float | AngularSpeed [set] |
| 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). More... | |
| float | LegStiffness [set] |
| Stiffness of legs. More... | |
| float | PedalOffset [set] |
| Move the center of the pedal for the left leg up by this amount, the right leg down by this amount. More... | |
| int | RandomSeed [set] |
| Random seed used to generate speed changes. More... | |
| float | SpeedAsymmetry [set] |
| 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. More... | |
| bool | AdaptivePedal4Dragging [set] |
| 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. More... | |
| float | AngSpeedMultiplier4Dragging [set] |
| NewAngularSpeed = Clamp(angSpeedMultiplier4Dragging * linear_speed/pedalRadius, 0.0, angularSpeed). More... | |
| float | RadiusVariance [set] |
| 0-1 value used to add variance to the radius value while pedalling, to desynchonize the legs' movement and provide some variety. More... | |
| float | LegAngleVariance [set] |
| 0-1 value used to vary the angle of the legs from the hips during the pedal. More... | |
| float | CentreSideways [set] |
| Move the center of the pedal for both legs sideways (+ve = right). NB: not applied to hula. More... | |
| float | CentreForwards [set] |
| Move the center of the pedal for both legs forward (or backward -ve). More... | |
| float | CentreUp [set] |
| Move the center of the pedal for both legs up (or down -ve). More... | |
| float | Ellipse [set] |
| Turn the circle into an ellipse. Ellipse has horizontal radius a and vertical radius b. If ellipse is +ve then a=radius*ellipse and b=radius. If ellipse is -ve then a=radius and b = radius*ellipse. 0.0 = vertical line of length 2*radius, 0.0:1.0 circle squashed horizontally (vertical radius = radius), 1.0=circle. -0.001 = horizontal line of length 2*radius, -0.0:-1.0 circle squashed vertically (horizontal radius = radius), -1.0 = circle. More... | |
| float | DragReduction [set] |
| How much to account for the target moving through space rather than being static. More... | |
| float | Spread [set] |
| Spread legs. More... | |
| bool | Hula [set] |
| If true circle the legs in a hula motion. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from GTA.NaturalMotion.CustomHelper | |
| CustomHelper (Ped target, string message) | |
| Creates a helper class for building Natural Motion messages to send to a given Ped. More... | |
Constructor & Destructor Documentation
◆ PedalLegsHelper()
| GTA.NaturalMotion.PedalLegsHelper.PedalLegsHelper | ( | Ped | ped | ) |
Creates a new Instance of the PedalLegsHelper for sending a PedalLegs Message to a given Ped.
Property Documentation
◆ AdaptivePedal4Dragging
|
set |
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.
Default value = False.
◆ AngSpeedMultiplier4Dragging
|
set |
NewAngularSpeed = Clamp(angSpeedMultiplier4Dragging * linear_speed/pedalRadius, 0.0, angularSpeed).
Default value = 0.3f. Min value = 0.0f. Max value = 100.0f.
◆ AngularSpeed
|
set |
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).
Default value = 10.0f. Min value = 0.0f. Max value = 100.0f.
◆ BackPedal
|
set |
Pedal forwards or backwards.
Default value = False.
◆ CentreForwards
|
set |
Move the center of the pedal for both legs forward (or backward -ve).
Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.
◆ CentreSideways
|
set |
Move the center of the pedal for both legs sideways (+ve = right). NB: not applied to hula.
Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.
◆ CentreUp
|
set |
Move the center of the pedal for both legs up (or down -ve).
Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.
◆ DragReduction
|
set |
How much to account for the target moving through space rather than being static.
Default value = 0.3f. Min value = 0.0f. Max value = 1.0f.
◆ Ellipse
|
set |
Turn the circle into an ellipse. Ellipse has horizontal radius a and vertical radius b. If ellipse is +ve then a=radius*ellipse and b=radius. If ellipse is -ve then a=radius and b = radius*ellipse. 0.0 = vertical line of length 2*radius, 0.0:1.0 circle squashed horizontally (vertical radius = radius), 1.0=circle. -0.001 = horizontal line of length 2*radius, -0.0:-1.0 circle squashed vertically (horizontal radius = radius), -1.0 = circle.
Default value = 1.0f. Min value = -1.0f. Max value = 1.0f.
◆ Hula
|
set |
If true circle the legs in a hula motion.
Default value = False.
◆ LegAngleVariance
|
set |
0-1 value used to vary the angle of the legs from the hips during the pedal.
Default value = 0.5f. Min value = 0.0f. Max value = 1.0f.
◆ LegStiffness
|
set |
Stiffness of legs.
Default value = 10.0f. Min value = 6.0f. Max value = 16.0f.
◆ PedalLeftLeg
|
set |
Pedal with this leg or not.
Default value = True.
◆ PedalOffset
|
set |
Move the center of the pedal for the left leg up by this amount, the right leg down by this amount.
Default value = 0.0f. Min value = 0.0f. Max value = 1.0f.
◆ PedalRightLeg
|
set |
Pedal with this leg or not.
Default value = True.
◆ Radius
|
set |
Base radius of pedal action.
Default value = 0.3f. Min value = 0.0f. Max value = 2.0f.
◆ RadiusVariance
|
set |
0-1 value used to add variance to the radius value while pedalling, to desynchonize the legs' movement and provide some variety.
Default value = 0.4f. Min value = 0.0f. Max value = 1.0f.
◆ RandomSeed
|
set |
Random seed used to generate speed changes.
Default value = 100. Min value = 0.
◆ SpeedAsymmetry
|
set |
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.
Default value = 8.0f. Min value = -10.0f. Max value = 10.0f.
◆ Spread
|
set |
Spread legs.
Default value = 0.0f. Min value = -1.0f. Max value = 1.0f.
The documentation for this class was generated from the following file:
- C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaHelpers.cs
