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.PedGroup Class Reference
Inheritance diagram for GTA.PedGroup:
GTA.PoolObject GTA.Native.INativeValue GTA.IDeletable GTA.IExistable

Classes

class  Enumerator
 

Public Member Functions

 PedGroup ()
 
 PedGroup (int handle)
 
void Dispose ()
 
void Add (Ped ped, bool leader)
 
void Remove (Ped ped)
 
bool Contains (Ped ped)
 
Ped GetMember (int index)
 
Ped[] ToArray (bool includingLeader=true)
 
List< PedToList (bool includingLeader=true)
 
override void Delete ()
 Removes this PedGroup. More...
 
override bool Exists ()
 Determines if this PedGroup exists. More...
 
override bool Equals (object obj)
 Determines if an object refers to the same group as this PedGroup. More...
 
override int GetHashCode ()
 
IEnumerator< PedGetEnumerator ()
 

Static Public Member Functions

static bool operator== (PedGroup left, PedGroup right)
 Determines if two PedGroups refer to the same group. More...
 
static bool operator!= (PedGroup left, PedGroup right)
 Determines if two PedGroups don't refer to the same group. More...
 
static implicit operator InputArgument (PedGroup value)
 Converts a PedGroup to a native input argument. More...
 

Properties

int MemberCount [get]
 
float SeparationRange [set]
 
Formation Formation [set]
 
PedLeader [get]
 
- Properties inherited from GTA.PoolObject
int Handle [get, protected set]
 The handle of the object. More...
 
ulong NativeValue [get, set]
 The handle of the object translated to a native value. More...
 
- Properties inherited from GTA.Native.INativeValue
ulong NativeValue [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from GTA.PoolObject
 PoolObject (int handle)
 

Constructor & Destructor Documentation

◆ PedGroup() [1/2]

GTA.PedGroup.PedGroup ( )

◆ PedGroup() [2/2]

GTA.PedGroup.PedGroup ( int  handle)

Member Function Documentation

◆ Add()

void GTA.PedGroup.Add ( Ped  ped,
bool  leader 
)

◆ Contains()

bool GTA.PedGroup.Contains ( Ped  ped)

◆ Delete()

override void GTA.PedGroup.Delete ( )
virtual

Removes this PedGroup.

Implements GTA.PoolObject.

◆ Dispose()

void GTA.PedGroup.Dispose ( )

◆ Equals()

override bool GTA.PedGroup.Equals ( object  obj)

Determines if an object refers to the same group as this PedGroup.

Parameters
objThe object to check.
Returns
true if the obj is the same group as this PedGroup; otherwise, false.

◆ Exists()

override bool GTA.PedGroup.Exists ( )
virtual

Determines if this PedGroup exists.

Returns
true if this PedGroup exists; otherwise, false.

Implements GTA.PoolObject.

◆ GetEnumerator()

IEnumerator<Ped> GTA.PedGroup.GetEnumerator ( )

◆ GetHashCode()

override int GTA.PedGroup.GetHashCode ( )

◆ GetMember()

Ped GTA.PedGroup.GetMember ( int  index)

◆ operator InputArgument()

static implicit GTA.PedGroup.operator InputArgument ( PedGroup  value)
static

Converts a PedGroup to a native input argument.

◆ operator!=()

static bool GTA.PedGroup.operator!= ( PedGroup  left,
PedGroup  right 
)
static

Determines if two PedGroups don't refer to the same group.

Parameters
leftThe left PedGroup.
rightThe right PedGroup.
Returns
true if left is not the same group as right ; otherwise, false.

◆ operator==()

static bool GTA.PedGroup.operator== ( PedGroup  left,
PedGroup  right 
)
static

Determines if two PedGroups refer to the same group.

Parameters
leftThe left Checkpoint.
rightThe right Checkpoint.
Returns
true if left is the same group as right ; otherwise, false.

◆ Remove()

void GTA.PedGroup.Remove ( Ped  ped)

◆ ToArray()

Ped [] GTA.PedGroup.ToArray ( bool  includingLeader = true)

◆ ToList()

List<Ped> GTA.PedGroup.ToList ( bool  includingLeader = true)

Property Documentation

◆ Formation

Formation GTA.PedGroup.Formation
set

◆ Leader

Ped? GTA.PedGroup.Leader
get

◆ MemberCount

int GTA.PedGroup.MemberCount
get

◆ SeparationRange

float GTA.PedGroup.SeparationRange
set

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