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

SystemObject
RageGroup

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

Syntax

public sealed class Group : IHandleable

Public NotInheritable Class Group
	Implements IHandleable

public ref class Group sealed : IHandleable

The Group type exposes the following members.

Constructors

	Name	Description
	Group	Initializes a new instance of the Group class.

Properties

	Name	Description
	Count	Gets the number of members in this group.
	DissolveDistance	Sets the distance, in meters, at which members will automatically be removed from the group.
	Formation
	Handle	Gets the handle of this instance. Used to identify the instance within its pool.
	Leader	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.
	Members	Gets the members of this group.

Methods

	Name	Description
	AddMember	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.
	Delete	Deletes this group.
	Equals(Group)	Indicates whether this instance equals the specified Group instance.
	Equals(IHandleable)	Indicates whether this instance equals the specified IHandleable instance.
	IsMember	Determines whether the specified Ped is a member of this group.
	IsValid	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.
	RemoveMember	Removes the specified Ped from this group. The Ped must be a member of this group.
	SetPedMemberVehicleSeatIndex	Sets the index of the vehicle seat the specified member will use when the group enters a vehicle.

Operators

	Name	Description
	Equality	Determines whether the the first Group instance represents the same Group as the second Group instance.
	(Group to Boolean)
	Inequality	Determines whether the the first Group instance represents a different Group than the second Group instance.