Class PedGroup

Inheritance
Object
PoolObject
PedGroup
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class PedGroup : PoolObject, INativeValue, IDeletable, IExistable, IEnumerable<Ped>, IEnumerable, IDisposable

Constructors

| Improve this Doc View Source

PedGroup()

Declaration
public PedGroup()
| Improve this Doc View Source

PedGroup(Int32)

Declaration
public PedGroup(int handle)
Parameters
Type Name Description
Int32 handle

Properties

| Improve this Doc View Source

Formation

Declaration
public Formation Formation { set; }
Property Value
Type Description
Formation
| Improve this Doc View Source

Leader

Declaration
public Ped Leader { get; }
Property Value
Type Description
Ped
| Improve this Doc View Source

MemberCount

Declaration
public int MemberCount { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

SeparationRange

Declaration
public float SeparationRange { set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

Add(Ped, Boolean)

Declaration
public void Add(Ped ped, bool leader)
Parameters
Type Name Description
Ped ped
Boolean leader
| Improve this Doc View Source

Contains(Ped)

Declaration
public bool Contains(Ped ped)
Parameters
Type Name Description
Ped ped
Returns
Type Description
Boolean
| Improve this Doc View Source

Delete()

Removes this PedGroup.

Declaration
public override void Delete()
Overrides
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to check.
Returns
Type Description
Boolean

true if the obj is the same group as this PedGroup; otherwise, false.
Overrides
| Improve this Doc View Source

Exists()

Determines if this PedGroup exists.

Declaration
public override bool Exists()
Returns
Type Description
Boolean

true if this PedGroup exists; otherwise, false.
Overrides
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator<Ped> GetEnumerator()
Returns
Type Description
IEnumerator<Ped>
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

GetMember(Int32)

Declaration
public Ped GetMember(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
Ped
| Improve this Doc View Source

Remove(Ped)

Declaration
public void Remove(Ped ped)
Parameters
Type Name Description
Ped ped
| Improve this Doc View Source

ToArray(Boolean)

Declaration
public Ped[] ToArray(bool includingLeader = true)
Parameters
Type Name Description
Boolean includingLeader
Returns
Type Description
Ped[]
| Improve this Doc View Source

ToList(Boolean)

Declaration
public List<Ped> ToList(bool includingLeader = true)
Parameters
Type Name Description
Boolean includingLeader
Returns
Type Description
List<Ped>

Operators

| Improve this Doc View Source

Equality(PedGroup, PedGroup)

Determines if two PedGroups refer to the same group.

Declaration
public static bool operator ==(PedGroup left, PedGroup right)
Parameters
Type Name Description
PedGroup left

The left Checkpoint.
PedGroup right

The right Checkpoint.
Returns
Type Description
Boolean

true if left is the same group as right; otherwise, false.
| Improve this Doc View Source

Implicit(PedGroup to InputArgument)

Converts a PedGroup to a native input argument.

Declaration
public static implicit operator InputArgument(PedGroup value)
Parameters
Type Name Description
PedGroup value
Returns
Type Description
InputArgument
| Improve this Doc View Source

Inequality(PedGroup, PedGroup)

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

Declaration
public static bool operator !=(PedGroup left, PedGroup right)
Parameters
Type Name Description
PedGroup left

The left PedGroup.
PedGroup right

The right PedGroup.
Returns
Type Description
Boolean

true if left is not the same group as right; otherwise, false.

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
IEnumerator

Implements