Merge docs for 'added item_list, item_tags to support item tags as well as options for entities to support entity type tags. fixes #382'
This commit is contained in:
1 parent
a0067d0d61
commit
f400c9c006
1 file changed
+25
-6
+25
-6
@@ -1757,7 +1757,8 @@ Here is the gist of the Minecraft related functions. Otherwise the CarpetScript
|
|||||||
## App structure
|
## App structure
|
||||||
|
|
||||||
The main delivery method for scarpet programs into the game is in the form of apps in `*.sc` files located in the world `scripts`
|
The main delivery method for scarpet programs into the game is in the form of apps in `*.sc` files located in the world `scripts`
|
||||||
folder. In singleplayer, you can also save apps in `.minecraft/config/carpet/scripts` for them to be available in any world.
|
folder, flat. In singleplayer, you can also save apps in `.minecraft/config/carpet/scripts` for them to be available in any world,
|
||||||
|
and here you can actually organize them in folders.
|
||||||
When loaded (via `/script load` command, etc.), the game will run the content of the app once, regardless of its scope
|
When loaded (via `/script load` command, etc.), the game will run the content of the app once, regardless of its scope
|
||||||
(more about the app scopes below), without executing of any functions, unless called directly, and with the exception of the
|
(more about the app scopes below), without executing of any functions, unless called directly, and with the exception of the
|
||||||
`__config()` function, if present, which will be executed once. Loading the app will also bind specific
|
`__config()` function, if present, which will be executed once. Loading the app will also bind specific
|
||||||
@@ -2919,7 +2920,9 @@ to the `regular` group.
|
|||||||
* `monster`, `creature`, `ambient`, `water_creature`, `water_ambient`, `misc` - another categorization of
|
* `monster`, `creature`, `ambient`, `water_creature`, `water_ambient`, `misc` - another categorization of
|
||||||
living entities based on their spawn group. Negative descriptor resolves to all living types that don't belong to that
|
living entities based on their spawn group. Negative descriptor resolves to all living types that don't belong to that
|
||||||
category.
|
category.
|
||||||
* Any of the following standard entity types (equivalent to selection from `/summon` vanilla command:
|
* All entity tags including those provided with datapacks. Built-in entity tags include: `skeletons`, `raiders`,
|
||||||
|
`beehive_inhabitors` (bee, duh), `arrows` and `impact_projectiles`.
|
||||||
|
* Any of the following standard entity types (equivalent to selection from `/summon` vanilla command:
|
||||||
`area_effect_cloud`, `armor_stand`, `arrow`, `bat`, `bee`, `blaze`, `boat`, `cat`, `cave_spider`, `chest_minecart`,
|
`area_effect_cloud`, `armor_stand`, `arrow`, `bat`, `bee`, `blaze`, `boat`, `cat`, `cave_spider`, `chest_minecart`,
|
||||||
`chicken`, `cod`, `command_block_minecart`, `cow`, `creeper`, `dolphin`, `donkey`, `dragon_fireball`, `drowned`,
|
`chicken`, `cod`, `command_block_minecart`, `cow`, `creeper`, `dolphin`, `donkey`, `dragon_fireball`, `drowned`,
|
||||||
`egg`, `elder_guardian`, `end_crystal`, `ender_dragon`, `ender_pearl`, `enderman`, `endermite`, `evoker`,
|
`egg`, `elder_guardian`, `end_crystal`, `ender_dragon`, `ender_pearl`, `enderman`, `endermite`, `evoker`,
|
||||||
@@ -3076,13 +3079,21 @@ List of entities riding the entity.
|
|||||||
|
|
||||||
Entity that `e` rides.
|
Entity that `e` rides.
|
||||||
|
|
||||||
### `query(e, 'tags')`
|
### `query(e, 'scoreboard_tags')`, `query(e, 'tags')`(deprecated)
|
||||||
|
|
||||||
List of entity's tags.
|
List of entity's scoreboard tags.
|
||||||
|
|
||||||
### `query(e, 'has_tag',tag)`
|
### `query(e, 'has_scoreboard_tag',tag)`, `query(e, 'has_tag',tag)`(deprecated)
|
||||||
|
|
||||||
Boolean, true if the entity is marked with `tag`.
|
Boolean, true if the entity is marked with a `tag` scoreboad tag.
|
||||||
|
|
||||||
|
### `query(e, 'entity_tags')`
|
||||||
|
|
||||||
|
List of entity tags assigned to the type this entity represents.
|
||||||
|
|
||||||
|
### `query(e, 'has_entity_tag', tag)`
|
||||||
|
|
||||||
|
Returns `true` if the entity matches that entity tag, `false` if it doesn't, and `null` if the tag is not valid.
|
||||||
|
|
||||||
### `query(e, 'is_burning')`
|
### `query(e, 'is_burning')`
|
||||||
|
|
||||||
@@ -3744,6 +3755,14 @@ an inventory, all API functions typically do nothing and return null.
|
|||||||
|
|
||||||
Most items returned are in the form of a triple of item name, count, and nbt or the extra data associated with an item.
|
Most items returned are in the form of a triple of item name, count, and nbt or the extra data associated with an item.
|
||||||
|
|
||||||
|
### item_list(tag?)
|
||||||
|
|
||||||
|
With no arguments, returns a list of all items in the game. With an item tag provided, list items matching the tag, or `null` if tag is not valid.
|
||||||
|
|
||||||
|
### item_tags(item, tag?)
|
||||||
|
|
||||||
|
Returns list of tags the item belongs to, or, if tag is provided, `true` if an item maches the tag, `false` if it doesn't and `null` if that's not a valid tag
|
||||||
|
|
||||||
### `stack_limit(item)`
|
### `stack_limit(item)`
|
||||||
|
|
||||||
Returns number indicating what is the stack limit for the item. Its typically 1 (non-stackable), 16 (like buckets),
|
Returns number indicating what is the stack limit for the item. Its typically 1 (non-stackable), 16 (like buckets),
|
||||||
|
|||||||
Reference in new issue
Block a user