summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/luascript
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2023-11-02 02:08:05 +1100
committer Vas Crabb <vas@vastheman.com>2023-11-02 02:08:05 +1100
commitfccbed7657675a5e1c4c63fff08c61ab24964be2 (patch)
treec904971b37825cab90948d9652f28b70c1a50694 /docs/source/luascript
parent4d56a317550c0fd2771976fb58385e294aa22c79 (diff)
Miscellaneous fixes:
* docs: Added option for Wayland support to compiling guide. * docs: Clarified behaviour of memory region read/write methods. * Fixed some editing errors in Turkish UI translation. * Added some parentheses on ternary conditional operators for clarity.
Diffstat (limited to 'docs/source/luascript')
-rw-r--r--docs/source/luascript/ref-mem.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/source/luascript/ref-mem.rst b/docs/source/luascript/ref-mem.rst
index 2222a785e24..24c16670c47 100644
--- a/docs/source/luascript/ref-mem.rst
+++ b/docs/source/luascript/ref-mem.rst
@@ -421,16 +421,20 @@ Methods
region:read_i{8,16,32,64}(offs)
Reads a signed integer value of the size in bits from the specified offset
- in the memory region.
+ in the memory region. The offset is specified in bytes. Reading beyond the
+ end of the memory region returns zero.
region:read_u{8,16,32,64}(offs)
Reads an unsigned integer value of the size in bits from the specified
- offset in the memory region.
+ offset in the memory region. The offset is specified in bytes. Reading
+ beyond the end of the memory region returns zero.
region:write_i{8,16,32,64}(offs, val)
Writes a signed integer value of the size in bits to the specified offset in
- the memory region.
+ the memory region. The offset is specified in bytes. Attempting to write
+ beyond the end of the memory region has no effect.
region:write_u{8,16,32,64}(offs, val)
Writes an unsigned integer value of the size in bits to the specified offset
- in the memory region.
+ in the memory region. The offset is specified in bytes. Attempting to
+ write beyond the end of the memory region has no effect.
Properties
~~~~~~~~~~