Class RentForProperty

Inheritance
System.Object
RentForProperty
Namespace: Eco.Gameplay.Property
Assembly: Eco.Gameplay.dll
Syntax
public class RentForProperty : Object, IRecurringTransferService, INotifyPropertyChanged, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, IHasClientControlledContainers, IController, IViewController, IHasUniversalID, IProvidesContext, ICustomValidity, IValidity

Constructors

RentForProperty()

Declaration
public RentForProperty()

Properties

AutoCreateAndUpdateTransferProps

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

ContextProvided

Declaration
public IEnumerable<IContextValue> ContextProvided { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IContextValue>

ControllerID

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

Customers

Declaration
public IEnumerable<User> Customers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<User>

Description

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

IncomeOrExpense

Declaration
public IncomeOrExpense IncomeOrExpense { get; }
Property Value
Type Description
IncomeOrExpense

MarkedUpName

Declaration
public LocString MarkedUpName { get; }
Property Value
Type Description
LocString

MoveInCompactDescription

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

MoveInFee

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

MoveInFeeCurrency

Declaration
public GameValue<Currency> MoveInFeeCurrency { get; set; }
Property Value
Type Description
GameValue<Currency>

PayAction

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

ReceivedRentAccount

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

RecurringTransferDefinition

Declaration
public RecurringTransferDefinition RecurringTransferDefinition { get; }
Property Value
Type Description
RecurringTransferDefinition

RecurringTransferExcludedDeed

Declaration
public Deed RecurringTransferExcludedDeed { get; }
Property Value
Type Description
Deed

RecurringTransfers

Declaration
public IList<RecurringTransfer> RecurringTransfers { get; }
Property Value
Type Description
System.Collections.Generic.IList<RecurringTransfer>

RecurringTransfersActive

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

Rent

Declaration
public RecurringTransferDefinition Rent { get; set; }
Property Value
Type Description
RecurringTransferDefinition

RentCompactDescription

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

Subscriptions

Declaration
public ref ThreadSafeSubscriptions Subscriptions { get; }
Property Value
Type Description
ThreadSafeSubscriptions

TransferServiceAccount

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

TransfersLock

Declaration
public object TransfersLock { get; }
Property Value
Type Description
System.Object

TransferType

Declaration
public TransferType TransferType { get; }
Property Value
Type Description
TransferType

Methods

Destroy()

Declaration
public void Destroy()

EditRent(Player)

Declaration
public void EditRent(Player player)
Parameters
Type Name Description
Player player

HasCustomer(User)

Declaration
public bool HasCustomer(User member)
Parameters
Type Name Description
User member
Returns
Type Description
System.Boolean

Initialize(Deed, Func<LocString>, Func<IAlias>, ControllerHashSet<User>, Action<GameActionPack, User>, Func<Settlement>)

Declaration
public void Initialize(Deed deed, Func<LocString> getMarkedUpName, Func<IAlias> owners, ControllerHashSet<User> rentersHashSet, Action<GameActionPack, User> evict, Func<Settlement> getSettlement)
Parameters
Type Name Description
Deed deed
System.Func<LocString> getMarkedUpName
System.Func<IAlias> owners
ControllerHashSet<User> rentersHashSet
System.Action<GameActionPack, User> evict
System.Func<Settlement> getSettlement

OnTransferFailed(RecurringTransfer, LocString)

Declaration
public void OnTransferFailed(RecurringTransfer transfer, LocString result)
Parameters
Type Name Description
RecurringTransfer transfer
LocString result

SetupMoveInFee(GameActionPack, User, Deed, RentForProperty.FeeInfo)

Declaration
public LocString SetupMoveInFee(GameActionPack pack, User user, Deed deed, RentForProperty.FeeInfo feeInfo)
Parameters
Type Name Description
GameActionPack pack
User user
Deed deed
RentForProperty.FeeInfo feeInfo
Returns
Type Description
LocString

TransferTitle(User)

Declaration
public LocString TransferTitle(User user)
Parameters
Type Name Description
User user
Returns
Type Description
LocString

Valid()

Declaration
public Result Valid()
Returns
Type Description
Result

ValidateAndGetFeeInfo(User)

Declaration
public Task<Nullable<RentForProperty.FeeInfo>> ValidateAndGetFeeInfo(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Threading.Tasks.Task<System.Nullable<RentForProperty.FeeInfo>>

Events

PropertyChanged

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

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods