Class default

Hierarchy

default

Index

Constructors

Properties

itemBaseComponent itemComponentsCanBurn itemComponentsConsumed itemComponentsRequired

Methods

amountNeededForComponent getItemsForComponent isDiscovered process processAdjacent processBaseComponent processComponents processContainer requirementsMet setAdjacentContainers setRecipe

Constructors

constructor

new default(human: default<unknown, number, NPC | Player>, recipe?: IRecipe, trackItems?: boolean, cacheItems?: boolean, canUseItem?: ((item: default, isConsumed: boolean, forItemTypeOrGroup: ItemType | ItemTypeGroup) => boolean)): default
Parameters
- human: default<unknown, number, NPC | Player>
- Optional recipe: IRecipe
- Optional trackItems: boolean
- Optional cacheItems: boolean
- Optional canUseItem: ((item: default, isConsumed: boolean, forItemTypeOrGroup: ItemType | ItemTypeGroup) => boolean)
  - - (item: default, isConsumed: boolean, forItemTypeOrGroup: ItemType | ItemTypeGroup): boolean
    - Parameters
      
      item: default
      
      isConsumed: boolean
      
      forItemTypeOrGroup: ItemType | ItemTypeGroup
      
      Returns boolean
Returns default
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:37

Properties

itemBaseComponent

itemBaseComponent: undefined | default

itemComponentsCanBurn

itemComponentsCanBurn: boolean

itemComponentsConsumed

itemComponentsConsumed: default[]

itemComponentsRequired

itemComponentsRequired: default[]

Methods

amountNeededForComponent

amountNeededForComponent(componentIndex: number): number
Returns the amount of items needed for the component
Parameters
- componentIndex: number
Returns number
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:64

getItemsForComponent

getItemsForComponent(componentIndex: number): default[]
Returns the items that will be used by the component Only valid when trackItems is true
Parameters
- componentIndex: number
Returns default[]
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:72

isDiscovered

isDiscovered(): boolean
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:84

process

process(): boolean
Looks inside the humans inventory and around adjacent opened doodads

Returns
true if the recipe's requirements are satisfied

Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:112

processAdjacent

processAdjacent(): boolean
Looks around adjacent containers

Returns
true if the recipe's requirements are satisfied

Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:183

processBaseComponent

processBaseComponent(item: default): boolean
Parameters
- item: default
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:228

processComponents

processComponents(item: default, disableExtraChecks?: boolean): boolean
Parameters
- item: default
- disableExtraChecks: boolean = false
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:240

processContainer

processContainer(container: IUncastableContainer): boolean
Looks inside the container and its subcontainers.

Returns
true if the recipe's requirements are satisfied by items in the container.
Parameters
- container: IUncastableContainer
  
  The container
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:199

requirementsMet

requirementsMet(): boolean
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:76

setAdjacentContainers

setAdjacentContainers(adjacentContainers: undefined | IContainer[]): void
Parameters
- adjacentContainers: undefined | IContainer[]
Returns void
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:80

setRecipe

setRecipe(recipe: undefined | IRecipe): boolean
Parameters
- recipe: undefined | IRecipe
Returns boolean
- Defined in src/game/game/item/ItemRecipeRequirementChecker.ts:134

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

human: default<unknown, number, NPC | Player>

Optional recipe: IRecipe

Optional trackItems: boolean

Optional cacheItems: boolean

Optional canUseItem: ((item: default, isConsumed: boolean, forItemTypeOrGroup: ItemType | ItemTypeGroup) => boolean)

Parameters

item: default

isConsumed: boolean

forItemTypeOrGroup: ItemType | ItemTypeGroup

Returns boolean

Returns default

Properties

itemBaseComponent

itemComponentsCanBurn

itemComponentsConsumed

itemComponentsRequired

Methods

amountNeededForComponent

Parameters

componentIndex: number

Returns number

getItemsForComponent

Parameters

componentIndex: number

Returns default[]

isDiscovered

Returns boolean

process

Returns

Returns boolean

processAdjacent

Returns

Returns boolean

processBaseComponent

Parameters

item: default

Returns boolean

processComponents

Parameters

item: default

disableExtraChecks: boolean = false

Returns boolean

processContainer

Returns

Parameters

container: IUncastableContainer

Returns boolean

requirementsMet

Returns boolean

setAdjacentContainers

Parameters

adjacentContainers: undefined | IContainer[]

Returns void

setRecipe

Parameters

recipe: undefined | IRecipe

Returns boolean

Settings

Member Visibility

Theme

`Optional` recipe: IRecipe

`Optional` trackItems: boolean

`Optional` cacheItems: boolean

`Optional` canUseItem: ((item: default, isConsumed: boolean, forItemTypeOrGroup: ItemType | ItemTypeGroup) => boolean)