added world_time and day_time. Add ability to store app data in shared space. as well as store in file hierarchies. Fixes #215
This commit is contained in:
gnembon committed
1 parent
3c25110b50
commit
8dbf269fde
8 files changed
+150
-51
No files matched your search
+37
-7
@@ -3007,23 +3007,52 @@ run('give @s stone 4') -> 1 // this operation was successful once
|
||||
Performs autosave, saves all chunks, player data, etc. Useful for programs where autosave is disabled due to
|
||||
performance reasons and saves the world only on demand.
|
||||
|
||||
### `load_app_data(), load_app_data(file)`
|
||||
### `load_app_data(), load_app_data(file), load_app_data(file, shared?)`
|
||||
|
||||
Loads the app data associated with the app from the world /scripts folder. Without argument returns the memory
|
||||
managed and buffered / throttled NBT tag. With a file name - reads explicitly a file with that name from the
|
||||
scripts folder.
|
||||
scripts folder that belongs exclusively to the app. if `shared` is true, the file location is not exclusive
|
||||
to the app anymore, but located in a shared app space.
|
||||
|
||||
File descriptor can contain letters, numbers and folder separator: `'/'`. Any other characters are stripped
|
||||
from the name before saving/loading. Empty descriptors are invalid.
|
||||
|
||||
Function returns nbt value with the file content, or `null` if the file is missing or there were problems
|
||||
with retrieving the data.
|
||||
|
||||
The default no-name app, via `/script run` command can only save/load file from the shared data location.
|
||||
|
||||
If the app's name is `'foo'`, the script location would
|
||||
be `world/scripts/foo.sc`, system-managed default app data storage is in `world/scripts/foo.data.nbt`, app
|
||||
specific data directory is under `world/scripts/foo.data/bar/../baz.nbt`, and shared data space is under
|
||||
`world/scripts/shared/bar/../baz.nbt`.
|
||||
|
||||
You can use app data to save non-vanilla information separately from the world and other scripts.
|
||||
|
||||
### `store_app_data(tag), store_app_data(tag, file)`
|
||||
### `store_app_data(tag), store_app_data(tag, file), store_app_data(tag, file, shared?)`
|
||||
|
||||
Stores the app data associated with the app from the world /scripts folder. With the `file` parameter saves
|
||||
immediately and with every call, without `file` parameter, it may take up to 10 seconds for the output file
|
||||
Stores the app data associated with the app from the world `/scripts` folder. With the `file` parameter saves
|
||||
immediately and with every call to a specific file defined by the `file`, either in app space, or in the scripts
|
||||
shared space if `shared` is true. Without `file` parameter, it may take up to 10
|
||||
seconds for the output file
|
||||
to sync preventing flickering in case this tag changes frequently. It will be synced when server closes.
|
||||
|
||||
Returns `true` if the file was saved successfully, `false` otherwise.
|
||||
|
||||
Uses the same file structure for exclusive app data, and shared data folder as `load_app_data`.
|
||||
|
||||
### `tick_time()`
|
||||
|
||||
Returns game tick counter. Can be used to run certain operations every n-th ticks, or to count in-game time
|
||||
Returns server tick counter. Can be used to run certain operations every n-th ticks, or to count in-game time.
|
||||
|
||||
### `world_time()`
|
||||
|
||||
Returns dimension-specific tick counter.
|
||||
|
||||
### `day_time(new_time?)`
|
||||
|
||||
Returns current daytime clock value. If `new_time` is specified, sets a new clock
|
||||
to that value. Daytime clocks are shared between all dimensions.
|
||||
|
||||
### `game_tick(mstime?)`
|
||||
|
||||
@@ -3074,7 +3103,8 @@ For the options of `entry`, consult your statistics page, or give it a guess.
|
||||
The call will return `null` if the statistics options are incorrect, or player didn't get these in their history.
|
||||
If the player encountered the statistic, or game created for him empty one, it will return a number.
|
||||
Scarpet will not affect the entries of the statistics, even if it is just creating empty ones. With `null` response
|
||||
it could either mean your input is wrong, or statistic has effectively a value of `0`.# `/script run` command
|
||||
it could either mean your input is wrong, or statistic has effectively a value of `0`.
|
||||
# `/script run` command
|
||||
|
||||
Primary way to input commands. The command executes in the context, position, and dimension of the executing player,
|
||||
commandblock, etc... The command receives 4 variables, `x`, `y`, `z` and `p` indicating position and
|
||||
|
||||
@@ -79,23 +79,52 @@ run('give @s stone 4') -> 1 // this operation was successful once
|
||||
Performs autosave, saves all chunks, player data, etc. Useful for programs where autosave is disabled due to
|
||||
performance reasons and saves the world only on demand.
|
||||
|
||||
### `load_app_data(), load_app_data(file)`
|
||||
### `load_app_data(), load_app_data(file), load_app_data(file, shared?)`
|
||||
|
||||
Loads the app data associated with the app from the world /scripts folder. Without argument returns the memory
|
||||
managed and buffered / throttled NBT tag. With a file name - reads explicitly a file with that name from the
|
||||
scripts folder.
|
||||
scripts folder that belongs exclusively to the app. if `shared` is true, the file location is not exclusive
|
||||
to the app anymore, but located in a shared app space.
|
||||
|
||||
File descriptor can contain letters, numbers and folder separator: `'/'`. Any other characters are stripped
|
||||
from the name before saving/loading. Empty descriptors are invalid.
|
||||
|
||||
Function returns nbt value with the file content, or `null` if the file is missing or there were problems
|
||||
with retrieving the data.
|
||||
|
||||
The default no-name app, via `/script run` command can only save/load file from the shared data location.
|
||||
|
||||
If the app's name is `'foo'`, the script location would
|
||||
be `world/scripts/foo.sc`, system-managed default app data storage is in `world/scripts/foo.data.nbt`, app
|
||||
specific data directory is under `world/scripts/foo.data/bar/../baz.nbt`, and shared data space is under
|
||||
`world/scripts/shared/bar/../baz.nbt`.
|
||||
|
||||
You can use app data to save non-vanilla information separately from the world and other scripts.
|
||||
|
||||
### `store_app_data(tag), store_app_data(tag, file)`
|
||||
### `store_app_data(tag), store_app_data(tag, file), store_app_data(tag, file, shared?)`
|
||||
|
||||
Stores the app data associated with the app from the world /scripts folder. With the `file` parameter saves
|
||||
immediately and with every call, without `file` parameter, it may take up to 10 seconds for the output file
|
||||
Stores the app data associated with the app from the world `/scripts` folder. With the `file` parameter saves
|
||||
immediately and with every call to a specific file defined by the `file`, either in app space, or in the scripts
|
||||
shared space if `shared` is true. Without `file` parameter, it may take up to 10
|
||||
seconds for the output file
|
||||
to sync preventing flickering in case this tag changes frequently. It will be synced when server closes.
|
||||
|
||||
Returns `true` if the file was saved successfully, `false` otherwise.
|
||||
|
||||
Uses the same file structure for exclusive app data, and shared data folder as `load_app_data`.
|
||||
|
||||
### `tick_time()`
|
||||
|
||||
Returns game tick counter. Can be used to run certain operations every n-th ticks, or to count in-game time
|
||||
Returns server tick counter. Can be used to run certain operations every n-th ticks, or to count in-game time.
|
||||
|
||||
### `world_time()`
|
||||
|
||||
Returns dimension-specific tick counter.
|
||||
|
||||
### `day_time(new_time?)`
|
||||
|
||||
Returns current daytime clock value. If `new_time` is specified, sets a new clock
|
||||
to that value. Daytime clocks are shared between all dimensions.
|
||||
|
||||
### `game_tick(mstime?)`
|
||||
|
||||
@@ -146,4 +175,4 @@ For the options of `entry`, consult your statistics page, or give it a guess.
|
||||
The call will return `null` if the statistics options are incorrect, or player didn't get these in their history.
|
||||
If the player encountered the statistic, or game created for him empty one, it will return a number.
|
||||
Scarpet will not affect the entries of the statistics, even if it is just creating empty ones. With `null` response
|
||||
it could either mean your input is wrong, or statistic has effectively a value of `0`.
|
||||
it could either mean your input is wrong, or statistic has effectively a value of `0`.
|
||||
@@ -13,6 +13,7 @@ brightness
|
||||
chunk_tickets
|
||||
create_marker
|
||||
current_dimension
|
||||
day_time
|
||||
destroy
|
||||
diamond
|
||||
drop_item
|
||||
@@ -95,4 +96,5 @@ top
|
||||
transparent
|
||||
update
|
||||
volume
|
||||
without_updates
|
||||
without_updates
|
||||
world_time
|
||||
@@ -67,7 +67,7 @@
|
||||
|
||||
logger sound particle particle_line particle_rect
|
||||
|
||||
run save tick_time game_tick seed current_dimension in_dimension
|
||||
run save tick_time world_time day_time game_tick seed current_dimension in_dimension
|
||||
|
||||
plop harvest destroy schedule nbt create_marker remove_all_markers load_app_data store_app_data escape_nbt statistic
|
||||
</Keywords>
|
||||
|
||||
Reference in new issue
Block a user