From 4da992dd22581e69ae46d3d5242d8c4ae506c30b Mon Sep 17 00:00:00 2001 From: carseatheadrest <99158396+carseatheadrest@users.noreply.github.com> Date: Tue, 15 Feb 2022 18:04:36 -0500 Subject: [PATCH] Added missing EntityValue documentation (#1318) --- docs/scarpet/Full.md | 40 ++++++++++++++++++++++++++++++------ docs/scarpet/api/Entities.md | 40 ++++++++++++++++++++++++++++++------ 2 files changed, 68 insertions(+), 12 deletions(-) diff --git a/docs/scarpet/Full.md b/docs/scarpet/Full.md index 1df069c1..f9208788 100644 --- a/docs/scarpet/Full.md +++ b/docs/scarpet/Full.md @@ -3437,6 +3437,10 @@ List of entities riding the entity. Entity that `e` rides. +### `query(e, 'unmountable')` + +Boolean, true if the entity cannot be mounted. + ### `(deprecated) query(e, 'tags')` Deprecated by `query(e, 'scoreboard_tags')` @@ -3469,6 +3473,14 @@ Boolean, true if the entity is burning. Number of remaining ticks of being on fire. +### `query(e, 'is_freezing')` + +Boolean, true if the entity is freezing. + +### `query(e, 'frost')` + +Number of remaining ticks of being frozen. + ### `query(e, 'silent')` Boolean, true if the entity is silent. @@ -3485,6 +3497,10 @@ Boolean, true if the entity is invulnerable. Boolean, true if the entity is immune to fire. +### `query(e, 'immune_to_frost')` + +Boolean, true if the entity is immune to frost. + ### `query(e, 'dimension')` Name of the dimension the entity is in. @@ -3677,10 +3693,10 @@ Retrieves player hunger related information. For non-players, returns `null`. Gets the absorption of the player (yellow hearts, e.g. when having a golden apple.) -### `query(e,'xp')` -### `query(e,'xp_level')` -### `query(e,'xp_progress')` -### `query(e,'score')` +### `query(e, 'xp')` +### `query(e, 'xp_level')` +### `query(e, 'xp_progress')` +### `query(e, 'score')` Numbers related to player's xp. `xp` is the overall xp player has, `xp_level` is the levels seen in the hotbar, `xp_progress` is a float between 0 and 1 indicating the percentage of the xp bar filled, and `score` is the number displayed upon death @@ -3871,7 +3887,7 @@ Moves the entity by a vector from its current location. Sets the motion vector (where and how much entity is moving). -### `modify(e, 'motion_z', x), modify(e, 'motion_y', y), modify(e, 'motion_z', z)` +### `modify(e, 'motion_x', x), modify(e, 'motion_y', y), modify(e, 'motion_z', z)` Sets the corresponding component of the motion vector. @@ -3922,6 +3938,10 @@ Dismounts riding entity. Mounts the entity to the `other`. +### `modify(e, 'unmountable', boolean)` + +Denies or allows an entity to be mounted. + ### `modify(e, 'drop_passengers')` Shakes off all passengers. @@ -3957,6 +3977,10 @@ Applies status effect to the living entity. Takes several optional parameters, w `true` and `false`. If no duration is specified, or if it's null or 0, the effect is removed. If name is not specified, it clears all effects. +### `modify(e, 'health', float)` + +Modifies the health of an entity. + ### `modify(e, 'may_fly', boolean)` Allows or denies the player the ability to fly. If the player is flying and the ability is removed, the player will stop flying. @@ -4038,6 +4062,10 @@ Toggles invulnerability for the entity. Will set entity on fire for `ticks` ticks. Set to 0 to extinguish. +### `modify(e, 'frost', ticks)` + +Will give entity frost for `ticks` ticks. Set to 0 to unfreeze. + ### `modify(e, 'hunger', value)` ### `modify(e, 'saturation', value)` ### `modify(e, 'exhaustion', value)` @@ -4060,7 +4088,7 @@ maybe you will get a double, who knows. ### `modify(e, 'air', ticks)` -Modifies entity air +Modifies entity air. ### `modify(e, 'add_exhaustion', value)` diff --git a/docs/scarpet/api/Entities.md b/docs/scarpet/api/Entities.md index bd12373d..2b36d0a7 100644 --- a/docs/scarpet/api/Entities.md +++ b/docs/scarpet/api/Entities.md @@ -202,6 +202,10 @@ List of entities riding the entity. Entity that `e` rides. +### `query(e, 'unmountable')` + +Boolean, true if the entity cannot be mounted. + ### `(deprecated) query(e, 'tags')` Deprecated by `query(e, 'scoreboard_tags')` @@ -234,6 +238,14 @@ Boolean, true if the entity is burning. Number of remaining ticks of being on fire. +### `query(e, 'is_freezing')` + +Boolean, true if the entity is freezing. + +### `query(e, 'frost')` + +Number of remaining ticks of being frozen. + ### `query(e, 'silent')` Boolean, true if the entity is silent. @@ -250,6 +262,10 @@ Boolean, true if the entity is invulnerable. Boolean, true if the entity is immune to fire. +### `query(e, 'immune_to_frost')` + +Boolean, true if the entity is immune to frost. + ### `query(e, 'dimension')` Name of the dimension the entity is in. @@ -442,10 +458,10 @@ Retrieves player hunger related information. For non-players, returns `null`. Gets the absorption of the player (yellow hearts, e.g. when having a golden apple.) -### `query(e,'xp')` -### `query(e,'xp_level')` -### `query(e,'xp_progress')` -### `query(e,'score')` +### `query(e, 'xp')` +### `query(e, 'xp_level')` +### `query(e, 'xp_progress')` +### `query(e, 'score')` Numbers related to player's xp. `xp` is the overall xp player has, `xp_level` is the levels seen in the hotbar, `xp_progress` is a float between 0 and 1 indicating the percentage of the xp bar filled, and `score` is the number displayed upon death @@ -636,7 +652,7 @@ Moves the entity by a vector from its current location. Sets the motion vector (where and how much entity is moving). -### `modify(e, 'motion_z', x), modify(e, 'motion_y', y), modify(e, 'motion_z', z)` +### `modify(e, 'motion_x', x), modify(e, 'motion_y', y), modify(e, 'motion_z', z)` Sets the corresponding component of the motion vector. @@ -687,6 +703,10 @@ Dismounts riding entity. Mounts the entity to the `other`. +### `modify(e, 'unmountable', boolean)` + +Denies or allows an entity to be mounted. + ### `modify(e, 'drop_passengers')` Shakes off all passengers. @@ -722,6 +742,10 @@ Applies status effect to the living entity. Takes several optional parameters, w `true` and `false`. If no duration is specified, or if it's null or 0, the effect is removed. If name is not specified, it clears all effects. +### `modify(e, 'health', float)` + +Modifies the health of an entity. + ### `modify(e, 'may_fly', boolean)` Allows or denies the player the ability to fly. If the player is flying and the ability is removed, the player will stop flying. @@ -803,6 +827,10 @@ Toggles invulnerability for the entity. Will set entity on fire for `ticks` ticks. Set to 0 to extinguish. +### `modify(e, 'frost', ticks)` + +Will give entity frost for `ticks` ticks. Set to 0 to unfreeze. + ### `modify(e, 'hunger', value)` ### `modify(e, 'saturation', value)` ### `modify(e, 'exhaustion', value)` @@ -825,7 +853,7 @@ maybe you will get a double, who knows. ### `modify(e, 'air', ticks)` -Modifies entity air +Modifies entity air. ### `modify(e, 'add_exhaustion', value)`