update block.get_field, block.set_field and fields-related docs

This commit is contained in:
MihailRis
2024-10-02 17:56:19 +03:00
parent e0a4876f3f
commit 87cf6c41bc
6 changed files with 26 additions and 8 deletions
+3 -3
View File
@@ -168,6 +168,6 @@ Available data types:
| f64 | 8 bytes | floating-point 64 bits |
| char | 1 byte | character |
Currently, the total sum of the field sizes cannot exceed 240 bytes.
A character array can be used to store UTF-8 strings.
- Currently, the total sum of the field sizes cannot exceed 240 bytes.
- A field without an array length specification is equivalent to an array of 1 element.
- A character array can be used to store UTF-8 strings.
+4 -2
View File
@@ -138,6 +138,7 @@ The result will use the destination table instead of creating a new one if the o
```lua
-- writes a value to the specified block field
-- * throws an exception if the types are incompatible
-- * throws an exception when array is out of bounds
-- * does nothing if the block does not have the field
block.set_field(
x: int, y: int, z: int,
@@ -148,8 +149,9 @@ block.set_field(
-- returns the value written to the block field
-- * returns nil if:
-- 1. the field does not exist
-- 2. no writes were made to any block field
-- 1. the field does not exist
-- 2. no writes were made to any block field
-- * throws an exception when array is out of bounds
block.get_field(
x: int, y: int, z: int,
name: str,