Interface IDeployable

Namespace

Uncreated.Warfare.FOBs.Deployment

Assembly

Uncreated.Warfare.dll

public interface IDeployable : ITranslationArgument

Inherited Members

ITranslationArgument.Translate(ITranslationValueFormatter, in ValueFormatParameters)

Extension Methods

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, ICommandUser, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, LanguageInfo?, CultureInfo?, TimeZoneInfo?, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, WarfarePlayer, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, in LanguageSet, ArgumentFormat, bool, TranslationOptions)

TranslationExtensions.Translate(ITranslationArgument, ITranslationService, ArgumentFormat, bool, TranslationOptions)

Properties

IsSafeZone

If the zone is a safezone like the lobby or main base. This is used to caculate 'time deployed' stat.

bool IsSafeZone { get; }

Property Value

bool

SpawnPosition

The position the player will spawn.

Vector3 SpawnPosition { get; }

Property Value

Vector3

Yaw

The angle the player will spawn along the Y-axis.

float Yaw { get; }

Property Value

float

Methods

CheckDeployableFrom(WarfarePlayer, ChatService, DeploymentTranslations, in DeploySettings, IDeployable)

Initial check to see if a player can deploy from the location.

bool CheckDeployableFrom(WarfarePlayer player, ChatService chatService, DeploymentTranslations translations, in DeploySettings settings, IDeployable deployingTo)

Parameters

player WarfarePlayer

chatService ChatService

translations DeploymentTranslations

settings DeploySettings

deployingTo IDeployable

Returns

bool

CheckDeployableFromTick(WarfarePlayer, DeploymentTranslations, in DeploySettings, IDeployable)

Periodic checks over time to see if a player can deploy from this location. This also runs just before the teleport.

bool CheckDeployableFromTick(WarfarePlayer player, DeploymentTranslations translations, in DeploySettings settings, IDeployable deployingTo)

Parameters

player WarfarePlayer

translations DeploymentTranslations

settings DeploySettings

deployingTo IDeployable

Returns

bool

CheckDeployableTo(WarfarePlayer, ChatService, DeploymentTranslations, in DeploySettings)

Initial check to see if a player can deploy to the location.

bool CheckDeployableTo(WarfarePlayer player, ChatService chatService, DeploymentTranslations translations, in DeploySettings settings)

Parameters

player WarfarePlayer

chatService ChatService

translations DeploymentTranslations

settings DeploySettings

Returns

bool

CheckDeployableToTick(WarfarePlayer, ChatService, DeploymentTranslations, in DeploySettings)

Periodic checks over time to see if a player can deploy to the location. This also runs just before the teleport.

bool CheckDeployableToTick(WarfarePlayer player, ChatService chatService, DeploymentTranslations translations, in DeploySettings settings)

Parameters

player WarfarePlayer

chatService ChatService

translations DeploymentTranslations

settings DeploySettings

Returns

bool

GetDelay(WarfarePlayer)

Get the deployment delay in seconds.

TimeSpan GetDelay(WarfarePlayer player)

Parameters

player WarfarePlayer

Returns

TimeSpan

OnDeployFrom(WarfarePlayer, in DeploySettings)

Invoked after deployment from this location.

void OnDeployFrom(WarfarePlayer player, in DeploySettings settings)

Parameters

player WarfarePlayer

settings DeploySettings

OnDeployTo(WarfarePlayer, in DeploySettings)

Invoked after deployment to this location.

void OnDeployTo(WarfarePlayer player, in DeploySettings settings)

Parameters

player WarfarePlayer

settings DeploySettings