Interface IBaseGangZone.IManagedInterface

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

Represents the managed interface implemented by its unmanaged counterpart.

public interface IBaseGangZone.IManagedInterface : IUnmanagedInterface

Inherited Members

IUnmanagedInterface.Handle

IUnmanagedInterface.HasValue

Methods

FlashForPlayer(IPlayer, ref Colour)

Starts flashing the gangzone for the specified player with the given colour.

void FlashForPlayer(IPlayer player, ref Colour colour)

Parameters

player IPlayer

The player to flash the gangzone for.

colour Colour

The colour to flash the gangzone with.

GetColourForPlayer(IPlayer)

Gets the colour of the gangzone for the specified player.

Colour GetColourForPlayer(IPlayer player)

Parameters

player IPlayer

The player to get the colour for.

Returns

Colour

The colour of the gangzone for the player.

GetFlashingColourForPlayer(IPlayer)

Gets the flashing colour of the gangzone for the specified player.

Colour GetFlashingColourForPlayer(IPlayer player)

Parameters

player IPlayer

The player to get the flashing colour for.

Returns

Colour

The flashing colour of the gangzone for the player.

GetLegacyPlayer()

Gets the legacy player associated with this gangzone, used for ID mapping in per-player gangzones.

IPlayer GetLegacyPlayer()

Returns

IPlayer

The associated legacy player, or null if not set.

GetPosition()

Gets the position of the gangzone.

GangZonePos GetPosition()

Returns

GangZonePos

A GangZonePos structure containing the minimum and maximum coordinates.

GetShownFor()

Gets a list of players the gangzone is shown for.

FlatPtrHashSet<IPlayer> GetShownFor()

Returns

FlatPtrHashSet<IPlayer>

A collection of players the gangzone is visible to.

HideForPlayer(IPlayer)

Hides the gangzone for the specified player.

void HideForPlayer(IPlayer player)

Parameters

player IPlayer

The player to hide the gangzone for.

IsFlashingForPlayer(IPlayer)

Checks if the gangzone is flashing for the specified player.

bool IsFlashingForPlayer(IPlayer player)

Parameters

player IPlayer

The player to check for.

Returns

bool

true if the gangzone is flashing for the player; otherwise, false.

IsPlayerInside(IPlayer)

Checks if the specified player is within the gangzone bounds.

bool IsPlayerInside(IPlayer player)

Parameters

player IPlayer

The player to check.

Returns

bool

true if the player is inside the gangzone; otherwise, false.

Remarks

This only works if the gangzone has been added to the checking list via IGangZonesComponent.UseGangZoneCheck.

IsShownForPlayer(IPlayer)

Checks if the gangzone is shown for the specified player.

bool IsShownForPlayer(IPlayer player)

Parameters

player IPlayer

The player to check for.

Returns

bool

true if the gangzone is shown for the player; otherwise, false.

SetLegacyPlayer(IPlayer)

Sets the legacy player for this gangzone, used for ID mapping in per-player gangzones.

void SetLegacyPlayer(IPlayer player)

Parameters

player IPlayer

The player to associate with this gangzone, or null.

SetPosition(ref GangZonePos)

Sets the position of the gangzone.

void SetPosition(ref GangZonePos position)

Parameters

position GangZonePos

A GangZonePos structure containing the minimum and maximum coordinates.

ShowForPlayer(IPlayer, ref Colour)

Shows the gangzone to the specified player with the given colour.

void ShowForPlayer(IPlayer player, ref Colour colour)

Parameters

player IPlayer

The player to show the gangzone to.

colour Colour

The colour to display the gangzone with.

StopFlashForPlayer(IPlayer)

Stops flashing the gangzone for the specified player.

void StopFlashForPlayer(IPlayer player)

Parameters

player IPlayer

The player to stop flashing the gangzone for.