Class LeanTowardsObjectHelper

Inheritance

Object

CustomHelper

LeanTowardsObjectHelper

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

Constructors

LeanTowardsObjectHelper(Ped)

Creates a new Instance of the LeanTowardsObjectHelper for sending a LeanTowardsObject Message to a given Ped.

Declaration

public LeanTowardsObjectHelper(Ped ped)

Parameters

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

Properties

BoundIndex

BoundIndex of object to lean towards (0 = just use instance coordinates).

Declaration

public int BoundIndex { set; }

Property Value

Type	Description
Int32

Remarks

Default value = 0. Min value = 0.

InstanceIndex

LevelIndex of object to lean towards.

Declaration

public int InstanceIndex { set; }

Property Value

Type	Description
Int32

Remarks

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

LeanAmount

Amount of lean, 0 to about 0.5. -ve will move away from the target.

Declaration

public float LeanAmount { set; }

Property Value

Type	Description
Single

Remarks

Default value = 0.2f. Min value = -0.5f. Max value = 0.5f.

Offset

Offset from instance position added when calculating position to lean to.

Declaration

public Vector3 Offset { set; }

Property Value

Type	Description
Vector3

Remarks

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