Group Class

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Represents a group of Ped.

There can be up to 16 groups at any given time.

Empty groups are automatically deleted.

Inheritance Hierarchy


Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: (0.56.1131.11510)

public sealed class Group : IHandleable

The Group type exposes the following members.


Public methodGroup
Initializes a new instance of the Group class.

Public propertyCount
Gets the number of members in this group.
Public propertyDissolveDistance
Sets the distance, in meters, at which members will automatically be removed from the group.
Public propertyFormation
Public propertyHandle
Gets the handle of this instance. Used to identify the instance within its pool.
Public propertyLeader
Gets or sets the leader of this group. When setting, if the specified Ped is not a member of this group, it will become a member.
Public propertyMembers
Gets the members of this group.

Public methodAddMember

Adds the specified Ped to this group.

If this is the group's first member, it will become the leader. A group cannot be leaderless.

Public methodDelete
Deletes this group.
Public methodEquals(Group)
Indicates whether this instance equals the specified Group instance.
Public methodEquals(IHandleable)
Indicates whether this instance equals the specified IHandleable instance.
Public methodIsMember
Determines whether the specified Ped is a member of this group.
Public methodIsValid
Determines whether this instance still represents an existing entity within the game world. Calls to an invalid instance is illegal and will result in an exception.
Public methodRemoveMember
Removes the specified Ped from this group. The Ped must be a member of this group.
Public methodSetPedMemberVehicleSeatIndex
Sets the index of the vehicle seat the specified member will use when the group enters a vehicle.

Public operatorStatic memberEquality
Determines whether the the first Group instance represents the same Group as the second Group instance.
Public operatorStatic member(Group to Boolean)
Public operatorStatic memberInequality
Determines whether the the first Group instance represents a different Group than the second Group instance.
See Also