From 11818e3d572b9c781d05f123bef2738b4dc7751d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 28 Oct 2020 04:09:35 +0000 Subject: [PATCH] Merge docs for 'spawn point control to entity api' --- docs/scarpet/Full.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/scarpet/Full.md b/docs/scarpet/Full.md index 9b62756e..e7946c18 100644 --- a/docs/scarpet/Full.md +++ b/docs/scarpet/Full.md @@ -2794,7 +2794,12 @@ Returns mob's attack target or null if none or not applicable. ### `query(e, 'home')` -Returns creature's home position or null if none or not applicable. +Returns creature's home position (as per mob's AI, leash etc) or null if none or not applicable. + +### `query(e, 'spawn_point')` + +Returns position tuple, dimension, spawn angle, and whether spawn is forced, assuming the player has a spawn position. +Returns `false` if spawn position is not set, and `null` if `e` is not a player. ### `query(e, 'path')` @@ -3149,6 +3154,13 @@ it clears all effects. Sets AI to stay around the home position, within `distance` blocks from it. `distance` defaults to 16 blocks. `null` removes it. _May_ not work fully with mobs that have this AI built in, like Villagers. + +### `modify(e, 'spawn_point')`, `modify(e, 'spawn_point', null)`, `modify(e, 'spawn_point', pos, dimension?, angle?, forced?)` + +Changes player respawn position to given position, optional dimension (defaults to current player dimension), angle (defaults to +current player facing) and spawn forced/fixed (defaults to `false`). If `none` or nothing is passed, the respawn point +will be reset (as removed) instead. + ### `modify(e, 'gamemode', gamemode?), modify(e, 'gamemode', gamemode_id?)` Modifies gamemode of player to whatever string (case-insensitive) or number you put in.