GTA.NaturalMotion.CustomHelper Class Reference

A helper class for building a

See also

GTA.NaturalMotion.Message

and sending it to a given Ped. More...

Inheritance diagram for GTA.NaturalMotion.CustomHelper:

Public Member Functions
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...

Protected Member Functions
	CustomHelper (Ped target, string message)
	Creates a helper class for building Natural Motion messages to send to a given Ped. More...

Detailed Description

A helper class for building a

See also

GTA.NaturalMotion.Message

and sending it to a given Ped.

Constructor & Destructor Documentation

CustomHelper()

GTA.NaturalMotion.CustomHelper.CustomHelper ( Ped  target, string  message  )

protected

Creates a helper class for building Natural Motion messages to send to a given Ped.

Parameters

target	The Ped that the message will be applied to.
message	The name of the natural motion message.

Member Function Documentation

ResetArguments()

void GTA.NaturalMotion.CustomHelper.ResetArguments

(

)

Resets all arguments to their default values.

SetArgument() [1/5]

void GTA.NaturalMotion.CustomHelper.SetArgument	(	string	argName,
		bool	value
	)

Sets a Message argument to a bool value.

Parameters

argName	The argument name.
value	The value to set the argument to.

SetArgument() [2/5]

void GTA.NaturalMotion.CustomHelper.SetArgument	(	string	argName,
		float	value
	)

Sets a Message argument to a float value.

Parameters

argName	The argument name.
value	The value to set the argument to.

SetArgument() [3/5]

void GTA.NaturalMotion.CustomHelper.SetArgument	(	string	argName,
		int	value
	)

Sets a Message argument to a int value.

Parameters

argName	The argument name.
value	The value to set the argument to.

SetArgument() [4/5]

void GTA.NaturalMotion.CustomHelper.SetArgument	(	string	argName,
		string	value
	)

Sets a Message argument to a string value.

Parameters

argName	The argument name.
value	The value to set the argument to.

SetArgument() [5/5]

void GTA.NaturalMotion.CustomHelper.SetArgument	(	string	argName,
		Vector3	value
	)

Sets a Message argument to a Vector3 value.

Parameters

argName	The argument name.
value	The value to set the argument to.

Start() [1/2]

void GTA.NaturalMotion.CustomHelper.Start

(

)

Starts this Natural Motion behavior on the Ped that will loop until manually aborted.

Start() [2/2]

void GTA.NaturalMotion.CustomHelper.Start

(

int

duration

)

Starts this Natural Motion behavior on the Ped for a specified duration.

Parameters

duration

How long to apply the behavior for (-1 for looped).

Stop()

void GTA.NaturalMotion.CustomHelper.Stop

(

)

Stops this Natural Motion behavior on the Ped.

ToString()

override string GTA.NaturalMotion.CustomHelper.ToString

(

)

Returns the internal message name.

---

The documentation for this class was generated from the following file:

• C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA.NaturalMotion/EuphoriaBase.cs