Class GrabHelper

Inheritance
System.Object
Message
CustomHelper
GrabHelper
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: GTA.NaturalMotion
Assembly: ScriptHookVDotNet2.dll
Syntax
public sealed class GrabHelper : CustomHelper

Constructors

Name Description
GrabHelper(Ped)

Creates a new Instance of the GrabHelper for sending a Grab Message to a given Ped.

Properties

Name Description
ArmStiffness

Stiffness of the arm.
BodyStiffness

Stiffness of upper body. Scales the arm grab such that the armStiffness is default when this is at default value.
DontLetGo

Once a constraint is made, keep reaching with whatever hand is allowed - no matter what the angle/distance and whether or not the constraint has broken due to constraintForce GT grabStrength. mmmtodo this is a badly named parameter.
DropWeaponDistance

Distance below which a weapon carrying hand will request weapon to be dropped.
DropWeaponIfNecessary

If hasn't grabbed when weapon carrying hand is close to target, grab anyway.
FromEA

Use 2 point.
GrabDistance

Relative distance at which the grab starts.
GrabHoldMaxTimer

Amount of time, in seconds, before grab automatically bails.
GrabStrength

Strength in hands for grabbing (kg m/s), -1 to ignore/disable.
HandsCollide

Hand collisions on when grabbing (false turns off hand collisions making grab more stable esp. To grab points slightly inside geometry).
InstanceIndex

LevelIndex of instance to grab (-1 = world coordinates).
InstancePartIndex

BoundIndex of part on instance to grab (0 = just use instance coordinates).
JustBrace

Flag to toggle between grabbing and bracing.
LookAtGrab

If true, the character will look at the grab.
MaxReachDistance

Distance to reach out towards the grab point.
MaxWristAngle

When we are grabbing the max angle the wrist ccan be at before we break the grab.
Move2Radius

Relative distance (additional to grabDistance - doesn't try to move inside grabDistance)at which the grab tries to use the balancer to move to the grab point.
NormalL

Normal for the left grab point.
NormalL2

Normal for the 3rd left grab point (if pointsX4grab=true).
NormalR

Normal for the right grab point.
NormalR2

Normal for the 2nd right grab point (if pointsX4grab=true).
OneSideReachAngle

Angle at which we will only reach with one hand.
OrientationConstraintScale

Scale torque used to rotate hands to face normals.
PointsX4grab

Use 2 point.
Pos1

Grab pos1, right hand if not using line or surface grab.
Pos2

Grab pos2, left hand if not using line or surface grab.
Pos3
Pos4
PullUpStrengthLeft

Strength to pull up with the left arm. 0 = no pull up.
PullUpStrengthRight

Strength to pull up with the right arm. 0 = no pull up.
PullUpTime

Time to reach the full pullup strength.
ReachAngle

Angle from front at which the grab activates. If the point is outside this angle from front will not try to grab.
StickyHands

Strength of cheat force on hands to pull towards target and stick to target ("cleverHandIK" strength).
SurfaceGrab

Toggle surface grab on. Requires pos1,pos2,pos3 and pos4 to be specified.
TargetForHeadLook

Only used if useHeadLookToTarget is true, the target in world space to look at.
TurnToTarget
UseHeadLookToTarget

If true, the character will look at targetForHeadLook after a hand grabs until the end of the behavior. (Before grabbing it looks at the grab target).
UseLeft

Flag to toggle use of left hand.
UseLineGrab

Use the line grab, Grab along the line (x-x2).
UseRight

Flag to toggle the use of the Right hand.