Class GangZone

Namespace

SampSharp.Entities.SAMP

Assembly

SampSharp.OpenMp.Entities.dll

Represents a global gang zone visible to any subset of players via Show() / Show(Player). For zones that logically belong to a single player, use PlayerGangZone.

public class GangZone : BaseGangZone

Inheritance

object

Component

IdProvider

BaseGangZone

GangZone

Inherited Members

BaseGangZone.GetShownFor()

BaseGangZone.SetPosition(Vector2, Vector2)

BaseGangZone.OnDestroyComponent()

BaseGangZone.ToString()

BaseGangZone.IsOmpEntityDestroyed

BaseGangZone.Min

BaseGangZone.Max

BaseGangZone.MinX

BaseGangZone.MinY

BaseGangZone.MaxX

BaseGangZone.MaxY

BaseGangZone.Color

IdProvider.Id

Component.GetComponent<T>()

Component.AddComponent<T>(params object[])

Component.AddComponent<T>()

Component.AddComponent<T>(T)

Component.DestroyComponents<T>()

Component.DestroyEntity()

Component.Destroy()

Component.GetComponents<T>()

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren<T>()

Component.GetComponentInParent<T>()

Component.GetComponentsInParent<T>()

Component.OnInitializeComponent()

Component.Manager

Component.Parent

Component.Entity

Component.IsComponentAlive

Component.IsDestroying

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GangZone(IOmpEntityProvider, IGangZonesComponent, IGangZone)

Initializes a new instance of the GangZone class.

protected GangZone(IOmpEntityProvider entityProvider, IGangZonesComponent gangZones, IGangZone gangZone)

Parameters

entityProvider IOmpEntityProvider

gangZones IGangZonesComponent

gangZone IGangZone

Methods

Flash(Color)

Flashes this gang zone to all players.

public virtual void Flash(Color color)

Parameters

color Color

The Color to flash.

Flash(Player, Color)

Flashes this gang zone for the specified player.

public virtual void Flash(Player player, Color color)

Parameters

player Player

The Player to flash this gang zone to.

color Color

The Color to flash.

GetColorForPlayer(Player)

Gets the color with which this gang zone is shown for the specified player.

public virtual Color GetColorForPlayer(Player player)

Parameters

player Player

The player.

Returns

Color

The per-player gang zone color.

GetFlashingColorForPlayer(Player)

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

public virtual Color GetFlashingColorForPlayer(Player player)

Parameters

player Player

The player.

Returns

Color

The per-player flashing color.

Hide()

Hides this gang zone for all players.

public virtual void Hide()

Hide(Player)

Hides this gang zone for the specified player.

public virtual void Hide(Player player)

Parameters

player Player

The Player to hide this gang zone from.

IsFlashingForPlayer(Player)

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

public virtual bool IsFlashingForPlayer(Player player)

Parameters

player Player

The player.

Returns

bool

true if flashing; otherwise false.

IsPlayerInside(Player)

Checks whether the specified player is inside this gang zone.

public virtual bool IsPlayerInside(Player player)

Parameters

player Player

The player.

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.

IsShownForPlayer(Player)

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

public virtual bool IsShownForPlayer(Player player)

Parameters

player Player

The player.

Returns

bool

true if shown; otherwise false.

Show()

Shows this gang zone to all players.

public virtual void Show()

Show(Player)

Shows this gang zone to the specified player.

public virtual void Show(Player player)

Parameters

player Player

The Player to show this gang zone to.

Show(Player, Color)

Shows this gang zone to the specified player.

public virtual void Show(Player player, Color color)

Parameters

player Player

The Player to show this gang zone to.

color Color

The per-player gang zone color.

StopFlash()

Stops this gang zone from flashing for all players.

public virtual void StopFlash()

StopFlash(Player)

Stops this gang zone from flashing for the specified player.

public virtual void StopFlash(Player player)

Parameters

player Player

The Player to stop the gang zone flash for.