Class RecurringTransfer

Inheritance
System.Object
RecurringTransfer
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Eco.Gameplay.Economy.Jobs
Assembly: Eco.Gameplay.dll
Syntax
public class RecurringTransfer : Object, IController, IViewController, IHasUniversalID, INotifyPropertyChanged

Constructors

RecurringTransfer()

Declaration
public RecurringTransfer()

Fields

PayEveryTick

Declaration
public static bool PayEveryTick
Field Value
Type Description
System.Boolean

ValuesUpdatedEvent

Declaration
public static ThreadSafeAction<RecurringTransfer> ValuesUpdatedEvent
Field Value
Type Description
ThreadSafeAction<RecurringTransfer>

Properties

Active

Declaration
public bool Active { get; set; }
Property Value
Type Description
System.Boolean

AmountPerHour

Declaration
public GameValue<float> AmountPerHour { get; set; }
Property Value
Type Description
GameValue<System.Single>

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

Currency

Declaration
public Currency Currency { get; set; }
Property Value
Type Description
Currency

Customer

Declaration
public User Customer { get; set; }
Property Value
Type Description
User

Description

Declaration
public string Description { get; }
Property Value
Type Description
System.String

IsInitialized

Declaration
public bool IsInitialized { get; }
Property Value
Type Description
System.Boolean

MoneyDesc

Declaration
public string MoneyDesc { get; }
Property Value
Type Description
System.String

ParentService

Declaration
public IRecurringTransferService ParentService { get; }
Property Value
Type Description
IRecurringTransferService

PayAction

Declaration
public RecurringPayment PayAction { get; set; }
Property Value
Type Description
RecurringPayment

PaymentType

Declaration
public WageType PaymentType { get; set; }
Property Value
Type Description
WageType

ServiceAccount

Declaration
public BankAccount ServiceAccount { get; set; }
Property Value
Type Description
BankAccount

ServiceMarkedUpName

Declaration
public string ServiceMarkedUpName { get; }
Property Value
Type Description
System.String

SourceAccount

Declaration
public BankAccount SourceAccount { get; }
Property Value
Type Description
BankAccount

TargetAccount

Declaration
public BankAccount TargetAccount { get; }
Property Value
Type Description
BankAccount

TimeLastAttempt

Declaration
public double TimeLastAttempt { get; set; }
Property Value
Type Description
System.Double

TimeLastPaid

Declaration
public double TimeLastPaid { get; set; }
Property Value
Type Description
System.Double

Title

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

UserAccount

Declaration
public BankAccount UserAccount { get; set; }
Property Value
Type Description
BankAccount

Methods

Initialize(IRecurringTransferService)

Usually initialization is called when recurring transfer is created and its a moment when all data is setted. Some transfers are preserved over sessions and they have to be initializated only by setting service. It's a workaround for hotfix, should be refactored to have better archetecture.

Declaration
public void Initialize(IRecurringTransferService service)
Parameters
Type Name Description
IRecurringTransferService service

Initialize(IRecurringTransferService, User, BankAccount)

Declaration
public Result Initialize(IRecurringTransferService service, User user, BankAccount userBankAccount)
Parameters
Type Name Description
IRecurringTransferService service
User user
BankAccount userBankAccount
Returns
Type Description
Result

Pay()

Declaration
public void Pay()

SetActiveAndPayIfNeeded(Boolean)

Declaration
public void SetActiveAndPayIfNeeded(bool recurringTransfersActive)
Parameters
Type Name Description
System.Boolean recurringTransfersActive

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

TryPay(Boolean)

Declaration
public void TryPay(bool force = false)
Parameters
Type Name Description
System.Boolean force

UpdateValues(IRecurringTransferService, Boolean, Boolean)

Calculate the values desired for the transfer and update them. Don't notify update during init, but if they're changed later do notify.

Declaration
public Result UpdateValues(IRecurringTransferService service, bool notifyUpdate, bool allowCurrencyChanges)
Parameters
Type Name Description
IRecurringTransferService service
System.Boolean notifyUpdate
System.Boolean allowCurrencyChanges
Returns
Type Description
Result

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods