Class GrabHelper

Inheritance

Object

CustomHelper

GrabHelper

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

Constructors

GrabHelper(Ped)

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

Declaration

public GrabHelper(Ped ped)

Parameters

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

Properties

ArmStiffness

Stiffness of the arm.

Declaration

public float ArmStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

BodyStiffness

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

Declaration

public float BodyStiffness { set; }

Property Value

Type	Description
Single

Remarks

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

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.

Declaration

public bool DontLetGo { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

DropWeaponDistance

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

Declaration

public float DropWeaponDistance { set; }

Property Value

Type	Description
Single

Remarks

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

DropWeaponIfNecessary

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

Declaration

public bool DropWeaponIfNecessary { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

FromEA

Use 2 point.

Declaration

public bool FromEA { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

GrabDistance

Relative distance at which the grab starts.

Declaration

public float GrabDistance { set; }

Property Value

Type	Description
Single

Remarks

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

GrabHoldMaxTimer

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

Declaration

public float GrabHoldMaxTimer { set; }

Property Value

Type	Description
Single

Remarks

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

GrabStrength

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

Declaration

public float GrabStrength { set; }

Property Value

Type	Description
Single

Remarks

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

HandsCollide

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

Declaration

public bool HandsCollide { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

InstanceIndex

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

Declaration

public int InstanceIndex { set; }

Property Value

Type	Description
Int32

Remarks

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

InstancePartIndex

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

Declaration

public int InstancePartIndex { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = 0.

JustBrace

Flag to toggle between grabbing and bracing.

Declaration

public bool JustBrace { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

LookAtGrab

If true, the character will look at the grab.

Declaration

public bool LookAtGrab { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = True.

MaxReachDistance

Distance to reach out towards the grab point.

Declaration

public float MaxReachDistance { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.7f. Min value = 0.0f. Max value = 4.0f.

MaxWristAngle

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

Declaration

public float MaxWristAngle { set; }

Property Value

Type	Description
Single

Remarks

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

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.

Declaration

public float Move2Radius { set; }

Property Value

Type	Description
Single

Remarks

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

NormalL

Normal for the left grab point.

Declaration

public Vector3 NormalL { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

NormalL2

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

Declaration

public Vector3 NormalL2 { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

NormalR

Normal for the right grab point.

Declaration

public Vector3 NormalR { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

NormalR2

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

Declaration

public Vector3 NormalR2 { set; }

Property Value

Type	Description
Vector3

Remarks

Default value = Vector3(0.0f, 0.0f, 0.0f). Min value = -1.0f. Max value = 1.0f.

OneSideReachAngle

Angle at which we will only reach with one hand.

Declaration

public float OneSideReachAngle { set; }

Property Value

Type	Description
Single

Remarks

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

OrientationConstraintScale

Scale torque used to rotate hands to face normals.

Declaration

public float OrientationConstraintScale { set; }

Property Value

Type	Description
Single

Remarks

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

PointsX4grab

Use 2 point.

Declaration

public bool PointsX4grab { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

Pos1

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

Declaration

public Vector3 Pos1 { set; }

Property Value

Type	Description
Vector3

Remarks

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

Pos2

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

Declaration

public Vector3 Pos2 { set; }

Property Value

Type	Description
Vector3

Remarks

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

Pos3

Declaration

public Vector3 Pos3 { set; }

Property Value

Type	Description
Vector3

Remarks

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

Pos4

Declaration

public Vector3 Pos4 { set; }

Property Value

Type	Description
Vector3

Remarks

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

PullUpStrengthLeft

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

Declaration

public float PullUpStrengthLeft { set; }

Property Value

Type	Description
Single

Remarks

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

PullUpStrengthRight

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

Declaration

public float PullUpStrengthRight { set; }

Property Value

Type	Description
Single

Remarks

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

PullUpTime

Time to reach the full pullup strength.

Declaration

public float PullUpTime { set; }

Property Value

Type	Description
Single

Remarks

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

ReachAngle

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

Declaration

public float ReachAngle { set; }

Property Value

Type	Description
Single

Remarks

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

StickyHands

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

Declaration

public float StickyHands { set; }

Property Value

Type	Description
Single

Remarks

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

SurfaceGrab

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

Declaration

public bool SurfaceGrab { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

TargetForHeadLook

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

Declaration

public Vector3 TargetForHeadLook { set; }

Property Value

Type	Description
Vector3

Remarks

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

TurnToTarget

Declaration

public TurnType TurnToTarget { set; }

Property Value

Type	Description
TurnType

Remarks

Default value = ToTarget.

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).

Declaration

public bool UseHeadLookToTarget { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseLeft

Flag to toggle use of left hand.

Declaration

public bool UseLeft { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseLineGrab

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

Declaration

public bool UseLineGrab { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.

UseRight

Flag to toggle the use of the Right hand.

Declaration

public bool UseRight { set; }

Property Value

Type	Description
Boolean

Remarks

Default value = False.