Readonly
eventProtected
Readonly
islandProtected
Readonly
objectsReadonly
worldStatic
Readonly
cachedOptional
ignoreItem: defaultOptional
ignoreItem: defaultOptional
human: default<number>Optional
human: default<number>Optional
includeNpcs: booleanOptional
ignoreOptions: booleanGet the best item
Optional
options: Partial<IGetBestItemsOptions>Get the best items sorted by how good they are Usability/custom (ie the sorting for melee/start fire) > Action tier (+quality if there's an action tier on both items) > quality > durability
Optional
options: Partial<IGetBestItemsOptions>Used in cases where we break items down from their base form like in dismantling or burning items.
number That is distributed from the quality/value.
Quality of the base item.
A number that we likely will be passing to getQualityBasedOnSkill and can be based on a skill or some arbitrary value.
Gets the name of a container
Name of the container or undefined if it's ending up on the ground
Get the translation (either message or UI based) for the efficacy of a given recipe.
A traslantion for the efficacy or undefined if not enough skill
The player/human to check for.
The current quality bonus (via computeCraftQualityBonus).
The maximum quality bonus (via getMaxQualityBonus).
The item recipe to check.
Optional
ui: booleanIf set to true, output the translation as a UiTranslation instead of Message.
Optional
options: Partial<IGetItemOptions>Optional
options: Partial<IGetItemsOptions>Optional
options: Partial<IGetItemOptions>Optional
options: Partial<IGetItemOptions>Optional
options: Partial<IGetItemOptions>Optional
article: ArticleOptional
count: numberOptional
count: numberOptional
article: ArticleGets the item's quality and action level (how good it is at doing the action).
A number (possibly 0 if no quality or action level).
The ActionType you are trying to get the level for.
Optional
options: Partial<IGetItemsOptions>Optional
options: Partial<IGetItemsOptions>Optional
options: Partial<IGetItemsOptions>Optional
filterText: stringReturns ordered items for the containers Note: It may return the real containedItems array!
Optional
options: Partial<IGetItemOptions>Gets the tile the item/container is on
Tile or undefined
Optional
itemOrContainer: default | IContainerItem or container
Uses the old system to get the weight of an item type.
Optional
actionNotUsableMessage: defaultOptional
isRepairOrDisassembly: booleanOptional
includeNpcs: booleanOptional
ignoreOptions: booleanwhether the given containable is, or is contained within, the given container
whether the given containable is, or is contained within, a trade container
Optional
options: Partial<IGetItemOptions>Note: don't print items to the console because the console will hold the item indefinitely
Optional
loadChildReferences: booleanOptional
parentContainer: IContainerMoves an item into a container
Result that tells you what moved
Human causing the item movement
Item to move
Container to move the item to
Optional
options: IMoveItemOptionsItem move options
Moves items from one container into another container
Result that tells you what moved
Human causing the item movement
Source container
Destination container
Optional
options: IMoveItemOptionsItem move options
Moves items to a container. Note: All the items must be contained within the same container.
Result that tells you what moved
Human causing the item movement
Destination container
Optional
options: IMoveItemOptionsItem move options
Drop items in a 3x3 square around the location. This will ensure all items in the container are removed
Protected
registerProtected
removeOptional
container: IContainerOptional
options: IMoveItemOptionsOptional
skipOptional
skipStatic
clearStatic
generateStatic
getStatic
getStatic
getStatic
getStatic
getStatic
getOptional
article: ArticleOptional
count: numberStatic
getStatic
getStatic
getStatic
getUses the old system to get the weight of an item type.
Static
isStatic
isStatic
isStatic
isStatic
isStatic
isStatic
isStatic
weightGenerated using TypeDoc
Will break a container item on a tile, and remove it after (whether or not if it's a container)