FutureProg types
PropertyLease
| Property | Return type | Help |
|---|---|---|
.autorenew |
Boolean |
Whether the lease is configured to auto-renew. |
.bondclaimed |
Number |
The amount of the bond that has been claimed. |
.bondpayment |
Number |
The bond paid for the lease. |
.bondreturned |
Boolean |
Whether the bond has been returned. |
.id |
Number |
The stable property-lease identity. |
.interval |
Text |
The human-readable recurring payment interval. |
.lastpayment |
MudDateTime |
The in-world time of the last lease payment. |
.leaseend |
MudDateTime |
The in-world lease end time. |
.leaseholderid |
Number |
The durable identity of the leaseholder, or zero if it no longer resolves. |
.leaseholdername |
Text |
The resolved leaseholder name, or empty text. |
.leaseholdertype |
Text |
The framework-item type of the leaseholder. |
.leaseorder |
PropertyLeaseOrder |
The lease order from which this lease was created. |
.leasestart |
MudDateTime |
The in-world lease start time. |
.name |
Text |
A generated description of this lease. |
.paymentbalance |
Number |
The outstanding lease payment balance. |
.priceperinterval |
Number |
The lease charge per recurring interval. |
.property |
Property |
The property governed by this lease. |
.tenantcount |
Number |
The number of declared tenants. |