diff --git a/doc/en/3d-text.md b/doc/en/3d-text.md index be4a2757f..aa18de56a 100644 --- a/doc/en/3d-text.md +++ b/doc/en/3d-text.md @@ -2,7 +2,7 @@ 2D text displayed in 3D space. -The appearance of 3D text, is configured via a table, like [particles](particles.md). All fields are optional. +The appearance of 3D text is configured via a table, like [particles](particles.md). All fields are optional. | Field | Description | Default | | --------------- | ---------------------------------------- | ---------------- | diff --git a/doc/en/assets-preload.md b/doc/en/assets-preload.md index 3d2cd6f34..e40403298 100644 --- a/doc/en/assets-preload.md +++ b/doc/en/assets-preload.md @@ -1,6 +1,6 @@ # Assets preloading (*preload.json* file) -`preload.json` in content-pack folder is used for specifying additional assets should be loaded, like sounds. +`preload.json` in content-pack folder is used for specifying additional assets that should be loaded, like sounds. The file contains following categories available: - animation diff --git a/doc/en/audio.md b/doc/en/audio.md index 095104020..bbd82eae9 100644 --- a/doc/en/audio.md +++ b/doc/en/audio.md @@ -23,7 +23,7 @@ Channels are controlled by the engine and currently are not available in scripts ### Speaker -One-time use playing audio controller for sound or stream. Speaker is destroying after stop (**stop** method call or audio track end if not looped) +One-time use playing audio controller for sound or stream. Speaker is destroyed after stop (**stop** method call or audio track end if not looped) > [!NOTE] > Speaker access is performed using 64 bit integer identifiers that **will not be reused** after speaker destruction. You should avoid storing direct references and pointers instead of ID. @@ -40,7 +40,7 @@ Stream used by an audio stream as an audio data source. Implementation depends o ### Stream -Streaming audio. Not fully loading to the memory. Cannot be played via multiple speakers simultaneously. +Streaming audio. Not fully loaded into memory. Cannot be played via multiple speakers simultaneously. ## Formats support @@ -50,7 +50,7 @@ Streaming audio. Not fully loading to the memory. Cannot be played via multiple ## Additional information > [!WARNING] -> **Stereo** audio played with OpenAL will ignore 3D position relative to the listener. Sounds that supposed to be played at specific world position must be **mono** +> **Stereo** audio played with OpenAL will ignore 3D position relative to the listener. Sounds that are supposed to be played at specific world position must be **mono** ## Scripting Audio API @@ -98,7 +98,7 @@ Plays streaming audio from the specified file. Returns speaker ID. ```lua audio.play_sound( -- name of a loaded sound without pack prefix, "sounds/", variant number and extension - -- example: "steps/stone" to play sound loaded from "sounds/steps/stone.ogg" or any of its variant + -- example: "steps/stone" to play sound loaded from "sounds/steps/stone.ogg" or any of its variants -- variant will be randomly chosen name: string, -- audio source world position @@ -119,7 +119,7 @@ Plays the specified sound on the specified position in world. Returns speaker ID ```lua audio.play_sound_2d( -- name of a loaded sound without pack prefix, "sounds/", variant number and extension - -- example: "steps/stone" to play sound loaded from "sounds/steps/stone.ogg" or any of its variant + -- example: "steps/stone" to play sound loaded from "sounds/steps/stone.ogg" or any of its variants -- variant will be randomly chosen name: string, -- audio gain (0.0 - 1.0) @@ -153,34 +153,34 @@ audio.resume(speakerid: integer) -- set audio loop audio.set_loop(speakerid: integer, state: bool) --- check if audio is in loop (false if does not exists) +-- check if audio is in loop (false if does not exist) audio.is_loop(speakerid: integer) -> bool --- get audio gain value (0.0 if does not exists) +-- get audio gain value (0.0 if does not exist) audio.get_volume(speakerid: integer) -> number -- set audio gain value audio.set_volume(speakerid: integer, volume: number) --- get audio playback speed (1.0 if does not exists) +-- get audio playback speed (1.0 if does not exist) audio.get_pitch(speakerid: integer) -> number -- set audio playback speed audio.set_pitch(speakerid: integer, pitch: number) --- get current audio playback time in seconds (0.0 if does not exists) +-- get current audio playback time in seconds (0.0 if does not exist) audio.get_time(speakerid: integer) -> number -- set audio playback time position in seconds audio.set_time(speakerid: integer, time: number) --- get audio source world position (nil if does not exists) +-- get audio source world position (nil if does not exist) audio.get_position(speakerid: integer) -> number, number, number -- set audio source world position audio.set_position(speakerid: integer, x: number, y: number, z: number) --- get audio source movement speed in world (nil if does not exists) +-- get audio source movement speed in world (nil if does not exist) -- (OpenAL uses it for Doppler effect simulation) audio.get_velocity(speakerid: integer) -> number, number, number @@ -189,7 +189,7 @@ audio.get_velocity(speakerid: integer) -> number, number, number audio.set_velocity(speakerid: integer, x: number, y: number, z: number) -- get audio duration --- returns 0, if does not exists +-- returns 0, if does not exist -- also returns 0, if duration is unknown (example: radio) audio.get_duration(speakerid: integer) -> number ``` diff --git a/doc/en/block-models.md b/doc/en/block-models.md index 4f598cad7..28bc2f3f7 100644 --- a/doc/en/block-models.md +++ b/doc/en/block-models.md @@ -1,6 +1,6 @@ # Block Models (deprecated) -> ![WARNING] +> [!WARNING] > The `model-primitives` property is deprecated. Use the [VCM format](vcm.md) for a textual description of the model's primitives. Block model may be created with following properties: diff --git a/doc/en/block-properties.md b/doc/en/block-properties.md index 82ba10484..3bede279e 100644 --- a/doc/en/block-properties.md +++ b/doc/en/block-properties.md @@ -33,7 +33,7 @@ Block model type from list: - "block" - default block model - "none" - invisible block (air) - "X" - grass model (two crossed sprites) -- "aabb" - model based of block hitbox (complex hitbox will be combined into one). Examples: pipes, bulbs, panels. +- "aabb" - model based on block hitbox (complex hitbox will be combined into one). Examples: pipes, bulbs, panels. - "custom" - used when specifying custom models via *model-name* ### *model-name* @@ -187,7 +187,7 @@ Block is not a physical obstacle if **false** ### *hitbox* -An array of 6 numbers describing an offset an size of a block hitbox. +An array of 6 numbers describing an offset and size of a block hitbox. The numbers are specified in the range [0.0, 1.0] - i.e. within the block (in the case of an extended block, the hitbox can be larger than one, but must not go beyond the "size" property). @@ -210,7 +210,7 @@ For composite hitboxes, the *hitboxes* property is used - an array of hitboxes, ### *grounded* -Is block may only be set on a solid block and destructs on below block destruction. +Block may only be placed on a solid block and is destroyed when the block below is destroyed. ### *selectable* @@ -279,7 +279,7 @@ Block fields are declared in the following format: In addition to `type` and `length`, the `convert-strategy` parameter determines the value conversion strategy when narrowing the data type. The parameter takes one of two values: -- `reset` - a value that does not exists in the new range will be reset to 0 +- `reset` - a value that does not exist in the new range will be reset to 0 - `clamp` - the value will be reduced to the closest one in the new range Example: the number 231 when changing the field type from int16 to int8: @@ -362,7 +362,7 @@ Adds elements to the end of the list instead of completely overwriting it. ## Tags Tags allow you to designate general properties of blocks. Names should be formatted as `prefix:tag_name`. -The prefix is ​​optional, but helps avoid unwanted logical collisions. Example: +The prefix is optional, but helps avoid unwanted logical collisions. Example: ```json { diff --git a/doc/en/console.md b/doc/en/console.md index fff57c76f..0b196ca3c 100644 --- a/doc/en/console.md +++ b/doc/en/console.md @@ -56,7 +56,7 @@ Example: x:num~pos.x ``` -Variables may be specified as default values ​​using the `$` prefix: +Variables may be specified as default values using the `$` prefix: ```python t:int=$time @@ -110,7 +110,7 @@ console.add_command( ) ``` -- Checked values ​​of positional arguments are passed to **args**. -- A table of keyword argument values ​​is passed to **kwargs**. +- Checked values of positional arguments are passed to **args**. +- A table of keyword argument values is passed to **kwargs**. The command interpreter performs type checking and casting automatically. diff --git a/doc/en/content-packs.md b/doc/en/content-packs.md index 48ec57e6d..d4708ab94 100644 --- a/doc/en/content-packs.md +++ b/doc/en/content-packs.md @@ -1,7 +1,7 @@ # Content-packs Every content pack must have an ID following requirements: -- name can consist of Capital letters A-Z, lowercase letters a-z digits 0-9, and underscore '\_' signs. +- name can consist of Capital letters A-Z, lowercase letters a-z, digits 0-9, and underscore '\_' signs. - the first character must not be a digit. - name length must be in range \[2, 24\] @@ -31,7 +31,7 @@ If prefix is not specified, '!' level will be used. Example: '~randutil' - weak dependency 'randutil'. -Dependency version is indicated after '@' symbol and have operators to restrict acceptable versions. +Dependency version is indicated after '@' symbol and has operators to restrict acceptable versions. If version is not specified, '\*' (any) version will be used. Example: 'randutil@>=1.0' - dependency 'randutil' which requires version 1.0 or newer. diff --git a/doc/en/engine-use-recommendations.md b/doc/en/engine-use-recommendations.md index 93a9ea659..65df8aeb0 100644 --- a/doc/en/engine-use-recommendations.md +++ b/doc/en/engine-use-recommendations.md @@ -5,7 +5,7 @@ ### Content packs ID Content pack identifier requirements: -- name can consist of Capital letters A-Z, lowercase letters a-z digits 0-9, and underscore '\_' signs. +- name can consist of Capital letters A-Z, lowercase letters a-z, digits 0-9, and underscore '\_' signs. - the first character must not be a digit. - name length must be in range \[2, 24\] @@ -19,7 +19,7 @@ Content pack identifier requirements: ### Content packs data -State that supposed to be saved with a world, must be stored in `world:data/pack_id/`. The path should be retrieved by calling a function: +State that is supposed to be saved with a world, must be stored in `world:data/pack_id/`. The path should be retrieved by calling a function: ```lua local path = pack.data_file(PACK_ID, "file_name") diff --git a/doc/en/entity-properties.md b/doc/en/entity-properties.md index c2c852c35..f2d6638a3 100644 --- a/doc/en/entity-properties.md +++ b/doc/en/entity-properties.md @@ -20,7 +20,7 @@ Example: ] ``` -You can pass values ​​in ARGS from the entity configuration. +You can pass values in ARGS from the entity configuration. They will be passed both when creating a new entity and when loading a saved one. The `args` list is used for this: @@ -76,15 +76,15 @@ Applies to all uses of raycast without the include_non_selectable flag. A sensor is an area attached to a physical body that detects the entry of other bodies into it. -- When a body enter, the *on_sensor_enter* event is triggered. -- When a body exit, the *on_sensor_exit* event is called. +- When a body enters, the *on_sensor_enter* event is triggered. +- When a body exits, the *on_sensor_exit* event is called. Sensors are indexed in the same order as they are presented in the list, starting from 0. The following types (shapes) of sensors exist: -- *radius* is the simplest sensor. Defines the area around the center of the hitbox. The following values ​​are specified: +- *radius* is the simplest sensor. Defines the area around the center of the hitbox. The following values are specified: - radius - number. -- *aabb* - a rectangular area that changes position depending on the rotation of the entity. **The area itself does not rotate.** The following values ​​are specified: +- *aabb* - a rectangular area that changes position depending on the rotation of the entity. **The area itself does not rotate.** The following values are specified: - three numbers x, y, z of the minimal corner of the area. - three numbers x, y, z of the opposite corner of the area. @@ -138,7 +138,7 @@ In addition to custom components, the engine automatically saves data from the b There is a set of flags that allow you to specify which data will be saved and which will not. -(Boolean values ​​are specified) +(Boolean values are specified) | Title | Target | Default | | ---------------------- | ---------------------------------------------------- | ------- | diff --git a/doc/en/item-properties.md b/doc/en/item-properties.md index d3ae82e7d..44e8911cc 100644 --- a/doc/en/item-properties.md +++ b/doc/en/item-properties.md @@ -7,7 +7,7 @@ Icon type defines a source of an item image displayed in inventory. - **none** - invisible type, used for *core:empty* only (empty item, like the air block). May be removed in future updates. - **sprite** - default type. 2D image. Requires *icon* set to *atlas_name:texture_name*. Example: *blocks:notfound*. - There's two atlases available: + There are two atlases available: - **blocks** (generated from *png* files in *res/textures/blocks/*) - **items** (generated from *png* files in *res/textures/items/*) - **block** - block preview. Block ID must be specified in **icon** property. Example: *base:wood*. @@ -22,7 +22,7 @@ If the model is not specified, an automatic one will be generated. `caption` - name of item in inventory `description` - item description in inventory -this props allow to use `md` +These properties allow using `md` *see [Text Styles](/doc/en/text-styles.md)* @@ -32,7 +32,7 @@ this props allow to use `md` Specifies what block will be placed on RMB click. Automatically specified in generated items. -Example: an items that places bazalt blocks: +Example: an item that places bazalt blocks: ```json "placing-block": "base:bazalt" @@ -75,7 +75,7 @@ Allows you to reuse a single script for multiple items. ## Tags Tags allow you to designate general properties of items. Names should be formatted as `prefix:tag_name`. -The prefix is ​​optional, but helps avoid unwanted logical collisions. Example: +The prefix is optional, but helps avoid unwanted logical collisions. Example: ```json { diff --git a/doc/en/rigging.md b/doc/en/rigging.md index abb5ad81a..f242696f7 100644 --- a/doc/en/rigging.md +++ b/doc/en/rigging.md @@ -6,7 +6,7 @@ Entity skeletons are created via json files in the *skeletons* folder. > [!IMPORTANT] > -> The skeleton is a non-indexable content unit. When loading it, the pack prefix is ​​added to the name (example: *drop* in the base pack -> *base:drop*). +> The skeleton is a non-indexable content unit. When loading it, the pack prefix is added to the name (example: *drop* in the base pack -> *base:drop*). A skeletal element, or bone, consists of a transformation matrix defining its position, rotation and scale relative to the parent element (bone) or entity if the element is the root, a model and a list of sub-elements. diff --git a/doc/en/scripting/builtins/libapp.md b/doc/en/scripting/builtins/libapp.md index f3d46238f..2ed35f20f 100644 --- a/doc/en/scripting/builtins/libapp.md +++ b/doc/en/scripting/builtins/libapp.md @@ -7,7 +7,7 @@ The script/test name without the path and extension is available as `app.script` local filename = "script:"..app.script..".lua" ``` -Since the control script may not belong to any of the packs, it does not belongs to its own package and has its own global namespace in which all global functions and tables are available, as well as the `app` library. +Since the control script may not belong to any of the packs, it does not belong to any package and has its own global namespace in which all global functions and tables are available, as well as the `app` library. ## Common functions @@ -67,7 +67,7 @@ app.reconfig_packs( remove_packs: table ) --- To remove all packs from the configuration,you can use `pack.get_installed()`: +-- To remove all packs from the configuration, you can use `pack.get_installed()`: app.reconfig_packs({}, pack.get_installed()) -- In this case, `base` will also be removed from the configuration. diff --git a/doc/en/scripting/builtins/libblock.md b/doc/en/scripting/builtins/libblock.md index 4f0b02809..689ed4c9c 100644 --- a/doc/en/scripting/builtins/libblock.md +++ b/doc/en/scripting/builtins/libblock.md @@ -70,7 +70,7 @@ block.get_variant(x: int, y: int, z: int) -> int -- Sets the block variant by index block.set_variant(x: int, y: int, z: int, index: int) --- Checks if an block has specified tag +-- Checks if a block has specified tag block.has_tag(id: int, tag: str) -> bool ``` @@ -150,15 +150,15 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [optional] dest: tab Casts a ray from the start point in the direction of *dir*. Max_distance specifies the maximum ray length. -Argument `filter` can be used to tell ray what blocks can be skipped(passed through) during ray-casting. -To use filter `dest` argument must be filled with some value(can be nil), it's done for backwards compatibility +Argument `filter` can be used to tell ray what blocks can be skipped (passed through) during ray-casting. +To use filter `dest` argument must be filled with some value (can be nil), it's done for backwards compatibility The `include_non_selectable` argument determines whether blocks that cannot be selected by the cursor will be included. Example - `base:water` The function returns a table with the results or nil if the ray does not hit any block. -The result will use the destination table instead of creating a new one if the optional argument specified. +The result will use the destination table instead of creating a new one if the optional argument is specified. Use `world.raycast(...)` for more detailed configuration. diff --git a/doc/en/scripting/builtins/libbyteutil.md b/doc/en/scripting/builtins/libbyteutil.md index 0df21f026..af5d2d9e5 100644 --- a/doc/en/scripting/builtins/libbyteutil.md +++ b/doc/en/scripting/builtins/libbyteutil.md @@ -45,7 +45,7 @@ Value characters describe the type and size. byteutil.unpack(format: str, bytes: table|Bytearray) -> ... ``` -Extracts values ​​from a byte array based on a format string. +Extracts values from a byte array based on a format string. Example: diff --git a/doc/en/scripting/builtins/libfile.md b/doc/en/scripting/builtins/libfile.md index 8f4378b44..aa3f1781e 100644 --- a/doc/en/scripting/builtins/libfile.md +++ b/doc/en/scripting/builtins/libfile.md @@ -23,7 +23,7 @@ Read whole text file. file.read_bytes(path: str, [optional] usetable) -> array of integers ``` -Read file into bytes array. If usetable = false , returns Bytearray instead of table. +Read file into bytes array. If usetable = false, returns Bytearray instead of table. ```lua file.is_writeable(path: str) -> bool @@ -53,7 +53,7 @@ Get file length (bytes) or 0. file.exists(path: str) -> bool ``` -Check if file or directory exist. +Check if file or directory exists. ```python file.isfile(path: str) -> bool @@ -83,7 +83,7 @@ Create directories chain. Returns true if new directory created. file.list(path: str) -> array of strings ``` -Returns a list of files and directories in the specified. +Returns a list of files and directories in the specified directory. ```python file.list_all_res(path: str) -> array of strings @@ -151,7 +151,7 @@ file.name(path: str) --> str Extracts the file name from the path. Example: `world:data/base/config.toml` -> `config.toml`. -``lua +```lua file.stem(path: str) --> str ``` @@ -191,6 +191,6 @@ Removes the entry point (prefix) from the path. Example: `world:data/base/config file.join(directory: str, path: str) --> str ``` -Joins the path. Example: `file.join("world:data", "base/config.toml)` -> `world:data/base/config.toml`. +Joins the path. Example: `file.join("world:data", "base/config.toml")` -> `world:data/base/config.toml`. You should use this function instead of concatenating with `/`, since `prefix:/path` is not valid. diff --git a/doc/en/scripting/builtins/libhud.md b/doc/en/scripting/builtins/libhud.md index 550659ccc..1763ff1fb 100644 --- a/doc/en/scripting/builtins/libhud.md +++ b/doc/en/scripting/builtins/libhud.md @@ -8,7 +8,7 @@ hud.open_inventory() hud.close_inventory() -- Open UI and inventory. --- Throws an exception if has UI layout does not exists. +-- Throws an exception if the UI layout does not exist. -- If invid is not specified, a virtual (temporary) inventory is created. -- Returns the invid or id of the virtual inventory. hud.open( @@ -34,12 +34,12 @@ hud.open_block(x: int, y: int, z: int) -> int, str ``` > [!NOTE] -> Only one block may be open at same time +> Only one block may be open at the same time ```lua -- Show overlay with layout specified. -- Shows player inventory also if playerinv is true. --- Using `args` you can specify an array of parameter values ​​that will be passed +-- Using `args` you can specify an array of parameter values that will be passed -- to on_open of the overlay being shown. hud.show_overlay(layoutid: str, playerinv: bool, [optional] args: table) diff --git a/doc/en/scripting/builtins/libinput.md b/doc/en/scripting/builtins/libinput.md index 9cf754d33..f94c182f8 100644 --- a/doc/en/scripting/builtins/libinput.md +++ b/doc/en/scripting/builtins/libinput.md @@ -100,7 +100,7 @@ input.is_pressed(code: str) --> bool Checks input activity using a code consisting of: - input type: *key* or *mouse* -- input code: [key name](#key names) or mouse button name (left, middle, right) +- input code: [key name](../user-input.md#key-names) or mouse button name (left, middle, right) Example: ```lua diff --git a/doc/en/scripting/builtins/libinventory.md b/doc/en/scripting/builtins/libinventory.md index 63c25a3c9..634f779fb 100644 --- a/doc/en/scripting/builtins/libinventory.md +++ b/doc/en/scripting/builtins/libinventory.md @@ -50,7 +50,7 @@ inventory.has_data( inventory.size(invid: int) -> int -- Add an item to the specified inventory. --- Returns remaining count if could not to add fully. +-- Returns remaining count if it could not be added fully. inventory.add(invid: int, itemid: int, count: int) -> int -- Returns the index of the first matching slot in the given range. @@ -164,7 +164,7 @@ inventory.get_all_data( slot: int, ) -> table | nil --- Sets the values ​​of all local item properties. +-- Sets the values of all local item properties. inventory.set_all_data( -- inventory id invid: int, @@ -186,8 +186,8 @@ inventory.clone(invid: int) -> int -- Move an item from slotA of invA to slotB of invB. -- invA may be the same as invB. --- If slotB will be chosen automatically if argument is not specified. --- The move may be incomplete if the available slot has no enough stack space. +-- slotB will be chosen automatically if argument is not specified. +-- The move may be incomplete if the available slot does not have enough stack space. inventory.move(invA: int, slotA: int, invB: int, slotB: int) -- Moves an item from slotA of inventory invA to a suitable slot(s) diff --git a/doc/en/scripting/builtins/libmat4.md b/doc/en/scripting/builtins/libmat4.md index 0c4b437e9..679098c50 100644 --- a/doc/en/scripting/builtins/libmat4.md +++ b/doc/en/scripting/builtins/libmat4.md @@ -89,7 +89,7 @@ mat4.scale(m: matrix, scale: vec3, dst: matrix) The angle of rotation is indicated in degrees. ```lua --- creates a rotation matrix (angle - rotation angle) along a given axis (axis is an unit vector) +-- creates a rotation matrix (angle - rotation angle) along a given axis (axis is a unit vector) mat4.rotate(axis: vec3, angle: number) -- returns the result of applying rotation to matrix m mat4.rotate(m: matrix, axis: vec3, angle: number) diff --git a/doc/en/scripting/builtins/libpack.md b/doc/en/scripting/builtins/libpack.md index 651a030d2..2e49b4ded 100644 --- a/doc/en/scripting/builtins/libpack.md +++ b/doc/en/scripting/builtins/libpack.md @@ -74,7 +74,7 @@ Returns the ids of all content packs available but not installed in the world. pack.get_base_packs() -> strings array ``` -Returns the id of all base packages (non-removeable) +Returns the ids of all base packages (non-removable) ```lua pack.get_info(packid: str) -> { @@ -90,7 +90,7 @@ pack.get_info(packid: str) -> { ``` Returns information about the pack (not necessarily installed). -- icon - name of the preview texture (loading automatically) +- icon - name of the preview texture (loaded automatically) - dependencies - strings following format `{lvl}{id}`, where lvl: - `!` - required - `?` - optional @@ -98,7 +98,7 @@ Returns information about the pack (not necessarily installed). for example `!teal` -To obtain information about multiple packs, use table of ids to avoid re-scanning:one +To obtain information about multiple packs, use table of ids to avoid re-scanning: ```lua pack.get_info(packids: table) -> {id={...}, id2={...}, ...} diff --git a/doc/en/scripting/builtins/libquat.md b/doc/en/scripting/builtins/libquat.md index 5d72413e2..8845346d1 100644 --- a/doc/en/scripting/builtins/libquat.md +++ b/doc/en/scripting/builtins/libquat.md @@ -36,7 +36,7 @@ quat.mul_vec3(a: quat, b: vec3, [optional] dst: vec3) -> vec3 ## Spherical linear interpolation - *quat.slerp(...)* -The interpolation always take the short path and the rotation is performed at constant speed. +The interpolation always takes the short path and the rotation is performed at constant speed. ```lua -- creates a quaternion as an interpolation between a and b, diff --git a/doc/en/scripting/builtins/libworld.md b/doc/en/scripting/builtins/libworld.md index 72bfaf8e4..c69276330 100644 --- a/doc/en/scripting/builtins/libworld.md +++ b/doc/en/scripting/builtins/libworld.md @@ -4,11 +4,11 @@ -- Checks if world is open world.is_open() -> bool --- Returns worlds information. +-- Returns world information. world.get_list() -> tables array { -- world name name: str, - -- world icon/preview (loading automatically) + -- world icon/preview (loaded automatically) icon: str -- engine version the world was saved on version: {int, int} @@ -99,7 +99,7 @@ world.raycast( -- id of the block types used for filtering filter_blocks: table = nil, -- exclusion filtering mode: - -- if true, filter_blocks defines the list Ignored + -- if true, filter_blocks defines the list of ignored block types blocks_exclusion: bool = true, -- include blocks with selectable=false nonselect_blocks: bool = false; diff --git a/doc/en/scripting/ecs.md b/doc/en/scripting/ecs.md index 52396d554..73add6bda 100644 --- a/doc/en/scripting/ecs.md +++ b/doc/en/scripting/ecs.md @@ -32,7 +32,7 @@ entity:require_component(name: str) -> component -- Enables/disables the component entity:set_enabled(name: str, enable: bool) --- Returns id of player the entity is bound, otherwise -1 is returned. +-- Returns id of player the entity is bound to, otherwise -1 is returned. -- At components initialization -1 is also returned, -- since the binding occurs after initialization. entity:get_player() -> int or nil @@ -240,7 +240,7 @@ Called before component data is saved. Here you can write the data you want to s function on_update(tps: int) ``` -Called every entities tick (currently 20 times per second). +Called every entity tick (currently 20 times per second). ```lua function on_physics_update(delta: number) @@ -289,7 +289,7 @@ Called when an entity is attacked (LMB on the entity). The first argument is the function on_used(playerid: int) ``` -Called when an entity is used (RMB by entity). The player ID is passed as an argument. +Called when an entity is used (RMB on the entity). The player ID is passed as an argument. ```lua function on_player_set(playerid: int) diff --git a/doc/en/scripting/extensions.md b/doc/en/scripting/extensions.md index 9ba99f1ef..b9d468cb9 100644 --- a/doc/en/scripting/extensions.md +++ b/doc/en/scripting/extensions.md @@ -32,10 +32,10 @@ table.index(t: table, x: any) -> int -- Removes element x from t. table.remove_value(t: table, x: any) --- Shuffles values ​​in the table. +-- Shuffles values in the table. table.shuffle(t: table) -> table --- Adds values ​​from table t2 to table t1. If table t2 contains a key from t1, the key's value will not be changed. +-- Adds values from table t2 to table t1. If table t2 contains a key from t1, the key's value will not be changed. table.merge(t1: table, t2: table) -> table -- Iterates through the table and applies a func to all its elements, returning the new value of the element. @@ -180,7 +180,7 @@ math.sum(x: number, ... | t: table) -> number bit.compile(expr: string, args: table | nil, asFunction: boolean=true) -> function | string -- Compiles the function to perform bitwise operations and executes it in place --- * ...: Values ​​to be passed to the compiled function. bit.execute(expr: string, args: table | nil, ...) -> number +-- * ...: Values to be passed to the compiled function. bit.execute(expr: string, args: table | nil, ...) -> number ``` ## Additional Global Functions @@ -202,7 +202,7 @@ parse_path(path: string) -> string, string sleep(timesec: number) -- Waits for the passed coroutine to complete, returning the control flow. The function can only be used inside a coroutine. --- Returns values ​​similar to those returned by pcall. +-- Returns values similar to those returned by pcall. await(co: coroutine) -> result, error -- A constant storing the PID of the current engine instance. diff --git a/doc/en/scripting/filesystem.md b/doc/en/scripting/filesystem.md index 29da88194..c98e99c8f 100644 --- a/doc/en/scripting/filesystem.md +++ b/doc/en/scripting/filesystem.md @@ -58,7 +58,7 @@ The library contains functions for serializing and deserializing XML: Further, XML as a data type denotes a Lua table with the following structure: - Element tag is accessible by the key `#` -- XML ​​attributes are accessible as key = value pairs +- XML attributes are accessible as key = value pairs - Inner elements are accessible by index The table is used both as a dictionary and an array. diff --git a/doc/en/scripting/modules/core_bit_converter.md b/doc/en/scripting/modules/core_bit_converter.md index 822c13946..fb15f2542 100644 --- a/doc/en/scripting/modules/core_bit_converter.md +++ b/doc/en/scripting/modules/core_bit_converter.md @@ -1,6 +1,6 @@ # Module core:bit_converter -## Converting values ​​to bytes and back +## Converting values to bytes and back ```lua function bit_converter.string_to_bytes(string: str) -> table diff --git a/doc/en/scripting/ui.md b/doc/en/scripting/ui.md index 7a11b2f5e..fbad3b01c 100644 --- a/doc/en/scripting/ui.md +++ b/doc/en/scripting/ui.md @@ -11,8 +11,8 @@ local worldsPanel = document["worlds-panel"] print(worldsPanel.pos) ``` -The IDs of the elements are global for the document, that is, *worlds-panel* can be located either in the root element, -and in a nested container. +The IDs of the elements are global for the document, that is, *worlds-panel* can be located either in the root element +or in a nested container. The element id cannot be changed from a script. @@ -204,7 +204,7 @@ Here, *color* can be specified in the following ways: | data:unbind_texture() | unbinds the texture from the canvas | | data:mul(*color* or Canvas) | multiplies a color by the specified color or canvas | | data:add(*color* or Canvas) | adds a color or another canvas to a color | -| data:sub(*color* or Canvas) | subtracts a color or another canvas to a color | +| data:sub(*color* or Canvas) | subtracts a color or another canvas from a color | | data:encode(format: str) | encodes image to specified format and returns bytearray | To decode a byte array into a Canvas, use the static method: diff --git a/doc/en/vcm.md b/doc/en/vcm.md index b09c615a4..a632c1cad 100644 --- a/doc/en/vcm.md +++ b/doc/en/vcm.md @@ -20,7 +20,7 @@ Same structure in XML: Unlike XML, the root can contain multiple elements. -Currently, there are three types of primitives: `tri`, `box`, `rect` and `part` (describes a part of a primitive, such as the side of a cube). +Currently, there are three types of primitives: `tri`, `box` and `rect`, as well as `part` (describes a part of a primitive, such as the side of a cube). > [!NOTE] > By default, texture coordinates are determined by the dimensions of the primitives. diff --git a/doc/en/world-generator.md b/doc/en/world-generator.md index 6432cb421..04b59a08b 100644 --- a/doc/en/world-generator.md +++ b/doc/en/world-generator.md @@ -68,11 +68,11 @@ The following variables are available in the generator script: ## Fragments -A fragment is a region of the world, like a chunk, saved for later use, limited by a certain width, height and length. A fragment can contain data not only blocks, but also the block inventories and entities. Unlike a chunk, the size of a fragment is arbitrary. +A fragment is a region of the world, like a chunk, saved for later use, limited by a certain width, height and length. A fragment can contain not only block data, but also block inventories and entities. Unlike a chunk, the size of a fragment is arbitrary. Fragment can be created using the `fragment.save` command, or the `generation.create_fragment` function. -Fragments used by the generator must present in the directory: +Fragments used by the generator must be present in the directory: `generators/generator_name.files/fragments/` ## Structures @@ -130,7 +130,7 @@ structures = [ ``` - key 'forest' - biome name -- parameters - weights and central values ​​of the parameters for the biome. See the [biome selection](#biome-selection) section. The number of entries must match the number of biome selection parameters. +- parameters - weights and central values of the parameters for the biome. See the [biome selection](#biome-selection) section. The number of entries must match the number of biome selection parameters. - layers - block layers from top to bottom. - height - layer height in blocks. -1 is used to mark the filler layer, of which there can only be one. Its height is calculated automatically. - block - full block name @@ -189,11 +189,11 @@ Where $V$ is the parameter value, $V_b$ is the central parameter value for the b The generator selects the biome with the **least** sum of parameter scores. >[!WARNING] -> If the parameter values ​​and weights are not set up correctly, biomes may have an effect similar to the depth conflict in 3D graphics when two surfaces overlap. +> If the parameter values and weights are not set up correctly, biomes may have an effect similar to the depth conflict in 3D graphics when two surfaces overlap. > In the case of biomes, the pattern looks random due to the distortion of these 'surfaces' by the noise used to generate the parameter maps. > - To get rid of the effect, you can either adjust the weights or parameter values ​​of the biomes, or increase the difference in the generation of the parameter maps. + To get rid of the effect, you can either adjust the weights or parameter values of the biomes, or increase the difference in the generation of the parameter maps. ## Heightmap @@ -224,13 +224,13 @@ map:ceil() -- Round to the nearest integer map:round() --- Sine of height values ​​(in radians) +-- Sine of height values (in radians) map:sin() --- Cosine of height values ​​(in radians) +-- Cosine of height values (in radians) map:cos() --- Tangent of height values ​​(in radians) +-- Tangent of height values (in radians) map:tan() ``` @@ -272,7 +272,7 @@ map:mixin(value: Heightmap|number, t: Heightmap|number) ### heightmap:dump(...) -A method used for debugging, creates an image based on a heightmap by converting values ​​from the range `[-1.0, 1.0]` to brightness values ​​`[0, 255]`, saving it to the specified file. +A method used for debugging, creates an image based on a heightmap by converting values from the range `[-1.0, 1.0]` to brightness values `[0, 255]`, saving it to the specified file. ```lua map:dump('export:test.png') @@ -541,5 +541,5 @@ fragment_name = {} {"struct": "fragment_name", "rarity": rarity} ] ``` -The higher the rarity value, the less ore generation chance. +The higher the rarity value, the lower the ore generation chance. You can rely on the rarity of coal ore: 4400. diff --git a/doc/en/xml-ui-layouts.md b/doc/en/xml-ui-layouts.md index 8d04ff4ec..5a3b03bb5 100644 --- a/doc/en/xml-ui-layouts.md +++ b/doc/en/xml-ui-layouts.md @@ -58,7 +58,7 @@ Examples: # Template attributes -- `if` with values ​​('', 'false', 'nil') the element will be ignored, including sub-elements. +- `if` with values ('', 'false', 'nil') the element will be ignored, including sub-elements. - `ifnot` is the same as `if`, but with the opposite condition. # Common *container* attributes @@ -162,17 +162,17 @@ The key code for comparison can be obtained via `input.keycode("key_name")` - `min` - minimal value. Type: number. Default: 0 - `max` - maximal value. Type: number. Default: 1 - `value` - initial value. Type: number. Default: 0 -- `step` - track step size. Type: number: Default: 1 -- `track-width` track pointer width (in steps). Type: number. Default: 1 +- `step` - track step size. Type: number. Default: 1 +- `track-width` - track pointer width (in steps). Type: number. Default: 1 - `track-color` - the color of the pointer when hovering over the cursor. Type: RGBA color. - `consumer` - Lua function - new value consumer -- `sub-consumer` - Lua function that receives intermediate values ​​(use to update text when `change-on-release="true"`) +- `sub-consumer` - Lua function that receives intermediate values (use to update text when `change-on-release="true"`) - `supplier` - Lua function - value supplier - `change-on-release` - Call consumer on trackbar release only. Type: boolean. Default: false ## Inline frame - *iframe* -Container for embedding an external document. Content is scaling to the iframe size. +Container for embedding an external document. Content is scaled to the iframe size. - `src` - document id in the format `pack:name` (`pack/layouts/name.xml`) @@ -196,7 +196,7 @@ Example of list description: - `onselect` - function to which the user-selected value is passed - `mode` - behaviour / display mode: - `select` - default mode. - - `button` - button mode: the text is not replaced with the selected option; the element rendered as a regular button. + - `button` - button mode: the text is not replaced with the selected option; the element is rendered as a regular button. ## *bindbox* @@ -213,18 +213,18 @@ An element for displaying and editing key or mouse button bindings. Element is a container. Does not have specific attributes. > [!WARNING] -> Inventories position is controlled by the engine and can not be changed by attributes *pos* and *margin* +> Inventory position is controlled by the engine and can not be changed by attributes *pos* and *margin* > [!WARNING] > Slots not linked to an inventory will not be displayed. "Linked to an inventory" refers to the association between an inventory UI element and an inventory via an ID. This link can be explicitly established using `inventory_ui.inventory = inventory_id`. [(see ui.md)](scripting/ui.md#inventory) ## *slot* -Element must be in direct sub-element of *inventory*. +Element must be a direct sub-element of *inventory*. - `index` - inventory slot index (starting from 0). Type: integer - `item-source` - content access panel behaviour (infinite source of an item). Type: boolean - `sharefunc` - Lua event called on LMB + Shift. Inventory id and slot index passed as arguments. -- `updatefunc` - Lua event called on slot content update.Inventory id and slot index passed as arguments. +- `updatefunc` - Lua event called on slot content update. Inventory id and slot index passed as arguments. - `onrightclick` - Lua event called on RMB click. Inventory id and slot index passed as arguments. - `taking` - the ability to take an item from a slot. - `placing` - the ability to put an item in a slot. @@ -235,12 +235,12 @@ Element must be in direct sub-element of *inventory*. - `interval` - visual slots interval. Type: number - `padding` - grid padding (not slots interval). Type: number. (*deprecated*) - `sharefunc` - Lua event called on LMB + Shift. Inventory id and slot index passed as arguments. -- `updatefunc` - Lua event called on slot content update.Inventory id and slot index passed as arguments. +- `updatefunc` - Lua event called on slot content update. Inventory id and slot index passed as arguments. - `onrightclick` - Lua event called on RMB click. Inventory id and slot index passed as arguments. - `taking` - the ability to take an item from a slot. - `placing` - the ability to put an item in a slot. Slots configuration (just specify two attributes): -- `rows` - ​​number of rows. Type: integer +- `rows` - number of rows. Type: integer - `cols` - number of columns. Type: integer - `count` - total number of slots. Type: integer diff --git a/doc/ru/3d-text.md b/doc/ru/3d-text.md index 548289701..7704d5458 100644 --- a/doc/ru/3d-text.md +++ b/doc/ru/3d-text.md @@ -4,7 +4,7 @@ Вид 3D текста, как и [частицы](particles.md), настраивается через таблицу, все поля которой опциональны. -| Поле | Описание | По-умолчанию | +| Поле | Описание | По умолчанию | | --------------- | ------------------------------------------------------- | ----------------- | | display | Формат отображения | static_billboard | | color | Цвет текста | {1, 1, 1, 1} | @@ -31,7 +31,7 @@ gfx.text3d.show( position: vec3, -- отображаемый текст text: str, - -- таблица настроек отображение текста + -- таблица настроек отображения текста preset: table, -- дополнительная таблица настроек отображения текста [опционально] extension: table @@ -86,7 +86,7 @@ gfx.text3d.set_entity(id: int, entity: int) ``` Геттер и сеттер сущности, к позиции которой привязан 3D текст. -Позиция, устанавливаемая через `gfx.text3d.set_pos`, в таком случае, относительна позиции сущности. +Позиция, устанавливаемая через `gfx.text3d.set_pos`, в таком случае, относительно позиции сущности. ```lua gfx.text3d.update_settings(id: int, preset: table) diff --git a/doc/ru/animation.md b/doc/ru/animation.md index 45e69a0e3..ab13da50c 100644 --- a/doc/ru/animation.md +++ b/doc/ru/animation.md @@ -1,10 +1,10 @@ # Анимация -Для того, чтобы загрузить дорожку анимации для скелета сущности ([см. риггинг](rigging.md)) или камеры ([см. камеры](scripting/builtins/libcameras.md)) её, как любой, незагружаемый по-умолчанию, следует указать в [preload.json пака](assets-preload.md) в секции animation. +Для того, чтобы загрузить дорожку анимации для скелета сущности ([см. риггинг](rigging.md)) или камеры ([см. камеры](scripting/builtins/libcameras.md)) её, как любой, незагружаемый по умолчанию, следует указать в [preload.json пака](assets-preload.md) в секции animation. На данный момент, движком поддерживается один формат описания анимации - [VCA](vca.md). -Общий API для работы с анимацией, как и другими продолжительными событиями, существует библиотека animation, доступная в виде глобальной переменной. +Для работы с анимацией, как и с другими продолжительными событиями, существует общий API - библиотека animation, доступная в виде глобальной переменной. Самый простой способ анимировать что-то: diff --git a/doc/ru/assets-preload.md b/doc/ru/assets-preload.md index 5b0c3b4ec..1d39d76aa 100644 --- a/doc/ru/assets-preload.md +++ b/doc/ru/assets-preload.md @@ -1,6 +1,6 @@ # Предзагрузка ассетов (файл *preload.json*) -Для загрузки ассетов, не загружаемых автоматически, такие как звуки, дополнительные текстуры, используется файл `preload.json`, создающийся в папке контент-пака. +Для загрузки ассетов, не загружаемых автоматически, таких как звуки, дополнительные текстуры, используется файл `preload.json`, создающийся в папке контент-пака. Ассеты в файле разделяются на категории: - animation - анимация @@ -26,7 +26,7 @@ ``` Будет доступен под именем: "events/explosion" -В случае, если нужно будет работать с PCM данными звука (сейчас не доступно из скриптинга), требуется указать параметр `keep-pcm`: +В случае, если нужно будет работать с PCM данными звука (сейчас недоступно из скриптинга), требуется указать параметр `keep-pcm`: ```json { "sounds": [ diff --git a/doc/ru/audio.md b/doc/ru/audio.md index c07c55677..9b62ce903 100644 --- a/doc/ru/audio.md +++ b/doc/ru/audio.md @@ -70,9 +70,9 @@ audio.play_stream( volume: number -- скорость воспроизведения (положительное число) pitch: number, - -- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular) + -- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular) channel: string, - -- [опционально] зацикливание потока (по-умолчанию - false) + -- [опционально] зацикливание потока (по умолчанию - false) loop: bool ) -> int ``` @@ -87,9 +87,9 @@ audio.play_stream_2d( volume: number -- скорость воспроизведения (положительное число) pitch: number, - -- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular) + -- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular) channel: string, - -- [опционально] зацикливание потока (по-умолчанию - false) + -- [опционально] зацикливание потока (по умолчанию - false) loop: bool ) -> int ``` @@ -109,9 +109,9 @@ audio.play_sound( volume: number -- скорость воспроизведения (положительное число) pitch: number, - -- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular) + -- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular) channel: string, - -- [опционально] зацикливание потока (по-умолчанию - false) + -- [опционально] зацикливание потока (по умолчанию - false) loop: bool ) -> int ``` @@ -128,9 +128,9 @@ audio.play_sound_2d( volume: number -- скорость воспроизведения (положительное число) pitch: number, - -- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular) + -- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular) channel: string, - -- [опционально] зацикливание потока (по-умолчанию - false) + -- [опционально] зацикливание потока (по умолчанию - false) loop: bool ) -> int ``` @@ -139,7 +139,7 @@ audio.play_sound_2d( ### Взаимодействие со спикером. -При обращении к несуществующим спикером ничего происходить не будет. +При обращении к несуществующему спикеру ничего происходить не будет. ```lua -- остановить воспроизведение спикера @@ -189,9 +189,9 @@ audio.get_velocity(speakerid: int) -> number, number, number -- (используется OpenAL для имитации эффекта Доплера) audio.set_velocity(speakerid: int, x: number, y: number, z: number) --- получить длительность аудио в секуднах, проигрываемого источником --- возвращает 0, если не спикер не существует --- так же возвращает 0, если длительность неизвестна (пример: радио) +-- получить длительность аудио в секундах, проигрываемого источником +-- возвращает 0, если спикер не существует +-- также возвращает 0, если длительность неизвестна (пример: радио) audio.get_duration(speakerid: int) -> number ``` @@ -241,14 +241,14 @@ stream:create_sound( ```lua -- запрашивает доступ к записи звука --- при подтверждении, в callback передаётся токен для использовании в audio.input.fetch +-- при подтверждении, в callback передаётся токен для использования в audio.input.fetch audio.input.request_open(callback: function(string)) -- читает новые PCM данные аудио ввода audio.input.fetch( -- токен, полученный через audio.input.request_open access_token: string, - -- максимальное размер буфера в байтах + -- максимальный размер буфера в байтах [опционально] max_read_size: int ) ``` diff --git a/doc/ru/block-models.md b/doc/ru/block-models.md index a7ae6636c..6f636107b 100644 --- a/doc/ru/block-models.md +++ b/doc/ru/block-models.md @@ -1,6 +1,6 @@ # Модели блоков (устарело) -> ![WARNING] +> [!WARNING] > Свойство `model-primitives` является устаревшим, используйте [формат VCM](vcm.md) для текстового описания модели из примитивов. Создание собственной модели блока может быть реализовано при указании у блока свойств: @@ -16,7 +16,7 @@ **AABB** примитив - массив состоящий из значений: ``` -[x, y, z, width, height, depth, имёна текстур для каждой стороны] +[x, y, z, width, height, depth, имена текстур для каждой стороны] ``` **tetragon** примитив (по смыслу скорее parallelogram) - массив из трёх векторов, описывающих позицию примитива, вектор X\*ширина, Y\*высота. diff --git a/doc/ru/block-properties.md b/doc/ru/block-properties.md index 09db5c8ef..e6b0ceb85 100644 --- a/doc/ru/block-properties.md +++ b/doc/ru/block-properties.md @@ -30,7 +30,7 @@ ### Модель - *model* Модель блока из списка: -- "block" - используется по-умолчанию для всех обычных блоков +- "block" - используется по умолчанию для всех обычных блоков - "none" - невидимый блок (пример: воздух) - "X" - модель травы (крест из двух спрайтов) - "aabb" - модель, соответствующая хитбоксу блока (составной хитбокс будет объединен в один). Примеры: трубы, лампочки, панели. @@ -66,7 +66,7 @@ Профиль вращения (набор положений, в которые можно установить блок) из списка: -- "none" - вращение блока отключено (по-умолчанию) +- "none" - вращение блока отключено (по умолчанию) - "pipe" - профиль "труба". Примеры блоков: бревно, труба, лампочка - "pane" - профиль "панель". Примеры блоков: панель, дверь, табличка - "stairs" - профиль "ступеньки" ("pane" + перевернутые варианты) @@ -104,8 +104,8 @@ } ``` -- `offset` определяет битового смещения, с которого начинается индекс варианта. (По-умолчанию - 0) -- `bits` определяет число бит, кодирующих индекс варианта. (По-умолчанию - 4). +- `offset` определяет битовое смещение, с которого начинается индекс варианта. (По умолчанию - 0) +- `bits` определяет число бит, кодирующих индекс варианта. (По умолчанию - 4). На данный момент максимальное число вариантов - 16, поэтому указание более 4 бит не имеет практического смысла. Доступные для вариативности свойства: @@ -153,7 +153,7 @@ - `[15, 15, 15]` - самый яркий белый свет - `[7, 0, 0]` - слабый красный свет -- `[0, 0, 0]` - блок не излучает свет (по-умолчанию) +- `[0, 0, 0]` - блок не излучает свет (по умолчанию) ### Светопроводимость - *light-passing* @@ -170,7 +170,7 @@ ### Вершинный Ambient-Occlusion - *ambient-occlusion* -Определяет наличие эффекта вершинного AO. Включен по-умолчанию. +Определяет наличие эффекта вершинного AO. Включен по умолчанию. ### Отсечение - *culling* @@ -231,7 +231,7 @@ ### Скрытый блок - *hidden* -При значении в `true` блок не появляется в инвентаре и для него не генерируется предмет, поэтому c 0.17 требуется указать свойство *picking-item* +При значении в `true` блок не появляется в инвентаре и для него не генерируется предмет, поэтому с 0.17 требуется указать свойство *picking-item* ### Подбираемый предмет - *picking-item* @@ -241,29 +241,29 @@ ### Имя макета UI - *ui-layout* -Позволяет указать id XML-макета интерфейса блока. По-умолчанию используется строковый id блока. +Позволяет указать id XML-макета интерфейса блока. По умолчанию используется строковый id блока. ### Размер инвентаря - *inventory-size* -Число слотов инвентаря блока. По-умолчанию - 0 (инвентарь отсутствует) +Число слотов инвентаря блока. По умолчанию - 0 (инвентарь отсутствует) ## Расширенные блоки ### Размер блока - *size* -Массив из трех целых чисел. Значение по-умолчанию - `[1, 1, 1]`. +Массив из трех целых чисел. Значение по умолчанию - `[1, 1, 1]`. ### Поведение приземленности - *grounding-behaviour* Определяет поведение расширенного приземленного блока. Доступные варианты поведения: -- "partial" - как минимум один сегмент блока должен быть приземленным (по-умолчанию) +- "partial" - как минимум один сегмент блока должен быть приземленным (по умолчанию) - "complete" - все сегменты блока должны быть приземленными - "origin" - главный сегмент должен быть приземленным ## Поля блока -Поля блоков позволяет записывать больше уникальных для конкретного блока данных, чем это позволяют пользовательские биты. +Поля блоков позволяют записывать больше уникальных для конкретного блока данных, чем это позволяют пользовательские биты. Поля блока объявляются в следующем формате: @@ -306,7 +306,7 @@ Доступ к пользовательским свойствам производится через таблицу `block.properties[id]["свойство"]` где id - числовой id (индекс) блока. -Пользовательские свойства должны быть объявляены в файле `пак:config/user-props.toml`: +Пользовательские свойства должны быть объявлены в файле `пак:config/user-props.toml`: ```toml "пак:имя_свойства" = {} ``` @@ -332,9 +332,9 @@ } ``` -- count равен 1 по-умолчанию. Не нужно указывать если указаны `min` и `max`. +- count равен 1 по умолчанию. Не нужно указывать если указаны `min` и `max`. - min, max - минимальное и максимальное количество предмета. -- chance - вероятность выпадения предмета. По-умолчанию: 1.0. +- chance - вероятность выпадения предмета. По умолчанию: 1.0. Следует учитывать, что в item указывается именно предмет. Т.е. чтобы указать предмет блока, нужно добавить `.item` после имени блока. Пример: `base:dirt.item`. @@ -350,11 +350,11 @@ ### Интервал тактов - *tick-interval* -Интервал в тактах мира (1/20 секуды). Значение 20 приводит к интервалу вызова on_block_tick равному одной секунде. +Интервал в тактах мира (1/20 секунды). Значение 20 приводит к интервалу вызова on_block_tick равному одной секунде. ## Методы -Методы используются для управлением перезаписью свойств при расширении блока другими паками. +Методы используются для управления перезаписью свойств при расширении блока другими паками. ### `имя_свойства@append` diff --git a/doc/ru/console.md b/doc/ru/console.md index df62413fd..7b040fb91 100644 --- a/doc/ru/console.md +++ b/doc/ru/console.md @@ -5,9 +5,9 @@ При отправке команды через стандартную консоль (макет core:console): 1. проверяется правило `allow-cheats` 2. автоматически устанавливаются переменные `player`, `pos.x|y|z`, `entity.id`, `entity.selected`. -3. вызывается обработчик команд - console.submit или по-умолчанию. +3. вызывается обработчик команд - console.submit или по умолчанию. -Обработчик по-умолчанию вызывает console.execute, передавая результат в вызов console.log. +Обработчик по умолчанию вызывает console.execute, передавая результат в вызов console.log. ## Создание команд @@ -24,7 +24,7 @@ console.add_command(схема: str, исполнитель: function, чит_к ``` Название может содержать: -- латинницу +- латиницу - цифры (кроме первого символа) - `.`, `_`, `-` @@ -56,13 +56,13 @@ console.add_command(схема: str, исполнитель: function, чит_к x:num~pos.x ``` -Переменные можно указывать и в качестве значений по-умолчанию, при использовании префикса `$`: +Переменные можно указывать и в качестве значений по умолчанию, при использовании префикса `$`: ```python t:int=$time ``` -Перечисления указывазываются в формате: +Перечисления указываются в формате: ```python mode:[replace|destruct|none] diff --git a/doc/ru/content-packs.md b/doc/ru/content-packs.md index 4ab002104..5a3ac72f8 100644 --- a/doc/ru/content-packs.md +++ b/doc/ru/content-packs.md @@ -7,7 +7,7 @@ Далее в *res/content* создаётся папка с выбранным названием контент-пака. -В созданной папке создаётся файл **package.json** с следующим содержимым: +В созданной папке создаётся файл **package.json** со следующим содержимым: ```json { "id": "выбранное_имя_пака", @@ -98,13 +98,13 @@ print(file.read("пак:package.json")) -- выведет содержимое p - `pages/` - макеты страниц меню (элемент pagebox) - Конфигурация: - `config/` - файлы конфигурации - - `defaults.toml` - переопределения стандартных привязок к контенту, такие как сущность игрока, генератор по-умолчанию и т.д. + - `defaults.toml` - переопределения стандартных привязок к контенту, такие как сущность игрока, генератор по умолчанию и т.д. - `bindings.toml` - привязки к клавишам / мыши - `user-props.toml` - пользовательские свойства определений контента - `devtools/` - вспомогательные файлы внутренних инструментов отладки - - `content.json` - генерируемые автоматически списки контента, используемое для проверки корректности индексов в мире и конвертации при несовпадении + - `content.json` - генерируемые автоматически списки контента, используемые для проверки корректности индексов в мире и конвертации при несовпадении - `icon.png` - иконка пака - - `package.json` - файл опеределения пака + - `package.json` - файл определения пака - `preload.json` - списки предзагрузки ассетов, которые не загружаются автоматически, не следует указывать ассеты без надобности - `resources.json` - списки определений [ресурсов](resources.md) (не путать с ассетами) - `resource-aliases.json` - файлы объявления псевдонимов для [ресурсов](resources.md) @@ -120,7 +120,7 @@ print(file.read("пак:package.json")) -- выведет содержимое p будет выбран тот, что принадлежит источнику с наивысшим приоритетом. Источники контента в порядке убывания приоритета: -- `world:content` - контент папке с миром (`мир/content/`) +- `world:content` - контент в папке с миром (`мир/content/`) - `user:content` - контент в папке пользователя (`$HOME/.voxeng/content/`) - `project:content` - контент в папке с проектом (`проект/content/`) - `res:content` - встроенный контент, поставляемый вместе с ядром движка (`res/content/`) diff --git a/doc/ru/engine-use-recommendations.md b/doc/ru/engine-use-recommendations.md index da13a6317..76f6b1bc6 100644 --- a/doc/ru/engine-use-recommendations.md +++ b/doc/ru/engine-use-recommendations.md @@ -21,7 +21,7 @@ #### Данные в мире -Состояние, которое нужно сохранять в мире, должны находиться в `world:data/id_пака/`. Путь следует получать через специальную функцию: +Состояние, которое нужно сохранять в мире, должно находиться в `world:data/id_пака/`. Путь следует получать через специальную функцию: ```lua local path = pack.data_file(PACK_ID, "имя_файла") file.write(path, данные) diff --git a/doc/ru/entity-properties.md b/doc/ru/entity-properties.md index 20ff752c7..69ff6f24a 100644 --- a/doc/ru/entity-properties.md +++ b/doc/ru/entity-properties.md @@ -2,7 +2,7 @@ ## Логика -### Cписок компонентов - *components* +### Список компонентов - *components* Определяет компоненты и порядок их инициализации. @@ -56,7 +56,7 @@ Определяет то, как с ним будет работать физический движок. - *static* (статический) - физический движок не воздействует на тело. -- *dynamic* (динамический) - тип по-умолчанию. Физический движок просчитывает движение и столкновения. +- *dynamic* (динамический) - тип по умолчанию. Физический движок просчитывает движение и столкновения. - *kinematic* (кинематический) - просчитывается только движение, без столкновений. ### Блокирование - *blocking* @@ -65,16 +65,16 @@ *В будущем будет также блокировать движение других сущностей.* -Значение по-умолчанию: *true*. +Значение по умолчанию: *true*. ### Непрозрачность для лучей - *selectable* -При значении в `false` курсор будет игнорировать cущность, пропуская луч далее. +При значении в `false` курсор будет игнорировать сущность, пропуская луч далее. Распространяется на все использования raycast без флага include_non_selectable. ### Список сенсоров - *sensors* -Сенсор - область пространства, привязанная к физическому телу, детектирующее попадание в него других тел. +Сенсор - область пространства, привязанная к физическому телу, детектирующая попадание в него других тел. - При попадании тела вызывается событие *on_sensor_enter*. - При покидании тела вызывается событие *on_sensor_exit*. @@ -125,7 +125,7 @@ ### Имя скелета - *skeleton-name* -Значение по-умолчанию совпадает с именем сущности. Определяет то, какой скелет будет использоваться сущностью. См. [риггинг](rigging.md). +Значение по умолчанию совпадает с именем сущности. Определяет то, какой скелет будет использоваться сущностью. См. [риггинг](rigging.md). ### Тип освещения - *lighting-mode* @@ -140,7 +140,7 @@ (Указываются булевы значения) -| Название | Цель | По-умолчанию | +| Название | Цель | По умолчанию | | ---------------------- | -------------------------------------------------------- | ------------ | | save | сама сущность | true | | save-skeleton-pose | поза скелета сущности | false | diff --git a/doc/ru/item-properties.md b/doc/ru/item-properties.md index 7453789fb..1f4be05be 100644 --- a/doc/ru/item-properties.md +++ b/doc/ru/item-properties.md @@ -14,8 +14,8 @@ ### Модель предмета - `model-name` Имя модели предмета. Модель будет загружена автоматически. -Значение по-умолчанию - `packid:itemname.model`. -Если модель не указана, будет сгенерирована автоматическию +Значение по умолчанию - `packid:itemname.model`. +Если модель не указана, будет сгенерирована автоматически ### Имя и Описание `caption` - имя предмета в инвентаре @@ -47,11 +47,11 @@ - `[15, 15, 15]` - самый яркий белый свет - `[7, 0, 0]` - слабый красный свет -- `[0, 0, 0]` - предмет не излучает свет (по-умолчанию) +- `[0, 0, 0]` - предмет не излучает свет (по умолчанию) ### Размер стопки (стека) - `stack-size` -Определяет максимальное количество предмета в одном слоте. Значение по-умолчанию - 64. +Определяет максимальное количество предмета в одном слоте. Значение по умолчанию - 64. ### Число использований (прочность) - `uses` @@ -64,11 +64,11 @@ - `none` - отображение отключено - `number` - число - `relation` - отношение текущего значения к изначальному (x/y) -- `vbar` - вертикальная шкала (используется по-умолчанию) +- `vbar` - вертикальная шкала (используется по умолчанию) ### Имя скрипта - `script-name` -Определяет имя скрипта, содержащего обработчики событий предмета. По-умолчанию соответствует строковому id (имени) предмета. +Определяет имя скрипта, содержащего обработчики событий предмета. По умолчанию соответствует строковому id (имени) предмета. Свойство обеспечивает возможность использования одного скрипта для нескольких предметов. ## Теги - *tags* diff --git a/doc/ru/particles.md b/doc/ru/particles.md index e1e9fb34a..66f1ba1b4 100644 --- a/doc/ru/particles.md +++ b/doc/ru/particles.md @@ -3,7 +3,7 @@ Частицы представляют собой таблицу, все поля которой опциональны. -| Поле | Описание | По-умолчанию | +| Поле | Описание | По умолчанию | | --------------- | ---------------------------------------------------------------------------- | --------------- | | texture | Текстура частицы. | "" | | frames | Кадры анимации (массив имен текстур). Должны находиться в одном атласе. | {} | diff --git a/doc/ru/resources.md b/doc/ru/resources.md index b374a9af2..efa837328 100644 --- a/doc/ru/resources.md +++ b/doc/ru/resources.md @@ -13,7 +13,7 @@ Запрашиваемые паком ресурсы указываются через файл resources.json в формате: ```json { - "тип-ресура": [ + "тип-ресурса": [ "имена", "ресурсов" ] diff --git a/doc/ru/rigging.md b/doc/ru/rigging.md index 388b19ea2..e49c6c035 100644 --- a/doc/ru/rigging.md +++ b/doc/ru/rigging.md @@ -8,7 +8,7 @@ > > Скелет является неиндексируемой единицей контента. При его загрузке к имени добавляется префикс пака (пример: *drop* в паке base -> *base:drop*). -Элемент скелета, или кость, состоит из матрицы транформации, определяющей её положение, вращение и масштаб относительно родительского элемента (кости) или сущности, если элемент является корневым, модели и списка под-элементов. +Элемент скелета, или кость, состоит из матрицы трансформации, определяющей её положение, вращение и масштаб относительно родительского элемента (кости) или сущности, если элемент является корневым, модели и списка под-элементов. Файл скелета имеет следующую структуру: ```json diff --git a/doc/ru/scripting.md b/doc/ru/scripting.md index 377b2c6da..454598bdc 100644 --- a/doc/ru/scripting.md +++ b/doc/ru/scripting.md @@ -69,7 +69,7 @@ Актуальна следующая структура: -- Глобальное пространство (оно же - _G), являющееся корневым, запись в которое, вне модулей ядра движка, является крайне нежелательным для вашего же времени, что может уйти на лишние часы отладки. +- Глобальное пространство (оно же - _G), являющееся корневым, запись в которое, вне модулей ядра движка, является крайне нежелательной для вашего же времени, что может уйти на лишние часы отладки. - Пространство пака - создаётся каждый раз при загрузке контента для каждого, включённого в конфигурацию, пака. Это пространство используют модули, а также скрипты предметов и блоков. - Пространство [компонента](scripting/ecs.md#пользовательские-компоненты). - Пространство [UI-документа](scripting/ui.md) @@ -77,7 +77,7 @@ ## Модули -Модуль - глобальный объект со сроком жизни, ограниченным сроком жизни контента, используемый как для взаимодействия разных паков, так и для вместо глобальных переменных в пределах самого пака. +Модуль - глобальный объект со сроком жизни, ограниченным сроком жизни контента, используемый как для взаимодействия разных паков, так и в качестве замены глобальных переменных в пределах самого пака. Модуль должен находиться в `контентпак/modules/**` (допускаются вложенные папки, что нужно будет указывать) diff --git a/doc/ru/scripting/builtins/libapp.md b/doc/ru/scripting/builtins/libapp.md index 71886a61f..78c5afdff 100644 --- a/doc/ru/scripting/builtins/libapp.md +++ b/doc/ru/scripting/builtins/libapp.md @@ -2,12 +2,12 @@ Библиотека для высокоуровневого управления работой движка, доступная только в режиме сценария или теста. -Имя сценария/теста без пути и расширения доступен как `app.script`. Путь к файлу можно получить как: +Имя сценария/теста без пути и расширения доступно как `app.script`. Путь к файлу можно получить как: ```lua local filename = "script:"..app.script..".lua" ``` -Так как управляющий сценарий может не принадлежать ни одному из паков, он не относиться к своему паку и имеет собственное пространство имён, в котором доступны все глобальные функции и таблицы, а также библиотека `app`. +Так как управляющий сценарий может не принадлежать ни одному из паков, он не относится к своему паку и имеет собственное пространство имён, в котором доступны все глобальные функции и таблицы, а также библиотека `app`. ## Содержание: Методы для работы с: @@ -25,18 +25,18 @@ app.tick() -- Ожидает указанное время в секундах, выполняя основной цикл движка. app.sleep(time: number) --- Завершает выполнение движка, выводя стек вызовов для ослеживания места вызова функции. +-- Завершает выполнение движка, выводя стек вызовов для отслеживания места вызова функции. app.quit() -- Ожидает истинности утверждения (условия), проверяемого функцией, -- выполняя основной цикл движка. app.sleep_until( - -- функция, проверяющее условия завершения ожидания + -- функция, проверяющая условия завершения ожидания predicate: function() -> boolean, -- максимальное количество тактов цикла движка, после истечения которых -- будет брошено исключение "max ticks exceed" [опционально] max_ticks: int = 1e9, - -- максимальное длительность ожидания в секундах. + -- максимальная длительность ожидания в секундах. -- (работает с системным временем, включая test-режим) [опционально] timeout: number = 1e9 ) diff --git a/doc/ru/scripting/builtins/libassets.md b/doc/ru/scripting/builtins/libassets.md index 1bf0d301f..b9ac18226 100644 --- a/doc/ru/scripting/builtins/libassets.md +++ b/doc/ru/scripting/builtins/libassets.md @@ -51,7 +51,7 @@ assets.parse_animation( -- Создаёт холст (Canvas) из загруженной текстуры assets.to_canvas( -- Имя загруженной текстуры. - -- Поддерживается как отдельные ("имя_текстуры"), + -- Поддерживаются как отдельные ("имя_текстуры"), -- так и находящиеся в атласе ("атлас:имя_текстуры"). name: string ) -> Canvas diff --git a/doc/ru/scripting/builtins/libblock.md b/doc/ru/scripting/builtins/libblock.md index 9725d2b3d..1e744542e 100644 --- a/doc/ru/scripting/builtins/libblock.md +++ b/doc/ru/scripting/builtins/libblock.md @@ -29,11 +29,11 @@ block.properties: table> -- Если чанк на указанных координатах не загружен, возвращает -1. block.get(x: int, y: int, z: int) -> int --- Устанавливает блок с заданным числовым id и состоянием (0 - по-умолчанию) на заданных координатах. +-- Устанавливает блок с заданным числовым id и состоянием (0 - по умолчанию) на заданных координатах. -- Если передан noupdate=true, то вызов ивента `on_update` для соседних блоков не произойдёт. block.set(x: int, y: int, z: int, id: int, states: int, noupdate: boolean=false) --- Устанавливает блок с заданным числовым id и состоянием (0 - по-умолчанию) на заданных координатах +-- Устанавливает блок с заданным числовым id и состоянием (0 - по умолчанию) на заданных координатах -- от лица игрока, вызывая событие on_placed. -- playerid не является обязательным block.place(x: int, y: int, z: int, id: int, states: int, [опционально] playerid: int) @@ -70,7 +70,7 @@ block.caption(blockid: int) -> string -- Возвращает строковый id блока по его числовому id. block.name(blockid: int) -> string --- Возвращает числовой id блока, принимая в качестве агрумента строковый +-- Возвращает числовой id блока, принимая в качестве аргумента строковый block.index(name: string) -> int -- Собирает полное состояние в виде целого числа @@ -106,7 +106,7 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [опциональ Бросает луч из точки start в направлении dir. Max_distance указывает максимальную длину луча. Аргумент `filter` позволяет указать какие блоки являются "прозрачными" для луча, прим.: {"base:glass","base:water"}. -Для использования агрумент `dest` нужно чем-то заполнить(можно nil), это сделано для обратной совместимости +Для использования аргумент `dest` нужно чем-то заполнить (можно nil), это сделано для обратной совместимости Аргумент `include_non_selectable` определяет, будут ли учтены блоки, которые нельзя выбрать курсором. Пример - `base:water` @@ -125,11 +125,11 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [опциональ block.get_X(x: int, y: int, z: int) -> int, int, int block.get_X(id: int, rotation: int) -> int, int, int --- То же, но для оси Y (по-умолчанию 0, 1, 0) +-- То же, но для оси Y (по умолчанию 0, 1, 0) block.get_Y(x: int, y: int, z: int) -> int, int, int block.get_Y(id: int, rotation: int) -> int, int, int --- То же, но для оси Z (по-умолчанию 0, 0, 1) +-- То же, но для оси Z (по умолчанию 0, 0, 1) block.get_Z(x: int, y: int, z: int) -> int, int, int block.get_Z(id: int, rotation: int) -> int, int, int diff --git a/doc/ru/scripting/builtins/libbyteutil.md b/doc/ru/scripting/builtins/libbyteutil.md index 54dc474ff..e50f9fb06 100644 --- a/doc/ru/scripting/builtins/libbyteutil.md +++ b/doc/ru/scripting/builtins/libbyteutil.md @@ -24,7 +24,7 @@ byteutil.tpack(format: string, ...) -> table Символы значений описывают тип и размер. -| Символ | Аналог в С++ | Тип Lua | Размер | +| Символ | Аналог в C++ | Тип Lua | Размер | | --------- | --------------- | -------- | ------- | | `b` | int8_t | number | 1 байт | | `B` | uint8_t | number | 1 байт | diff --git a/doc/ru/scripting/builtins/libcameras.md b/doc/ru/scripting/builtins/libcameras.md index 71b4c9ee1..0ada9bd07 100644 --- a/doc/ru/scripting/builtins/libcameras.md +++ b/doc/ru/scripting/builtins/libcameras.md @@ -29,7 +29,7 @@ cam:get_pos() -> vec3 -- устанавливает позицию камеры cam:set_pos(pos: vec3) --- возращает вращение камеры +-- возвращает вращение камеры cam:get_rot() -> mat4 -- устанавливает вращение камеры cam:set_rot(rot: mat4) diff --git a/doc/ru/scripting/builtins/libcompression.md b/doc/ru/scripting/builtins/libcompression.md index 6c6b194b8..70e9771b8 100644 --- a/doc/ru/scripting/builtins/libcompression.md +++ b/doc/ru/scripting/builtins/libcompression.md @@ -1,6 +1,6 @@ # Библиотека *compression* -Библиотека функций для работы сжатия/разжатия массивов байт +Библиотека функций для сжатия/разжатия массивов байт ```lua -- Сжимает массив байт. diff --git a/doc/ru/scripting/builtins/libctypes.md b/doc/ru/scripting/builtins/libctypes.md index d6c985b44..481550724 100644 --- a/doc/ru/scripting/builtins/libctypes.md +++ b/doc/ru/scripting/builtins/libctypes.md @@ -1,8 +1,8 @@ # Библиотека *ctypes* -Библиотека для безопасной работы с типами языка С. +Библиотека для безопасной работы с типами языка C. -| ctypes.\ | С-тип | Минимум | Максимум | +| ctypes.\ | C-тип | Минимум | Максимум | | ------------- | -------- | -------------------- | -------------------- | | uint8 | uint8_t | 0 | 255 | | uint16 | uint16_t | 0 | 65535 | diff --git a/doc/ru/scripting/builtins/libentities.md b/doc/ru/scripting/builtins/libentities.md index 9753c7e15..045dbe2fd 100644 --- a/doc/ru/scripting/builtins/libentities.md +++ b/doc/ru/scripting/builtins/libentities.md @@ -15,7 +15,7 @@ entities.get(uid: int) -> table -- префикс - id пака -- имя - название компонента -- префикс и имя компонента разделяются двумя подчеркиваниями --- Возвращает обьект сущности +-- Возвращает объект сущности entities.spawn(name: string, pos: vec3, [optional] args: table) -> table -- Проверяет наличие сущности по уникальному идентификатору. @@ -41,7 +41,7 @@ entities.defs_count() -> int ``` > [!NOTE] -> Следующие функции для получения получения нескольких сущностей возвращают таблицы с целочисленными ключами (uid). +> Следующие функции для получения нескольких сущностей возвращают таблицы с целочисленными ключами (uid). > Для итерации нужно использовать pairs, для подсчёта размера таблицы - table.count_pairs. > Использование ipairs даст некорректные результаты, так как возвращаемая таблица не является массивом. diff --git a/doc/ru/scripting/builtins/libfile.md b/doc/ru/scripting/builtins/libfile.md index 0c1e03ff6..1dc6fdaa5 100644 --- a/doc/ru/scripting/builtins/libfile.md +++ b/doc/ru/scripting/builtins/libfile.md @@ -64,7 +64,7 @@ file.write(путь: string, текст: string) -> nil -- Записывает массив байт в файл (с перезаписью) file.write_bytes(путь: string, data: table) --- Удаляет файл. Возращает true если файл существовал. Бросает исключение при нарушении доступа. +-- Удаляет файл. Возвращает true если файл существовал. Бросает исключение при нарушении доступа. file.remove(путь: string) -> boolean -- Проверяет, существует ли по данному пути файл @@ -118,7 +118,7 @@ file.read_combined_object(путь: string) -> table ## Zip-архивы ```lua --- Монтирует ZIP-архив как файловой системе. Возвращает имя точки входа. +-- Монтирует ZIP-архив к файловой системе. Возвращает имя точки входа. file.mount(путь: string) -> string -- Размонтирует точку входа. diff --git a/doc/ru/scripting/builtins/libgfx-skeletons.md b/doc/ru/scripting/builtins/libgfx-skeletons.md index 95fa4fe48..9465c0df1 100644 --- a/doc/ru/scripting/builtins/libgfx-skeletons.md +++ b/doc/ru/scripting/builtins/libgfx-skeletons.md @@ -33,7 +33,7 @@ skeleton:get_texture(key: string) -> string -- Назначает текстуру по ключу skeleton:set_texture(key: string, value: string) --- Проверяет статус видимости кости по индесу +-- Проверяет статус видимости кости по индексу -- или всего скелета, если индекс не указан skeleton:is_visible([опционально] index: int) -> boolean diff --git a/doc/ru/scripting/builtins/libgfx-weather.md b/doc/ru/scripting/builtins/libgfx-weather.md index b51bd58e1..0a9b9bf60 100644 --- a/doc/ru/scripting/builtins/libgfx-weather.md +++ b/doc/ru/scripting/builtins/libgfx-weather.md @@ -4,9 +4,9 @@ Настройки погоды: -| Свойство | Описание | По-умолчанию | +| Свойство | Описание | По умолчанию | | ------------- | ------------------------------------------ | ----------------- | -| fall | Осадки (см. таблица 2) | {} | +| fall | Осадки (см. таблицу 2) | {} | | clouds | Облачность [0.0, 1.0] | 0.0 | | fog_opacity | Максимальная плотность тумана [0.0, 1.0] | 0.0 | | fog_dencity | Плотность тумана | 1.0 | @@ -18,7 +18,7 @@ Осадки: -| Свойство | Описание | По-умолчанию | +| Свойство | Описание | По умолчанию | | ------------- | -------------------------------------------- | ------------ | | texture | Текстура осадков | "" | | noise | Шум осадков | "" | @@ -27,7 +27,7 @@ | scale | Масштаб UV развертки осадков | 0.1 | | min_opacity | Минимальный множитель alpha-канала осадков | 0.0 | | max_opacity | Максимальный множитель alpha-канала осадков | 1.0 | -| max_intensity | Масимальная интенсивность осадков | 1.0 | +| max_intensity | Максимальная интенсивность осадков | 1.0 | | opaque | Отключение полупрозрачности осадков | false | | splash | Таблица настроек частиц всплесков от осадков | {} | diff --git a/doc/ru/scripting/builtins/libgui.md b/doc/ru/scripting/builtins/libgui.md index 51ac7307f..9e6cb114c 100644 --- a/doc/ru/scripting/builtins/libgui.md +++ b/doc/ru/scripting/builtins/libgui.md @@ -106,14 +106,14 @@ gui.show_message( gui.ask( -- сообщение (не переводится автоматически, используйте gui.str(...)) message: string, - -- функция, вызываемая при подтвержении + -- функция, вызываемая при подтверждении on_confirm: function() -> nil, -- функция, вызываемая при отказе/отмене [опционально] on_deny: function() -> nil, - -- текст кнопки подтвержения (по-умолчанию: "Да") - -- используйте пустую строку для значения по-умолчанию, если нужно указать no_text. + -- текст кнопки подтверждения (по умолчанию: "Да") + -- используйте пустую строку для значения по умолчанию, если нужно указать no_text. [опционально] yes_text: string - -- текст кнопки отказа (по-умолчанию: "Нет") + -- текст кнопки отказа (по умолчанию: "Нет") [опционально] no_text: string ) ``` @@ -131,14 +131,14 @@ gui.alert( gui.confirm( -- сообщение (не переводится автоматически, используйте gui.str(...)) message: string, - -- функция, вызываемая при подтвержении + -- функция, вызываемая при подтверждении on_confirm: function() -> nil, -- функция, вызываемая при отказе/отмене [опционально] on_deny: function() -> nil, - -- текст кнопки подтвержения (по-умолчанию: "Да") - -- используйте пустую строку для значения по-умолчанию, если нужно указать no_text. + -- текст кнопки подтверждения (по умолчанию: "Да") + -- используйте пустую строку для значения по умолчанию, если нужно указать no_text. [опционально] yes_text: string - -- текст кнопки отказа (по-умолчанию: "Нет") + -- текст кнопки отказа (по умолчанию: "Нет") [опционально] no_text: string ) ``` diff --git a/doc/ru/scripting/builtins/libhud.md b/doc/ru/scripting/builtins/libhud.md index 7a93c93e4..210c78573 100644 --- a/doc/ru/scripting/builtins/libhud.md +++ b/doc/ru/scripting/builtins/libhud.md @@ -20,7 +20,7 @@ hud.open( [опционально] invid: int ) -> int --- Возвращает true если указаный макет UI открыт. +-- Возвращает true если указанный макет UI открыт. hud.is_open( layoutid: string ) -> boolean diff --git a/doc/ru/scripting/builtins/libinput.md b/doc/ru/scripting/builtins/libinput.md index f3ac4b699..1c93c1906 100644 --- a/doc/ru/scripting/builtins/libinput.md +++ b/doc/ru/scripting/builtins/libinput.md @@ -11,7 +11,8 @@ input.mousecode(mousename: string) -> number -- Проверяет активность ввода по коду, состоящему из: -- * типа ввода: key (клавиша) или mouse (кнопка мыши) --- * код ввода: [имя клавиши](#имена-клавиш) или имя кнопки мыши (left, middle, right) +-- * код ввода: имя клавиши или имя кнопки мыши (left, middle, right). +-- См. user-input.md input.is_pressed(code: string) -> boolean -- Возвращает названия всех доступных привязок. @@ -32,7 +33,7 @@ input.set_enabled(bindname: string, flag: boolean) -- Возвращает позицию курсора на экране. input.get_mouse_pos() -> {number, number} --- Возращает дельту позиции курсора. +-- Возвращает дельту позиции курсора. input.get_mouse_delta() -> {number, number} -- Возвращает вертикальное смещение колеса мыши, накопленное за текущий кадр. diff --git a/doc/ru/scripting/builtins/libinventory.md b/doc/ru/scripting/builtins/libinventory.md index 4a836f83b..044ccb59a 100644 --- a/doc/ru/scripting/builtins/libinventory.md +++ b/doc/ru/scripting/builtins/libinventory.md @@ -55,9 +55,9 @@ inventory.find_by_item( invid: int, -- id предмета itemid: int, - -- [опционально] индекс начала диапазона слотов (c 0) + -- [опционально] индекс начала диапазона слотов (с 0) range_begin: int, - -- [опционально] индекс конца диапазона слотов (c 0) + -- [опционально] индекс конца диапазона слотов (с 0) range_end: int, -- [опционально] минимальное количество предмета в слоте min_count: int = 1 @@ -82,7 +82,7 @@ inventory.remove(invid: int) > [!NOTE] > Локальные свойства предмета - данные прикреплённые к последнему предмету в стеке. -> При разделении стека (ПКМ) данные не копируются а перемещаются в новый стек. +> При разделении стека (ПКМ) данные не копируются, а перемещаются в новый стек. > Свойства могут иметь любой сериализуемый тип, включая таблицы. > В отличие от полей блоков имена свойств не требуется регистрировать в определении предмета. @@ -172,13 +172,13 @@ inventory.get_all_data( slot: int, ) -> table | nil --- Устанавливает значения локальных cвойств предмета. +-- Устанавливает значения локальных свойств предмета. inventory.set_all_data( -- id инвентаря invid: int, -- индекс слота slot: int, - -- таблица cвойство:значение + -- таблица свойство:значение fields: table, -- удалить остальные значения свойств [опционально] clear: boolean = false diff --git a/doc/ru/scripting/builtins/libmat4.md b/doc/ru/scripting/builtins/libmat4.md index 1b44df1ee..60c6155b8 100644 --- a/doc/ru/scripting/builtins/libmat4.md +++ b/doc/ru/scripting/builtins/libmat4.md @@ -2,7 +2,7 @@ *mat4* содержит набор функций для работы с матрицами трансформации размерностью 4x4. -Большинство функций имеют несколько вариантов списка агрументов (перегрузок). +Большинство функций имеют несколько вариантов списка аргументов (перегрузок). ## Единичная матрица - *mat4.idt(...)* @@ -117,7 +117,7 @@ mat4.decompose(m: matrix) ## Отслеживание точки - *mat4.look_at(...)* ```lua --- cоздаёт матрицу вида с точки 'eye' на точку 'center', где вектор 'up' определяет верх. +-- создаёт матрицу вида с точки 'eye' на точку 'center', где вектор 'up' определяет верх. mat4.look_at(eye: vec3, center: vec3, up: vec3) -- записывает матрицу вида в dst mat4.look_at(eye: vec3, center: vec3, up: vec3, dst: matrix) @@ -126,14 +126,14 @@ mat4.look_at(eye: vec3, center: vec3, up: vec3, dst: matrix) ## Расчёт матрицы перспективы - *mat4.perspective* ```lua --- возвращает расчитанную матрицу перспективы. +-- возвращает рассчитанную матрицу перспективы. -- параметр fov принимает значение вертикального поля зрения в градусах. -- параметр ratio задаёт отношение сторон (сторона X к стороне Y, пример: для монитора 800:600 отношение сторон равно 4 к 3, или 4 / 3). -- параметр near задаёт расстояние от камеры до плоскости Near. -- параметр far задаёт расстояние от камеры до плоскости Far. mat4.perspective(fov: number, ratio: number, near: number, far: number) -> mat4 --- расчитывает матрицу перспективы на основе переданных значений и записывает её в переменную dst. +-- рассчитывает матрицу перспективы на основе переданных значений и записывает её в переменную dst. mat4.perspective(fov: number, ratio: number, near: number, far: number, dst: mat4) -> nil ``` diff --git a/doc/ru/scripting/builtins/libnetwork.md b/doc/ru/scripting/builtins/libnetwork.md index 2c322405e..baed5cce4 100644 --- a/doc/ru/scripting/builtins/libnetwork.md +++ b/doc/ru/scripting/builtins/libnetwork.md @@ -112,7 +112,7 @@ socket:recv( -- Использовать таблицу вместо Bytearray [опционально] usetable: boolean=false ) -> nil|table|Bytearray --- В случае ошибки возвращает nil (сокет закрыт или несуществует). +-- В случае ошибки возвращает nil (сокет закрыт или не существует). -- Если данных пока нет, возвращает пустой массив байт. -- Асинхронный вариант для использования в корутинах. @@ -170,7 +170,7 @@ socket:set_nodelay(state: boolean) network.tcp_open( -- Порт port: int, - -- Функция, вызываемая при поключениях + -- Функция, вызываемая при подключениях -- Как единственный аргумент передаётся сокет подключенного клиента callback: function(Socket) ) -> ServerSocket @@ -224,7 +224,7 @@ socket:get_address() -> string, int ```lua network.udp_open( port: int, - -- Функция, вызываемая при получении датаграмы + -- Функция, вызываемая при получении датаграммы -- В параметры передаётся адрес и порт отправителя, а также сами данные datagramHandler: function(address: string, port: int, data: Bytearray, server: DatagramServerSocket) ) -> DatagramServerSocket diff --git a/doc/ru/scripting/builtins/libpack.md b/doc/ru/scripting/builtins/libpack.md index 925cad7f8..cd5ef641e 100644 --- a/doc/ru/scripting/builtins/libpack.md +++ b/doc/ru/scripting/builtins/libpack.md @@ -49,7 +49,7 @@ pack.is_installed(packid: string) -> boolean pack.get_installed() -> table ``` -Возращает id всех установленных в мире контент-паков. +Возвращает id всех установленных в мире контент-паков. ```lua pack.get_available() -> table @@ -102,4 +102,4 @@ pack.assemble(packids: table) -> table pack.request_writeable(packid: string, callback: function(string)) ``` -Запрашивает у пользователя право на модификацию пака. При подтвержении новая точка входа будет передана в callback. +Запрашивает у пользователя право на модификацию пака. При подтверждении новая точка входа будет передана в callback. diff --git a/doc/ru/scripting/builtins/libplayer.md b/doc/ru/scripting/builtins/libplayer.md index 1590d0a47..08077e967 100644 --- a/doc/ru/scripting/builtins/libplayer.md +++ b/doc/ru/scripting/builtins/libplayer.md @@ -74,7 +74,7 @@ player.set_infinite_items(playerid: int, boolean) player.is_infinite_items(playerid: int) -> boolean --- Сеттер и геттер мнгновенного разрушения блоков при активации привязки player.destroy. +-- Сеттер и геттер мгновенного разрушения блоков при активации привязки player.destroy. player.set_instant_destruction(playerid: int, boolean) player.is_instant_destruction(playerid: int) -> boolean diff --git a/doc/ru/scripting/builtins/libquat.md b/doc/ru/scripting/builtins/libquat.md index a32a24e6d..b718937b9 100644 --- a/doc/ru/scripting/builtins/libquat.md +++ b/doc/ru/scripting/builtins/libquat.md @@ -2,7 +2,7 @@ Библиотека для работы с кватернионами. -Кватернионы задаюся таблицей, состоящей из 4 компонентов: +Кватернионы задаются таблицей, состоящей из 4 компонентов: `{w, x, y, z}` ## Кватернион из матрицы - *quat.from_mat4(...)* diff --git a/doc/ru/scripting/builtins/librandom.md b/doc/ru/scripting/builtins/librandom.md index 252ffe8e6..d0c1e677a 100644 --- a/doc/ru/scripting/builtins/librandom.md +++ b/doc/ru/scripting/builtins/librandom.md @@ -1,6 +1,6 @@ # Библиотека *random* -Библиотека функций для генерации случайный чисел. +Библиотека функций для генерации случайных чисел. ## Недетерминированные числа diff --git a/doc/ru/scripting/builtins/librules.md b/doc/ru/scripting/builtins/librules.md index f5588b4dc..c1068a40d 100644 --- a/doc/ru/scripting/builtins/librules.md +++ b/doc/ru/scripting/builtins/librules.md @@ -4,7 +4,7 @@ rules.create( -- имя правила name: string, - -- значение по-умолчанию + -- значение по умолчанию default: boolean, -- функция-обработчик изменения значения [опционально] handler: function @@ -14,7 +14,7 @@ rules.create( Создаёт правило. Если указан обработчик, возвращает id для возможности удаления. > [!NOTE] -> Созданием правила считается вызов rules.create с назначением значения по-умолчанию. +> Созданием правила считается вызов rules.create с назначением значения по умолчанию. > Не созданные правила могут быть использованы, но сброс через rules.reset приведёт > к установке значения nil. @@ -54,13 +54,13 @@ rules.set(name: string, value: boolean) rules.reset(name: string) ``` -Сбрасывает значение правила к значению по-умолчанию. +Сбрасывает значение правила к значению по умолчанию. ## Стандартные правила -| Имя | Описание | По-умолчанию | +| Имя | Описание | По умолчанию | | ---------------------- | --------------------------------------------------------------- | ------------ | | allow-cheats | Разрешить команды, имена которых есть в массиве console.cheats. | true | | allow-content-access | Разрешить панель доступа к контенту. | true | diff --git a/doc/ru/scripting/builtins/libutf8.md b/doc/ru/scripting/builtins/libutf8.md index 657b89192..a08cf5bd5 100644 --- a/doc/ru/scripting/builtins/libutf8.md +++ b/doc/ru/scripting/builtins/libutf8.md @@ -16,13 +16,13 @@ utf8.length(text: string) -> int -- Возвращает код первого символа строки utf8.codepoint(chars: string) -> int --- Кодирует код в в UTF-8 +-- Кодирует код в UTF-8 utf8.encode(codepoint: int) -> string -- Возвращает подстроку от позиции startchar до endchar включительно utf8.sub(text: string, startchar: int, [опционально] endchar: int) -> string --- Переводит строку в вверхний регистр +-- Переводит строку в верхний регистр utf8.upper(text: string) -> string -- Переводит строку в нижний регистр diff --git a/doc/ru/scripting/builtins/libvecn.md b/doc/ru/scripting/builtins/libvecn.md index 00ec0277a..b37ed23d1 100644 --- a/doc/ru/scripting/builtins/libvecn.md +++ b/doc/ru/scripting/builtins/libvecn.md @@ -18,7 +18,7 @@ > [!WARNING] > -> Аннотации типов являются частью документации и не указываются при вызове использовании. +> Аннотации типов являются частью документации и не указываются при вызове. ## Операции с векторами diff --git a/doc/ru/scripting/builtins/libworld.md b/doc/ru/scripting/builtins/libworld.md index 52812f295..ef1c95302 100644 --- a/doc/ru/scripting/builtins/libworld.md +++ b/doc/ru/scripting/builtins/libworld.md @@ -23,7 +23,7 @@ world.set_day_time(time: number) -- Устанавливает указанную скорость смены времени суток. world.set_day_time_speed(value: number) --- Возвращает скорость скорость смены времени суток. +-- Возвращает скорость смены времени суток. world.get_day_time_speed() -> number -- Возвращает суммарное время, прошедшее в мире. @@ -63,7 +63,7 @@ world.set_chunk_data( ) -> boolean -- Сохраняет данные чанка в регион. --- Изменения будет записаны в файл только после сохранения мира. +-- Изменения будут записаны в файл только после сохранения мира. world.save_chunk_data( x: int, z: int, -- сжатые данные чанка diff --git a/doc/ru/scripting/bytearray.md b/doc/ru/scripting/bytearray.md index d15cd6a58..1909a607a 100644 --- a/doc/ru/scripting/bytearray.md +++ b/doc/ru/scripting/bytearray.md @@ -2,7 +2,7 @@ *Bytearray* - динамический байтовый массив, реализованный через LuaJIT FFI. По нему можно итерироваться стандартными функциями **pairs** и **ipairs** -Примечание касаемо условных обозначений в документации: псведотип `posint` означает натуральное (положительное ненулевое целое) число. +Примечание касаемо условных обозначений в документации: псевдотип `posint` означает натуральное (положительное ненулевое целое) число. ## Основное ### Создание массива diff --git a/doc/ru/scripting/core_components.md b/doc/ru/scripting/core_components.md index 7113a62bb..51f31a3cd 100644 --- a/doc/ru/scripting/core_components.md +++ b/doc/ru/scripting/core_components.md @@ -2,7 +2,7 @@ ## *core:pathfinding* -Компонент для построение путей движения мобов. +Компонент для построения путей движения мобов. ```lua local pathfinding = entity:require_component("core:pathfinding") diff --git a/doc/ru/scripting/ecs.md b/doc/ru/scripting/ecs.md index 2c6d7a96c..647a4ee3b 100644 --- a/doc/ru/scripting/ecs.md +++ b/doc/ru/scripting/ecs.md @@ -14,12 +14,12 @@ entity:def_index() -> int -- Возвращает имя определения сущности (строковый ID) entity:def_name() -> str --- Возращает имя скелета сущности +-- Возвращает имя скелета сущности entity:get_skeleton() -> str -- Заменяет скелет сущности entity:set_skeleton(name: str | nil) --- Возращает уникальный идентификатор сущности +-- Возвращает уникальный идентификатор сущности entity:get_uid() -> int -- Возвращает компонент по имени @@ -33,7 +33,7 @@ entity:require_component(name: str) -> компонент entity:set_enabled(name: str, enable: bool) -- Возвращает id игрока, к которому привязана сущность, в ином же случае возвращает -1. --- Во время инициализации компонентов при спавне сущности так же возвращает -1, +-- Во время инициализации компонентов при спавне сущности также возвращает -1, -- так как привязка происходит после инициализации. entity:get_player() -> int или nil ``` @@ -72,9 +72,9 @@ tsf:set_rot(rotation: mat4) -- Сокращение local body = entity.rigidbody --- Проверяет, включен ли рассчет физики тела +-- Проверяет, включен ли расчет физики тела body:is_enabled() -> bool --- Включает/выключает рассчет физики тела +-- Включает/выключает расчет физики тела body:set_enabled(enabled: bool) -- Возвращает линейную скорость @@ -137,7 +137,7 @@ body:get_ground_vel() -> vec3 -- Проверяет свойство 'selectable' у сущности (непрозрачность для лучей) body:is_selectable() -> bool --- Устанавливает значение свойство 'selectable' у сущности +-- Устанавливает значение свойства 'selectable' у сущности body:set_selectable(flag: bool) ``` @@ -170,7 +170,7 @@ rig:set_texture(key: str, value: str) -- Возвращает индекс кости по имени или nil rig:index(name: str) -> int --- Проверяет статус видимости кости по индесу +-- Проверяет статус видимости кости по индексу -- или всего скелета, если индекс не указан rig:is_visible([optional] index: int) -> bool @@ -204,7 +204,7 @@ rig:set_color(color: vec3 | vec4, index: int) Для **каждой** сущности, содержащей компонент, создаётся **отдельный экземпляр** со **своим пространством имен** внутри пространства имён пака. Глобальные переменные, объявляемые в нём, играют роль публичных полей компонента (как и глобальные функции). -Компоненты сущности указываются через [список "components"](../entity-properties.md#cписок-компонентов---components) +Компоненты сущности указываются через [список "components"](../entity-properties.md#список-компонентов---components) > [!WARNING] > При выходе сущности за пределы зоны прогрузки она удаляется, вызывая события. diff --git a/doc/ru/scripting/events.md b/doc/ru/scripting/events.md index bfa0b9388..8b9dc41e9 100644 --- a/doc/ru/scripting/events.md +++ b/doc/ru/scripting/events.md @@ -212,7 +212,7 @@ function on_open(invid: int, x: int, y: int, z: int) Вызывается при добавлении элемента на экран. - При отсутствии привязки к инвентарю invid будет равен 0. -- При отсутствии привязки к блоку x, y, z так же будут равны 0. +- При отсутствии привязки к блоку x, y, z также будут равны 0. ```lua function on_close(invid: int) @@ -297,4 +297,4 @@ events.emit(code: str, args...) -> bool events.remove_by_prefix(packid: str) ``` -Удаляет все события с префиксом `packid:`. Вы выходе из мира выгружаются события всех паков, включая `core:`. +Удаляет все события с префиксом `packid:`. При выходе из мира выгружаются события всех паков, включая `core:`. diff --git a/doc/ru/scripting/extensions.md b/doc/ru/scripting/extensions.md index 3a372a9a5..dbdc13a18 100644 --- a/doc/ru/scripting/extensions.md +++ b/doc/ru/scripting/extensions.md @@ -85,16 +85,16 @@ end ``` ```lua --- Разбивает строку str на части по указанному разделителю/выражению separator и возвращает результат ввиде таблицы из строк. Если withpattern равен true, то параметр separator будет определяться как регулярное выражение. +-- Разбивает строку str на части по указанному разделителю/выражению separator и возвращает результат в виде таблицы из строк. Если withpattern равен true, то параметр separator будет определяться как регулярное выражение. string.explode(separator: string, str: string, withpattern: boolean) -> table --- Разбивает строку str на части по указанному разделителю delimiter и возвращает результат ввиде таблицы из строк. +-- Разбивает строку str на части по указанному разделителю delimiter и возвращает результат в виде таблицы из строк. string.split(str: string, delimiter: string) -> table -- Экранирует специальные символы в строке, такие как `()[]+-.$%^?*` в формате `%символ`. Символ `NUL` (`\0`) будет преобразован в `%z`. string.pattern_safe(str: string) -> string --- Разбивает секунды на часы, минуты и миллисекунды и форматирует в format с следующим порядком параметров: `минуты, секунды, миллисекунды` и после возвращает результат. Если format не указан, то возвращает таблицу, где: +-- Разбивает секунды на часы, минуты и миллисекунды и форматирует в format со следующим порядком параметров: `минуты, секунды, миллисекунды` и после возвращает результат. Если format не указан, то возвращает таблицу, где: -- h - hours, -- m - minutes, -- s - seconds, @@ -152,7 +152,7 @@ string.url_decode(str: string) -> string ## Расширения для math ```lua --- Возвращает _in, если оно находится в диапозоне low <= _in <= high +-- Возвращает _in, если оно находится в диапазоне low <= _in <= high -- Иначе возвращает границу, к которой ближе всего находится значение _in. math.clamp(_in: number, low: number, high: number) -> number @@ -171,10 +171,10 @@ math.sum(x: number, ... | t: table) -> number -- Возвращает целое число, указывающее знак числа (-1/0/1) math.sign(x: number) -> int --- Одномерный шум с значениями в диапазоне [-1..1]. +-- Одномерный шум со значениями в диапазоне [-1..1]. math.noise(x: number, [опционально] octaves: int = 1) -> number --- Двумерный шум с значениями в диапазоне [-1..1]. +-- Двумерный шум со значениями в диапазоне [-1..1]. math.noise2d(x: number, y: number [опционально] octaves: int = 1) -> number ``` diff --git a/doc/ru/scripting/filesystem.md b/doc/ru/scripting/filesystem.md index 546722101..8ff199dfa 100644 --- a/doc/ru/scripting/filesystem.md +++ b/doc/ru/scripting/filesystem.md @@ -2,7 +2,7 @@ ## Библиотека *file* -См. [библиотека file](builtins/libfile.md) +См. [библиотеку file](builtins/libfile.md) ## Библиотека json @@ -12,7 +12,7 @@ json.tostring(object: table, human_readable: bool=false) -> str ``` -Сериализует объект в JSON строку. При значении второго параметра **true** будет использовано многострочное форматирование, удобное для чтения человеком, а не компактное, использующееся по-умолчанию. +Сериализует объект в JSON строку. При значении второго параметра **true** будет использовано многострочное форматирование, удобное для чтения человеком, а не компактное, использующееся по умолчанию. ```python json.parse(code: str) -> table @@ -58,7 +58,7 @@ yaml.parse(code: str) -> table Далее XML как тип данных обозначает Lua-таблицу со следующей структурой: - Тег элемента доступен по ключу `#` -- XML-аттрибуты доступны как пары ключ = значение +- XML-атрибуты доступны как пары ключ = значение - Вложенные элементы доступны по индексу Таблица используется как словарь, так и массив. @@ -133,4 +133,4 @@ pack.data_file(id_пака: str, имя_файла: str) -> str Функция возвращает путь к файлу данных по типу: `world:data/id_пака/имя_файла` и создает недостающие директории в пути. -При использовании путей не соответствующим `data/{packid}/...` возможна потеря данных при перезаписи мира. +При использовании путей, не соответствующих `data/{packid}/...` возможна потеря данных при перезаписи мира. diff --git a/doc/ru/scripting/io_stream.md b/doc/ru/scripting/io_stream.md index e54ca1fdb..05664e5be 100644 --- a/doc/ru/scripting/io_stream.md +++ b/doc/ru/scripting/io_stream.md @@ -31,7 +31,7 @@ |---------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | `"default"` | Прямой режим. `read` может вернуть меньше байт, чем запрошено. `write` сразу отправляет данные в низкоуровневый дескриптор. Нет буферизации. | | `"yield"` | Как `default`, но при нехватке данных в `read(n)` поток будет вызывать `coroutine.yield()`, пока не соберёт ровно `n` байт. Удобно для корутин. | -| `"buffered"` | Включает внутренние буферы чтения и записи. `read` берёт данные из буфера , `write` — складывает в буфер. | +| `"buffered"` | Включает внутренние буферы чтения и записи. `read` берёт данные из буфера, `write` — складывает в буфер. | ### flush @@ -90,11 +90,11 @@ io_stream:set_flush_mode(string) --[[ Читает данные из потока В двоичном режиме: - Если arg - int, то читает из потока arg байт и возвращает ввиде Bytearray или таблицы, если use_table = true + Если arg - int, то читает из потока arg байт и возвращает в виде Bytearray или таблицы, если use_table = true Если arg - string, то функция интерпретирует arg как шаблон для byteutil. Прочитает кол-во байт, которое определено шаблоном, передаст их в byteutil.unpack и вернёт результат В текстовом режиме: - Если arg - int, то читает нужное кол-во строк с окончанием CRLF/LF из arg и возвращает ввиде таблицы. Также, если trim_empty_lines = true, то удаляет пустые строки с начала и конца из итоговой таблицы + Если arg - int, то читает нужное кол-во строк с окончанием CRLF/LF из arg и возвращает в виде таблицы. Также, если trim_empty_lines = true, то удаляет пустые строки с начала и конца из итоговой таблицы Если arg не определён, то читает одну строку с окончанием CRLF/LF и возвращает её. --]] @@ -128,7 +128,7 @@ io_stream:write_line(string) --[[ В двоичном режиме: - Читает все доступные байты из потока и возвращает ввиде Bytearray или table, если use_table = true + Читает все доступные байты из потока и возвращает в виде Bytearray или table, если use_table = true В текстовом режиме: Читает все доступные строки из потока в table если use_table = true, или в одну строку вместе с окончаниями, если нет @@ -152,7 +152,7 @@ io_stream:available( --[[ Устанавливает позицию в потоке (всегда в байтах) Режимы: - b - Задаёт позицию относительно начало файла + b - Задаёт позицию относительно начала файла c - Задаёт позицию относительно текущей позиции e - Задаёт позицию относительно конца файла @@ -201,7 +201,7 @@ io_stream:flush() io_stream.wrap_bytearray( buffer: Bytearray, - -- по-умолчанию равен true, поскольку функция из вводных аргументов + -- по умолчанию равен true, поскольку функция из вводных аргументов -- будет использоваться преимущественно для работы с двоичными данными. [опционально] binary_mode: boolean = true ) -> io_stream diff --git a/doc/ru/scripting/modules/core_bit_converter.md b/doc/ru/scripting/modules/core_bit_converter.md index acf7fd9e6..ca0a0ab8d 100644 --- a/doc/ru/scripting/modules/core_bit_converter.md +++ b/doc/ru/scripting/modules/core_bit_converter.md @@ -95,4 +95,4 @@ function bit_converter.bytes_to_sint32(bytes: table|Bytearray, [опционал ```lua function bit_converter.bytes_to_int64(bytes: table|Bytearray, [опционально] order: string) -> int ``` -Конвертирует массив байтов в 8-х байтовое знаковое число +Конвертирует массив байтов в 8-и байтовое знаковое число diff --git a/doc/ru/scripting/modules/core_data_buffer.md b/doc/ru/scripting/modules/core_data_buffer.md index eb3b43c3c..6819fca6a 100644 --- a/doc/ru/scripting/modules/core_data_buffer.md +++ b/doc/ru/scripting/modules/core_data_buffer.md @@ -1,6 +1,6 @@ # Модуль core:data_buffer -## Буффер данных +## Буфер данных ### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения ```lua @@ -11,7 +11,7 @@ function data_buffer( ) ``` Создаёт новый экземпляр **data_buffer**. -Если **useBytearray** равен **true**, то байты буффера будут хранится ввиде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буффера в памяти +Если **useBytearray** равен **true**, то байты буфера будут храниться в виде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буфера в памяти ```lua function data_buffer:set_order(order: string) @@ -22,62 +22,62 @@ function data_buffer:set_order(order: string) ```lua function data_buffer:put_byte(byte: int) ``` -Записывает байт в буффер +Записывает байт в буфер ```lua function data_buffer:put_bytes(bytes: table|Bytearray) ``` -Записывает байты в буффер +Записывает байты в буфер ```lua function data_buffer:put_string(str: string) ``` -Конвертирует строку в байты и записывает их в буффер +Конвертирует строку в байты и записывает их в буфер ```lua function data_buffer:put_bool(bool: boolean) ``` -Конвертирует булевое значение в байт и записывает его в буффер +Конвертирует булевое значение в байт и записывает его в буфер ```lua function data_buffer:put_float32(float: number) ``` -Конвертирует плавающее число одинарной точности в байты и записывает их в буффер +Конвертирует плавающее число одинарной точности в байты и записывает их в буфер ```lua function data_buffer:put_float64(float: number) ``` -Конвертирует плавающее число двойной точности в байты и записывает их в буффер +Конвертирует плавающее число двойной точности в байты и записывает их в буфер ```lua function data_buffer:put_uint16(int: int) ``` -Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер +Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буфер ```lua function data_buffer:put_uint32(int: int) ``` -Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер +Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буфер ```lua function data_buffer:put_sint16(int: int) ``` -Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер +Конвертирует знаковое 2-х байтовое число в байты и записывает их в буфер ```lua function data_buffer:put_sint32(int: int) ``` -Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер +Конвертирует знаковое 4-х байтовое число в байты и записывает их в буфер ```lua function data_buffer:put_int64(int: int) ``` -Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер +Конвертирует знаковое 8-и байтовое число в байты и записывает их в буфер ```lua function data_buffer:put_number(num: number) ``` -Конвертирует любое число в байты и записывает их в буффер; +Конвертирует любое число в байты и записывает их в буфер; Первый байт это тип значения: ```lua @@ -93,7 +93,7 @@ sint32 = 8 ```lua function data_buffer:get_byte() -> int ``` -Возвращает следующий байт из буффера +Возвращает следующий байт из буфера ```lua function data_buffer:get_bytes(n) -> table|Bytearray @@ -103,47 +103,47 @@ function data_buffer:get_bytes(n) -> table|Bytearray ```lua function data_buffer:get_string() -> string ``` -Читает следующую строку из буффера +Читает следующую строку из буфера ```lua function data_buffer:get_bool() -> boolean ``` -Читает следующий логический булев из буффера +Читает следующий логический булев из буфера ```lua function data_buffer:get_float32() -> number ``` -Читает следующее плавающее число одинарной точности из буффера +Читает следующее плавающее число одинарной точности из буфера ```lua function data_buffer:get_float64() -> number ``` -Читает следующее плавающее число двойной точности из буффера +Читает следующее плавающее число двойной точности из буфера ```lua function data_buffer:get_uint16() -> int ``` -Читает следующее 2-х байтовое беззнаковое целое число из буффера +Читает следующее 2-х байтовое беззнаковое целое число из буфера ```lua function data_buffer:get_uint32() -> int ``` -Читает следующее 4-х байтовое беззнаковое целое число из буффера +Читает следующее 4-х байтовое беззнаковое целое число из буфера ```lua function data_buffer:get_sint16() -> int ``` -Читает следующее 2-х байтовое знаковое целое число из буффера +Читает следующее 2-х байтовое знаковое целое число из буфера ```lua function data_buffer:get_sint32() -> int ``` -Читает следующее 4-х байтовое знаковое целое число из буффера +Читает следующее 4-х байтовое знаковое целое число из буфера ```lua function data_buffer:get_int64() -> int ``` -Читает следующее 8-х байтовое знаковое целое число из буффера +Читает следующее 8-и байтовое знаковое целое число из буфера ```lua function data_buffer:get_number() -> number @@ -153,14 +153,14 @@ function data_buffer:get_number() -> number ```lua function data_buffer:size() -> int ``` -Возвращает размер буффера +Возвращает размер буфера ```lua function data_buffer:set_position(int: pos) ``` -Устанавливает текущую позицию в буффере +Устанавливает текущую позицию в буфере ```lua function data_buffer:set_bytes(table: bytes) ``` -Устанавливает байты в буффер +Устанавливает байты в буфер diff --git a/doc/ru/scripting/modules/core_vector2_vector3.md b/doc/ru/scripting/modules/core_vector2_vector3.md index 349e5858a..9785cc2a3 100644 --- a/doc/ru/scripting/modules/core_vector2_vector3.md +++ b/doc/ru/scripting/modules/core_vector2_vector3.md @@ -61,7 +61,7 @@ function vector2:rot( angle: number->rad, --Вращение вектора относительно осей ("x", "y", "z") axis: str, - --Если истина, то угол поворота певеодится автоматический из градусы в радианы + --Если истина, то угол поворота переводится автоматически из градусов в радианы convert2deg: bool ) -> vec2 ``` @@ -162,7 +162,7 @@ function vector3:rot( angle: number->rad, --Вращение вектора относительно осей ("x", "y", "z") axis: str, - --Если истина, то угол поворота певеодится автоматический из градусы в радианы + --Если истина, то угол поворота переводится автоматически из градусов в радианы convert2deg: bool ) -> vec2 ``` diff --git a/doc/ru/scripting/ui.md b/doc/ru/scripting/ui.md index 09e296f9b..23037a204 100644 --- a/doc/ru/scripting/ui.md +++ b/doc/ru/scripting/ui.md @@ -1,6 +1,6 @@ # Свойства и методы UI элементов -Обращение к UI элементов в скриптах произодится через экземпляр Document +Обращение к UI элементам в скриптах производится через экземпляр Document (глобальная переменная document) по id, указанному в xml. Пример: вывод в консоль свойства pos элемента с id: "worlds-panel": @@ -19,7 +19,7 @@ Id элемента не может быть изменен из скрипта. В таблицах далее будут использоваться сокращенные описания типов, такие как: - vec2 - массив из двух дробных чисел. - ivec2 - массив из двух целых чисел. -- rgba - массив из четырех дробных чисел в диапазоне `[0..255]` обозначающий RGBA состовляющие цвета. +- rgba - массив из четырех дробных чисел в диапазоне `[0..255]` обозначающий RGBA составляющие цвета. Методы элементов, согласно особенностям ООП в Lua вызываются с использованием оператора `:` вместо `.` @@ -204,8 +204,8 @@ document["worlds-panel"]:clear() | data:unbind_texture() | отвязывает текстуру от холста | | data:mul(*цвет* или Canvas) | умножает цвет на указанный цвет или холст | | data:add(*цвет* или Canvas) | прибавляет цвет или другой холст к цвету | -| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст к цвету | -| data:encode(format: str) | кодирует изображение в указанный формат и возращает массив байт | +| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст из цвета | +| data:encode(format: str) | кодирует изображение в указанный формат и возвращает массив байт | Для декодирования массива байт в Canvas используйте статический метод: ```lua diff --git a/doc/ru/scripting/user-input.md b/doc/ru/scripting/user-input.md index 413f74864..21897e196 100644 --- a/doc/ru/scripting/user-input.md +++ b/doc/ru/scripting/user-input.md @@ -1,6 +1,6 @@ # Пользовательский ввод -Обработка нажатий клавиш и кнопок мыши обрабатываются через привязки (bindings), которые назначаются в паке, в файле `config/bindings.toml` в формате: +Нажатия клавиш и кнопок мыши обрабатываются через привязки (bindings), которые назначаются в паке, в файле `config/bindings.toml` в формате: ```toml packid.binding.name="inputtype:codename" @@ -25,4 +25,4 @@ packid.binding.name="inputtype:codename" ## Библиотека input -См. [библиотека *input*](builtins/libinput.md) +См. [библиотеку *input*](builtins/libinput.md) diff --git a/doc/ru/vca.md b/doc/ru/vca.md index deecad81b..d10d0764e 100644 --- a/doc/ru/vca.md +++ b/doc/ru/vca.md @@ -2,9 +2,9 @@ Текстовый формат анимации, использующий синтаксис [VCM](vcm.md). -VCA файл состоит из набора директив, порядок следования которых не влияет на порядок применение трансформаций. +VCA файл состоит из набора директив, порядок следования которых не влияет на порядок применения трансформаций. -Директивы применяются к переданной цели, которая может быть скелетом сущности и камерой. +Директивы применяются к переданной цели, которая может быть скелетом сущности или камерой. При использовании скелета, в директиве указывается имя кости через атрибут `bone`: ```vcd @@ -31,9 +31,9 @@ VCA файл состоит из набора директив, порядок ## Мета-информация -Информация о анимации в файле настраивается через директиву `configure`: -- `fps` - частота кадров, являющаяся делителем при рассчёте длительности -- `frames` - число кадров анимации, являющееся делимым при рассчёте длительности +Информация об анимации в файле настраивается через директиву `configure`: +- `fps` - частота кадров, являющаяся делителем при расчёте длительности +- `frames` - число кадров анимации, являющееся делимым при расчёте длительности - `duration` - явно указанная длительность в секундах (требуется указание fps при наличии ключевых кадров) - `rotation-order` - указывает порядок применения углов Эйлера при вращении (так как порядок директив не учитывается форматом). Примеры: XYZ, ZYX, YZX. @@ -55,7 +55,7 @@ VCA файл состоит из набора директив, порядок Требуется через атрибут `curve` указать тип кривой: - `const` - значения не интерполируются, сменяясь в момент достижения ключевого кадра -- `linear` - ломанная линия, используется линейная интерполяция +- `linear` - ломаная линия, используется линейная интерполяция - `bezier` - ключевые кадры кривой Безье с явно указанными левой и правой касательными (lx, ly, rx, ry) Ключевые кадры описываются в последующем `{...}` блоке в виде упорядоченных `@key` директив: @@ -67,7 +67,7 @@ VCA файл состоит из набора директив, порядок } ``` -Ключевой кадр должен содержать номер кадра `frame` и значенин `value`. Для `bezier` кадров также описываются касательные. +Ключевой кадр должен содержать номер кадра `frame` и значение `value`. Для `bezier` кадров также описываются касательные. Пример для `curve bezier`: ```vcd diff --git a/doc/ru/vcm.md b/doc/ru/vcm.md index 0a1dbc314..2893564aa 100644 --- a/doc/ru/vcm.md +++ b/doc/ru/vcm.md @@ -23,7 +23,7 @@ На данный момент существует три вида примитивов: tri, box и rect, а также, part (описывает часть примитива, такую как, например, сторона куба). > [!NOTE] -> По-умолчанию текстурные координаты определяются размерами примитивов. +> По умолчанию текстурные координаты определяются размерами примитивов. > При размерах более 1.0 результат не определён и может измениться в последующих обновлениях. > Используйте `region` или `region-scale` для ручной настройки. @@ -35,16 +35,16 @@ - `a` - точка A. Пример: `a (0,0,0)` - `b` - точка B. Пример: `b (1,0,0)` -- `c` - точка С. Пример: `c (1,1,0)` +- `c` - точка C. Пример: `c (1,1,0)` - `uv` - нормализованные текстурные координаты точек (6 чисел, по 2 на точку). Пример: `uv (0,0, 1,0, 1,1)` -- `texture` - отображаемая текстура. По-умолчанию: `$0`. Пример: `texture "blocks:sand"` +- `texture` - отображаемая текстура. По умолчанию: `$0`. Пример: `texture "blocks:sand"` - `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов квадрата нормализованных текстурных координат. Пример: `region (0,0,1,1)` - `region-scale` вектор-множитель для UV региона. Пример: `region-scale (0.5,1)` - `shading` определяет возможность затенения на примитиве. Пример: `shading off` - `normal` переопределяет вектор нормали. Пример: `normal (0,1,0)` -- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отлючает отсечение сторон) +- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отключает отсечение сторон) -Текстурные координаты по-умолчанию не зависят от формы из размера, в отличие от других примитивов. +Текстурные координаты по умолчанию не зависят от формы и размера, в отличие от других примитивов. ### Свойства `rect` @@ -53,13 +53,13 @@ - `from` - точка начала примитива. Пример: `from (0,0.5,0.125)` - `right` - вектор X, также определяющий ширину примитива. Пример: `right (1,0,0)` - `up` - вектор Y, также определяющий высоту примитива. Пример: `up (0,1,0)` -- `texture` - отображаемая текстура. По-умолчанию: `$0`. Пример: `texture "blocks:sand"` +- `texture` - отображаемая текстура. По умолчанию: `$0`. Пример: `texture "blocks:sand"` - `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов. Пример: `region (0,0,1,1)` - `region-scale` - вектор-множитель для автоматически выбранного UV региона. Пример: `region-scale (0.5,1)` - `shading` - определяет возможность затенения на примитиве. Пример: `shading off` - `flip` - отражает UV регион по горизонтали или вертикали. Пример: `flip v` - `normal` - переопределяет вектор нормали. Пример: `normal (0,1,0)` -- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отлючает отсечение сторон) +- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отключает отсечение сторон) ### Свойства `box` @@ -67,9 +67,9 @@ - `from` - точка начала примитива. Пример: `from (0,0,0)` - `to` - противоположная от начала точка. Пример: `to (1,1,1)` -- `origin` - точка, относительно которой будет применено вращение. По-умолчанию: центр примитива. Пример: `origin (0.5,0.5,0.5)` +- `origin` - точка, относительно которой будет применено вращение. По умолчанию: центр примитива. Пример: `origin (0.5,0.5,0.5)` - `rotate` - вращение вокруг осей (x,y,z) в градусах, или кватернион (x,y,z,w). Пример: `rotate (45,0,0)` или `rotate (0.3826834, 0, 0, 0.9238795)` -- `texture` - отображаемая текстура для всех сторон по-умолчанию. +- `texture` - отображаемая текстура для всех сторон по умолчанию. - `shading` - определяет возможность затенения на примитиве. Пример: `shading off` - `delete` - удаляет стороны по именам (top, bottom, east, west, north, south) @@ -77,8 +77,8 @@ Примитив описывает свойства сторон прямоугольного параллелепипеда с указанными тегами (top/bottom/north/south/east/west). -- `tags` - определяет то, на какаие из сторон будут применены свойства. Пример: `tags (top,bottom)` -- `texture` - отображаемая текстура. По-умолчанию: `$индекс_стороны`. +- `tags` - определяет то, на какие из сторон будут применены свойства. Пример: `tags (top,bottom)` +- `texture` - отображаемая текстура. По умолчанию: `$индекс_стороны`. - `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов. Пример: `region (0,0,1,1)` - `region-scale` - вектор-множитель для автоматически выбранного UV региона. Пример: `region-scale (0.5,1)` @@ -87,12 +87,12 @@ VCM позволяет описывать [скелет](rigging.md) модели. Для этого используется элемент `@bone` (кость). Существует два вида костей: -- безымянные - используются только для трансформаций на влюженные примитивы, не попадает в итоговый скелет. -- именованные - будет включено в итоговый скелет. Имя указывается через атрибут `name`. +- безымянные - используются только для трансформаций на вложенные примитивы, не попадают в итоговый скелет. +- именованные - будут включены в итоговый скелет. Имя указывается через атрибут `name`. Главная кость (`root`) создаётся автоматически для всей модели. При наличии явно указанных костей модель будет разделена на несколько частей именованных в формате `имя_модели.имя_кости`. -Так как модель относится к ассетам и не имеет префикса, загруженный скелет получает имя модели, так же, без префикса. +Так как модель относится к ассетам и не имеет префикса, загруженный скелет получает имя модели, также без префикса. Загруженный скелет можно использовать у [сущности](entity-properties.md#имя-скелета---skeleton-name) через свойство `skeleton-name`. В списке `пак/preload.json` при указании параметра `"squash": true` vcm будет загружен как единая модель, без скелета. diff --git a/doc/ru/world-generator.md b/doc/ru/world-generator.md index 34738d4b3..4fb2b6e15 100644 --- a/doc/ru/world-generator.md +++ b/doc/ru/world-generator.md @@ -34,7 +34,7 @@ Понятия используемые далее по тексту. - **Комбинируемый массив/объект** - TOML или JSON файл, который комбинируется из нескольких версий в разных паках, что позволяет добавлять в него данные извне. Поля комбинированного объекта перезаписываются в порядке от первого к последнему, так же, как и другие ресурсы в паках. В случае комбинируемого массива, проверка на дубликаты **не** выполняется. -- **Биом** - информация, определяющая то, из каких блоков и какими слоями генерируется ландшафт, а так же набор растений, структур. +- **Биом** - информация, определяющая то, из каких блоков и какими слоями генерируется ландшафт, а также набор растений, структур. - **Растение** - случайно расставляемый на поверхности блок. - **Малая структура** - структура, размер которой не превышает размера чанка. Пример: деревья. @@ -47,12 +47,12 @@ - fragments - директория в которой располагаются файлы фрагментов Основные свойства, описываемые в файле конфигурации: -- **caption** - отображаемое имя генератора. По-умолчанию генерируется из id. -- **biome-parameters** - количество параметров выбора биомов (от 0 до 4). По-умолчанию: 0. -- **sea-level** - уровень моря (ниже этого уровня вместо воздуха будут генерироваться слои моря (sea-layers)). По-умолчанию: 0. -- **biomes-bpd** - количество блоков на точку карты параметра выбора биомов. По-умолчанию: 4. -- **heights-bpd** - количество блоков на точку карты высот. По-умолчанию: 4. -- **wide-structs-chunks-radius** - масимальный радиус размещения 'широких' структур, измеряемый в чанках. +- **caption** - отображаемое имя генератора. По умолчанию генерируется из id. +- **biome-parameters** - количество параметров выбора биомов (от 0 до 4). По умолчанию: 0. +- **sea-level** - уровень моря (ниже этого уровня вместо воздуха будут генерироваться слои моря (sea-layers)). По умолчанию: 0. +- **biomes-bpd** - количество блоков на точку карты параметра выбора биомов. По умолчанию: 4. +- **heights-bpd** - количество блоков на точку карты высот. По умолчанию: 4. +- **wide-structs-chunks-radius** - максимальный радиус размещения 'широких' структур, измеряемый в чанках. - **heightmap-inputs** - массив номеров карт параметров, которые будут переданы таблицей inputs в функцию генерации карты высот. - **player-spawn-radius** - радиус зоны спавна игроков. - **player-min-spawn-height**, **player-max-spawn-height** - указание **предпочтительной** вертикальной зоны спавна. @@ -68,7 +68,7 @@ ## Фрагменты -Фрагмент является сохраненной для дальнейшего использования, областью мира, как и чанк, ограниченную некоторой шириной, высотой и длиной. Фрагмент может содержать данные не только о блоках, попадающих в область, но и о инвентарях блоков области, а так же сущностях. В отличие от чанка, размер фрагмента произволен. +Фрагмент является сохраненной для дальнейшего использования, областью мира, как и чанк, ограниченной некоторой шириной, высотой и длиной. Фрагмент может содержать данные не только о блоках, попадающих в область, но и об инвентарях блоков области, а также о сущностях. В отличие от чанка, размер фрагмента произволен. На данный момент, фрагмент может быть создан при помощи команды `fragment.save`, либо через функцию `generation.create_fragment`. @@ -93,7 +93,7 @@ coal_ore0 = {} ## Биомы -Биом определяет то, из каких блоков и какими слоями генерируется ландшафт, а так же набор растений, структур. +Биом определяет то, из каких блоков и какими слоями генерируется ландшафт, а также набор растений, структур. Биомы объявляются в комбинируемом объекте: `generators/имя_генератора.files/biomes.toml` @@ -149,7 +149,7 @@ structures = [ Параметр генератора `biome-parameters` определяет количество параметров биомов, используемых при их выборе (примеры: температура, влажность). -Карты значений параметров биомов генеруются так же, как и карты высот. +Карты значений параметров биомов генерируются так же, как и карты высот. Требуется реализовать функцию: ```lua @@ -275,7 +275,7 @@ map:mixin(value: Heightmap|number, t: Heightmap|number) ### heightmap:dump(...) -Метод используемый для отладки, создает изображение на основе карты высот переводя значения из дипазона `[-1.0, 1.0]` в значения яркости `[0, 255]`, сохраняя в указанный файл. +Метод используемый для отладки, создает изображение на основе карты высот переводя значения из диапазона `[-1.0, 1.0]` в значения яркости `[0, 255]`, сохраняя в указанный файл. ```lua map:dump('export:test.png') @@ -287,11 +287,11 @@ map:dump('export:test.png') Зерно шума может быть указано в поле `map.noiseSeed`. -По-умолчанию октавы шума совмещаются через сложение: +По умолчанию октавы шума совмещаются через сложение: $шум_{результат} = шум_{исходный} + шум_{применяемый} * 2^{-{октава}}$ -Для более получения нормализованного многооктавного шума можно включить флаг `map.normalNoise = true`, меняющий схему на: +Для получения более нормализованного многооктавного шума можно включить флаг `map.normalNoise = true`, меняющий схему на: $шум_{результат} = шум_{исходный} * (1 - 2^{-{октава}}) + шум_{применяемый} * 2^{-{октава}}$ @@ -299,11 +299,11 @@ $шум_{результат} = шум_{исходный} * (1 - 2^{-{октав map:noise( -- смещение координат offset: {number, number}, - -- коэфициент масштабирования координат + -- коэффициент масштабирования координат scale: number, - -- число октав шума (по-умолчанию: 1) + -- число октав шума (по умолчанию: 1) [опционально] octaves: int, - -- множитель амплитуды шума (по-умолчанию: 1.0) + -- множитель амплитуды шума (по умолчанию: 1.0) [опционально] multiplier: number, -- карта смещений координаты X при генерации шума [опционально] shiftMapX: Heightmap, @@ -355,7 +355,7 @@ map:crop(x, y, ширина, высота) map:at(x, y) -> number ``` -Возвращает значение высота на заданной позиции. +Возвращает значение высоты на заданной позиции. ## VoxelFragment (фрагмент) @@ -403,7 +403,7 @@ fragment:place(position: vec3, [опционально] rotation:int=0) ## Генерация карты высот -По-умолчанию, движок генерирует карту высот, состоящую из нулей. +По умолчанию, движок генерирует карту высот, состоящую из нулей. Для генерации пользовательских карт высот требуется реализовать функцию: ```lua @@ -446,10 +446,10 @@ end ``` Где: -- имя_структуры - строка содержащая имя структуры, зарегистрированная в structures.toml. +- имя_структуры - строка содержащая имя структуры, зарегистрированной в structures.toml. - позиция_структуры - vec3 (массив из трех чисел). -- поворот - число от 0 до 3 обозначающая поворот структуры по оси Y. -- приоритет - число определяющее порядок установки структур. Структуры с меньшем приоритетом перекрываются структурами с большим. +- поворот - число от 0 до 3, обозначающее поворот структуры по оси Y. +- приоритет - число определяющее порядок установки структур. Структуры с меньшим приоритетом перекрываются структурами с большим. Тоннель: ```lua @@ -523,7 +523,7 @@ function place_structures_wide( ## Структурный воздух -`core:struct_air` - блок, которые следует использовать в фрагментах для обозначения пустого пространства, которое не должно заполняться блоками при генерации в мире. +`core:struct_air` - блок, который следует использовать во фрагментах для обозначения пустого пространства, которое не должно заполняться блоками при генерации в мире. diff --git a/doc/ru/xml-ui-layouts.md b/doc/ru/xml-ui-layouts.md index 94f396495..9632c40b3 100644 --- a/doc/ru/xml-ui-layouts.md +++ b/doc/ru/xml-ui-layouts.md @@ -10,12 +10,12 @@ - `"0.4,53.01"` - `"0,0"` -**3D вектор** - три числа, разделенная запятой. +**3D вектор** - три числа, разделенные запятой. Примеры: - `"60,30,53"` - `"0.4,0.1,0.753"` -**4D вектор** - четыре числа, разделенная запятой. +**4D вектор** - четыре числа, разделенные запятой. Примеры: - `"10,5,10,3"` - `"0.1,0.5,0.0,0.0"` @@ -47,7 +47,7 @@ - `onmiddleclick` - lua функция вызываемая при нажатии средней кнопки мыши на элемент. - `ondoubleclick` - lua функция вызываемая при двойном нажатии на элемент. - `onfocus` - lua функция вызываемая при фокусировке на элемент. -- `ondefocus` - lua функция вызываемая при потере фокуса элеметом. +- `ondefocus` - lua функция вызываемая при потере фокуса элементом. - `onmouseenter` - lua функция вызываемая при входе курсора в элемент. - `onmouseleave` - lua функция вызываемая при выходе курсора из элемента. - `onmouseover` - lua функция вызываемая при наведении курсора на элемент. @@ -117,7 +117,7 @@ - `text-align` - выравнивание текста ("left", "center" или "right"). Тип: строка. - `valign` - вертикальное выравнивание текста: top/center/bottom - `supplier` - поставщик текста (вызывается каждый кадр) -- `autoresize` - автоматическое изменение размера элемента (по-умолчанию - false). Не влияет на размер шрифта. +- `autoresize` - автоматическое изменение размера элемента (по умолчанию - false). Не влияет на размер шрифта. - `multiline` - разрешает отображение многострочного текста. - `text-wrap` - разрешает автоматический перенос текста (работает только при multiline: "true") - `markup` - язык разметки текста ("md" - Markdown). @@ -144,7 +144,7 @@ - `sub-consumer` - lua функция-приемник вводимого текста. Вызывается во время ввода или удаления текста. - `oncontrolkey` - lua функция вызываемая для сочетаний вида (Ctrl + ?). На вход подаётся числовой код второй клавиши. Код клавиши для сравнения можно получить через `input.keycode("имя_клавиши")` -- `autoresize` - автоматическое изменение размера элемента (по-умолчанию - false). Не влияет на размер шрифта. +- `autoresize` - автоматическое изменение размера элемента (по умолчанию - false). Не влияет на размер шрифта. - `multiline` - разрешает отображение многострочного текста. - `text-wrap` - разрешает автоматический перенос текста (работает только при multiline: "true") - `editable`- определяет возможность редактирования текста. @@ -155,21 +155,21 @@ - `validator` - lua функция, проверяющая текст на корректность. Принимает на вход строку, возвращает true если текст корректен. - `onup` - lua функция вызываемая при нажатии стрелки вверх. - `ondown` - lua функция вызываемая при нажатии стрелки вниз. -- `syntax` - подстветка синтаксиса ("lua" - Lua). +- `syntax` - подсветка синтаксиса ("lua" - Lua). - `markup` - язык разметки текста ("md" - Markdown). ## Ползунок - *trackbar* -- `min` - минимальное значение. Тип: число. По-умолчанию: 0 -- `max` - максимальное значение. Тип: число. По-умолчанию: 1 -- `value` - изначальное значение. Тип: число. По-умолчанию: 0 -- `step` - размер деления ползунка. Тип: число. По-умолчанию: 1 -- `track-width` - ширина указателя (в пикселях). Тип: число. По-умолчанию: 12 +- `min` - минимальное значение. Тип: число. По умолчанию: 0 +- `max` - максимальное значение. Тип: число. По умолчанию: 1 +- `value` - изначальное значение. Тип: число. По умолчанию: 0 +- `step` - размер деления ползунка. Тип: число. По умолчанию: 1 +- `track-width` - ширина указателя (в пикселях). Тип: число. По умолчанию: 12 - `track-color` - цвет указателя при наведении курсора. Тип: RGBA цвет. - `consumer` - lua функция-приемник установленного значения - `sub-consumer` - lua функция-приемник промежуточных значений (используйте для обновления текста при `change-on-release="true"`) - `supplier` - lua функция-поставщик значения -- `change-on-release` - Вызов функции-приемника (consumer) происходит только тогда, когда пользователь отпускает указатель. Тип: логический. По-умолчанию: false +- `change-on-release` - Вызов функции-приемника (consumer) происходит только тогда, когда пользователь отпускает указатель. Тип: логический. По умолчанию: false ## Рамка встраивания - *iframe* @@ -192,11 +192,11 @@ ``` -- `width` - минимальная ширина содержимого. По-умолчанию: 100. -- `selected` - изначально выбранное значение. По-умолчанию: "". +- `width` - минимальная ширина содержимого. По умолчанию: 100. +- `selected` - изначально выбранное значение. По умолчанию: "". - `onselect` - функция, в которую передаётся выбранное пользователем значение - `mode` - режим работы: - - `select` - режим по-умолчанию. + - `select` - режим по умолчанию. - `button` - режим кнопки: текст не заменяется на выбранную опцию, а элемент выглядит как обычная кнопка. ## Привязка ввода - *bindbox* @@ -205,7 +205,7 @@ - `font` - имя шрифта. Тип: строка. - `binding` - имя привязки. Тип: строка. -- `padding` - отступ между текстом и границами элемента. Тип: число. По-умолчанию: 6 +- `padding` - отступ между текстом и границами элемента. Тип: число. По умолчанию: 6 # Элементы инвентаря @@ -217,7 +217,7 @@ > Расположение инвентарей управляется движком и не может быть изменено свойствами pos, margin и т.д. > [!WARNING] -> Слоты без привязки к инвентарю не будут отображаться. Под приязкой к инвентарю понимается связь UI элемента inventory с инвентарём по id. Которая может быть явно создана через `inventory_ui.inventory = inventory_id`. [(см ui.md)](scripting/ui.md#инвентарь-inventory) +> Слоты без привязки к инвентарю не будут отображаться. Под привязкой к инвентарю понимается связь UI элемента inventory с инвентарём по id. Которая может быть явно создана через `inventory_ui.inventory = inventory_id`. [(см ui.md)](scripting/ui.md#инвентарь-inventory) ## Одиночный слот - *slot* diff --git a/doc/specs/binary_json_spec.md b/doc/specs/binary_json_spec.md index 4bed562e4..5d8e6ccfe 100644 --- a/doc/specs/binary_json_spec.md +++ b/doc/specs/binary_json_spec.md @@ -2,7 +2,7 @@ Format version: 1.1 -This binary data format is developed for use as binary version of JSON in [voxelcore](https://github.com/MihailRis/voxelcore) and not compatible with [BSON](https://bsonspec.org/spec.html) due to elements/entries syntax and type codes differences +This binary data format is developed for use as binary version of JSON in [voxelcore](https://github.com/MihailRis/voxelcore) and is not compatible with [BSON](https://bsonspec.org/spec.html) due to elements/entries syntax and type codes differences ## Basic types diff --git a/doc/specs/debugging_protocol.md b/doc/specs/debugging_protocol.md index fbf206f28..42e09762e 100644 --- a/doc/specs/debugging_protocol.md +++ b/doc/specs/debugging_protocol.md @@ -8,7 +8,7 @@ ### Step 1 -Connection initiating with binary header exchange: +Connection is initiated with binary header exchange: ``` 'v' 'c' '-' 'd' 'b' 'g' NUL XX