Table of Contents

Class PlayerGangZone

Namespace
SampSharp.Entities.SAMP
Assembly
SampSharp.OpenMp.Entities.dll

Represents a gang zone that is logically owned by a single player. Created via CreatePlayerGangZone(Player, Vector2, Vector2, EntityId), which binds the gang zone's legacy ID to the owning player.

public class PlayerGangZone : BaseGangZone
Inheritance
PlayerGangZone
Inherited Members

Remarks

open.mp does not have a dedicated per-player gang zone creation API; under the hood this is a regular gang zone with SetLegacyPlayer set to the owner.

Constructors

PlayerGangZone(IOmpEntityProvider, IGangZonesComponent, IGangZone, Player)

Initializes a new instance of the PlayerGangZone class.

protected PlayerGangZone(IOmpEntityProvider entityProvider, IGangZonesComponent gangZones, IGangZone gangZone, Player player)

Parameters

entityProvider IOmpEntityProvider
gangZones IGangZonesComponent
gangZone IGangZone
player Player

Methods

Flash(Color)

Flashes this gang zone for the player.

public virtual void Flash(Color color)

Parameters

color Color

The Color to flash.

GetFlashingColor()

Gets the flashing color for this gang zone as seen by the player.

public virtual Color GetFlashingColor()

Returns

Color

The flashing color.

Hide()

Hides this gang zone for the player.

public virtual void Hide()

IsFlashing()

Checks whether this gang zone is currently flashing for the player.

public virtual bool IsFlashing()

Returns

bool

true if flashing; otherwise false.

IsPlayerInside()

Checks whether the player is inside this gang zone.

public virtual bool IsPlayerInside()

Returns

bool

true if the player is inside; otherwise false.

Remarks

Requires that this gang zone has been registered for enter/leave checking via UseGangZoneCheck(BaseGangZone, bool), otherwise the result is always false.

IsShown()

Checks whether this gang zone is currently shown for the player.

public virtual bool IsShown()

Returns

bool

true if shown; otherwise false.

Show()

Shows this gang zone to the player.

public virtual void Show()

StopFlash()

Stops this gang zone from flashing for the player.

public virtual void StopFlash()