packed*arrays are pass by ref now. support duplicate and update documentation

This commit is contained in:
Jordan Schidlowsky
2020-12-17 14:26:05 -06:00
committed by Jordan Schidlowsky
parent 2c0d1c3b91
commit 2d56e09276
12 changed files with 94 additions and 9 deletions

View File

@@ -5,7 +5,6 @@
</brief_description>
<description>
An [Array] specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
@@ -86,6 +85,13 @@
GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via [code]max_output_size[/code]. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned.
</description>
</method>
<method name="duplicate">
<return type="PackedByteArray">
</return>
<description>
Creates a copy of the array, and returns it.
</description>
</method>
<method name="empty">
<return type="bool">
</return>