Interface Bulkable

Public shape contributed by BulkableMixin.

interface Bulkable {
    debitBulk(affordance: BulkAffordance, litres: number): void;
    getBulk(affordance?: BulkAffordance): BulkSlot;
    getBulkAmount(affordance: BulkAffordance): Quantity<"L">;
    getBulkAvailable(affordance: BulkAffordance): number;
    getBulkCapacity(affordance: BulkAffordance): Quantity<"L"> | null;
    getBulkMaterial(affordance: BulkAffordance): default | null;
    getBulkMaterialPath(affordance: BulkAffordance): string | null;
    getClosure(): ClosureLevel;
    hasInteriorBulk(): boolean;
    hasSurfaceBulk(): boolean;
    isBulkEmpty(affordance: BulkAffordance): boolean;
    setBulkAmount(affordance: BulkAffordance, amount: Quantity<"L">): void;
    setBulkMaterial(affordance: BulkAffordance, material: default | null): void;
    setClosure(level: ClosureLevel): void;
}

Index

Methods

debitBulk getBulk getBulkAmount getBulkAvailable getBulkCapacity getBulkMaterial getBulkMaterialPath getClosure hasInteriorBulk hasSurfaceBulk isBulkEmpty setBulkAmount setBulkMaterial setClosure

Methods

debitBulk

debitBulk(affordance: BulkAffordance, litres: number): void
Parameters
- affordance: BulkAffordance
- litres: number
Returns void
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:216

getBulk

getBulk(affordance?: BulkAffordance): BulkSlot
Resolve a bulk slot handle. With no argument, returns the single present slot and throws when the holder has both or neither (the caller must disambiguate via affordance). With an argument, returns that slot and throws when the holder lacks it.
Parameters
- Optionalaffordance: BulkAffordance
Returns BulkSlot
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:199

getBulkAmount

getBulkAmount(affordance: BulkAffordance): Quantity<"L">
Parameters
- affordance: BulkAffordance
Returns Quantity<"L">
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:205

getBulkAvailable

getBulkAvailable(affordance: BulkAffordance): number
Parameters
- affordance: BulkAffordance
Returns number
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:214

getBulkCapacity

getBulkCapacity(affordance: BulkAffordance): Quantity<"L"> | null
Parameters
- affordance: BulkAffordance
Returns Quantity<"L"> | null
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:207

getBulkMaterial

getBulkMaterial(affordance: BulkAffordance): default | null
Parameters
- affordance: BulkAffordance
Returns default | null
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:203

getBulkMaterialPath

getBulkMaterialPath(affordance: BulkAffordance): string | null
Parameters
- affordance: BulkAffordance
Returns string | null
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:202

getClosure

getClosure(): ClosureLevel
Returns ClosureLevel
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:218

hasInteriorBulk

hasInteriorBulk(): boolean
Returns boolean
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:191

hasSurfaceBulk

hasSurfaceBulk(): boolean
Returns boolean
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:192

isBulkEmpty

isBulkEmpty(affordance: BulkAffordance): boolean
Parameters
- affordance: BulkAffordance
Returns boolean
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:215

setBulkAmount

setBulkAmount(affordance: BulkAffordance, amount: Quantity<"L">): void
Parameters
- affordance: BulkAffordance
- amount: Quantity<"L">
Returns void
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:206

setBulkMaterial

setBulkMaterial(affordance: BulkAffordance, material: default | null): void
Parameters
- affordance: BulkAffordance
- material: default | null
Returns void
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:204

setClosure

setClosure(level: ClosureLevel): void
Parameters
- level: ClosureLevel
Returns void
- Defined in packages/server/src/mud/lib/bulk/Bulkable.ts:219

Interface Bulkable

Index

Methods

Methods

debitBulk

Parameters

Returns void

getBulk

Parameters

Returns BulkSlot

getBulkAmount

Parameters

Returns Quantity<"L">

getBulkAvailable

Parameters

Returns number

getBulkCapacity

Parameters

Returns Quantity<"L"> | null

getBulkMaterial

Parameters

Returns default | null

getBulkMaterialPath

Parameters

Returns string | null

getClosure

Returns ClosureLevel

hasInteriorBulk

Returns boolean

hasSurfaceBulk

Returns boolean

isBulkEmpty

Parameters

Returns boolean

setBulkAmount

Parameters

Returns void

setBulkMaterial

Parameters

Returns void

setClosure

Parameters

Returns void

Settings

On This Page