SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.NaturalMotion.Message Class Reference

A base class for manually building a GTA.NaturalMotion.Message. More...

Public Member Functions

 Message (string message)
 Creates a class to manually build Messages that can be sent to any Ped. More...
 
void Abort (Ped target)
 Stops this Natural Motion behavior on the given Ped. More...
 
void SendTo (Ped target)
 Starts this Natural Motion behavior on the Ped that will loop until manually aborted. More...
 
void SendTo (Ped target, int duration)
 Starts this Natural Motion behavior on the Ped for a specified duration. 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...
 

Detailed Description

A base class for manually building a GTA.NaturalMotion.Message.

Constructor & Destructor Documentation

◆ Message()

GTA.NaturalMotion.Message.Message ( string  message)

Creates a class to manually build Messages that can be sent to any Ped.

Parameters
messageThe name of the natural motion message.

Member Function Documentation

◆ Abort()

void GTA.NaturalMotion.Message.Abort ( Ped  target)

Stops this Natural Motion behavior on the given Ped.

Parameters
targetThe Ped to send the Abort Message to.

◆ ResetArguments()

void GTA.NaturalMotion.Message.ResetArguments ( )

Resets all arguments to their default values.

◆ SendTo() [1/2]

void GTA.NaturalMotion.Message.SendTo ( Ped  target)

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

Parameters
targetThe Ped to send the Message to.

◆ SendTo() [2/2]

void GTA.NaturalMotion.Message.SendTo ( Ped  target,
int  duration 
)

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

Parameters
targetThe Ped to send the Message to.
durationHow long to apply the behavior for (-1 for looped).

◆ SetArgument() [1/5]

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

Sets a Message argument to a bool value.

Parameters
argNameThe argument name.
valueThe value to set the argument to.

◆ SetArgument() [2/5]

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

Sets a Message argument to a float value.

Parameters
argNameThe argument name.
valueThe value to set the argument to.

◆ SetArgument() [3/5]

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

Sets a Message argument to a int value.

Parameters
argNameThe argument name.
valueThe value to set the argument to.

◆ SetArgument() [4/5]

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

Sets a Message argument to a string value.

Parameters
argNameThe argument name.
valueThe value to set the argument to.

◆ SetArgument() [5/5]

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

Sets a Message argument to a Vector3 value.

Parameters
argNameThe argument name.
valueThe value to set the argument to.

◆ ToString()

override string GTA.NaturalMotion.Message.ToString ( )

Returns the internal message name.


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