Interface Branded

interface Branded {
    getBrand(): BrandDescriptor | null;
    getBrandKey(): string;
    getCorpo(): CorpoDescriptor | null;
    setBrandKey(value: string): void;
}

Index

Methods

getBrand getBrandKey getCorpo setBrandKey

Methods

getBrand

getBrand(): BrandDescriptor | null
The marked brand's descriptor, or null when unbranded.

Returns BrandDescriptor | null
- Defined in packages/server/src/mud/lib/corpo/Branded.ts:46

getBrandKey

getBrandKey(): string
The durable brand key this product is marked with ('' if unbranded).

Returns string
- Defined in packages/server/src/mud/lib/corpo/Branded.ts:43

getCorpo

getCorpo(): CorpoDescriptor | null
The owning corpo's descriptor, or null when unbranded or when the brand is an independent (no corpo). The null is the legible absence.

Returns CorpoDescriptor | null
- Defined in packages/server/src/mud/lib/corpo/Branded.ts:51

setBrandKey

setBrandKey(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/server/src/mud/lib/corpo/Branded.ts:44