Interface Tab

Public shape added by TabMixin.

interface Tab {
    accrueToTab(patronKey: string, amount: Money): void;
    canRunTab(patron: Stuff, recognizer: Stuff): boolean;
    clearTab(patronKey: string): Money;
    getTabBalance(patronKey: string): Money;
    grantTab(patronKey: string): void;
    isTabRevoked(patronKey: string): boolean;
    skipTab(patron: Stuff, creditor: Stuff): void;
}

Index

Methods

accrueToTab canRunTab clearTab getTabBalance grantTab isTabRevoked skipTab

Methods

accrueToTab

accrueToTab(patronKey: string, amount: Money): void
Accrue a charge to the patron's tab (the house extends credit).
Parameters
- patronKey: string
- amount: Money
Returns void
- Defined in packages/server/src/mud/lib/banking/Tab.ts:39

canRunTab

canRunTab(patron: Stuff, recognizer: Stuff): boolean
Whether patron may run a tab here — recognized by recognizer, not revoked.
Parameters
- patron: Stuff
- recognizer: Stuff
Returns boolean
- Defined in packages/server/src/mud/lib/banking/Tab.ts:37

clearTab

clearTab(patronKey: string): Money
Zero the patron's tab (after it settles via pay). Returns what was owed.
Parameters
- patronKey: string
Returns Money
- Defined in packages/server/src/mud/lib/banking/Tab.ts:41

getTabBalance

getTabBalance(patronKey: string): Money
The patron's accrued, unsettled tab balance.
Parameters
- patronKey: string
Returns Money
- Defined in packages/server/src/mud/lib/banking/Tab.ts:35

grantTab

grantTab(patronKey: string): void
Restore a patron's tab privilege (re-extend credit).
Parameters
- patronKey: string
Returns void
- Defined in packages/server/src/mud/lib/banking/Tab.ts:45

isTabRevoked

isTabRevoked(patronKey: string): boolean
Whether the patron's tab privilege has been revoked (for skipping).
Parameters
- patronKey: string
Returns boolean
- Defined in packages/server/src/mud/lib/banking/Tab.ts:43

skipTab

skipTab(patron: Stuff, creditor: Stuff): void
Price a skipped tab: a RegardApi regard hit from creditor toward the patron + revoke the privilege. The unpaid balance stays on the books.
Parameters
- patron: Stuff
- creditor: Stuff
Returns void
- Defined in packages/server/src/mud/lib/banking/Tab.ts:50