Interface IRequestResultHandler

Namespace

Uncreated.Warfare.Interaction.Requests

Assembly

Uncreated.Warfare.dll

Used to handle various results from a request.

public interface IRequestResultHandler

Properties

CanUseIMGUI

If translations for methods taking a string can use IMGUI for translations.

bool CanUseIMGUI { get; }

Property Value

bool

Methods

MissingCreditsOwnership(WarfarePlayer, IRequestable<object>, double)

Called when the player has to purchase the requestable object with /buy but hasn't yet.

void MissingCreditsOwnership(WarfarePlayer player, IRequestable<object> value, double creditCost)

Parameters

player WarfarePlayer

value IRequestable<object>

creditCost double

The total amount of credits required to purchase the object.

MissingDonorOwnership(WarfarePlayer, IRequestable<object>, decimal)

Called when the player has to purchase the requestable object with a donation.

void MissingDonorOwnership(WarfarePlayer player, IRequestable<object> value, decimal usdCost)

Parameters

player WarfarePlayer

value IRequestable<object>

usdCost decimal

The total amount of USD required to purchase the object.

MissingExclusiveOwnership(WarfarePlayer, IRequestable<object>)

Called when the player doesn't have access to an object.

void MissingExclusiveOwnership(WarfarePlayer player, IRequestable<object> value)

Parameters

player WarfarePlayer

value IRequestable<object>

MissingRequirement(WarfarePlayer, IRequestable<object>, string)

Called when a generic requirement isn't met for this requestable object.

void MissingRequirement(WarfarePlayer player, IRequestable<object> value, string localizedRequirement)

Parameters

player WarfarePlayer

value IRequestable<object>

localizedRequirement string

Exceptions

GameThreadException

MissingUnlockCost(WarfarePlayer, IRequestable<object>, UnlockCost)

Called when the player doesn't meet an unlock cost.

void MissingUnlockCost(WarfarePlayer player, IRequestable<object> value, UnlockCost unlockCost)

Parameters

player WarfarePlayer

value IRequestable<object>

unlockCost UnlockCost

MissingUnlockRequirement(WarfarePlayer, IRequestable<object>, UnlockRequirement)

Called when the player doesn't meet an unlock cost.

void MissingUnlockRequirement(WarfarePlayer player, IRequestable<object> value, UnlockRequirement unlockRequirement)

Parameters

player WarfarePlayer

value IRequestable<object>

unlockRequirement UnlockRequirement

NotFoundOrRegistered(WarfarePlayer)

Called when the requestable object isn't registered or can't be found, etc.

void NotFoundOrRegistered(WarfarePlayer player)

Parameters

player WarfarePlayer

Exceptions

GameThreadException

Success(WarfarePlayer, IRequestable<object>)

Called when a generic requirement isn't met for this requestable object.

void Success(WarfarePlayer player, IRequestable<object> value)

Parameters

player WarfarePlayer

value IRequestable<object>

Exceptions

GameThreadException

VehicleDelayed(WarfarePlayer, IRequestable<object>, TimeSpan)

Called when the player tries to request a vehicle that's currently delayed.

void VehicleDelayed(WarfarePlayer player, IRequestable<object> value, TimeSpan timeLeft)

Parameters

player WarfarePlayer

value IRequestable<object>

timeLeft TimeSpan