summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorYilin Ma <yilinma3@illinois.edu>2020-07-13 11:22:06 -0500
committerYilin Ma <yilinma3@illinois.edu>2020-09-02 17:57:01 -0500
commitc524d50444f98039faab75f7d701ca54a82e5848 (patch)
tree4fb8b3a8b707ce434f4ca199b7e119ad275f7577 /doc/classes
parentb55d859c5f092d145cd0d2c8df9ac5d42c500626 (diff)
added load resource pack with offset feature
updated variables to use size_t removed line break to make code style more consistent added conditional check to return an error if offset field is used when loading a ZIP package fixed typo formatted file added commit regarding self contained exe files handled error loging for load zip file with offset spelling tweak updated conditional statement for magic check udpated error message when load Zip file with offset is called fix CI Trying to fix CI fix CI done Added error message for loading self-contained exe with offset. Updated documentation. Fix indent final fix indent Updated documentation. fix indents Updated doc based on suggestion Final fix fixed format
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/ProjectSettings.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 7191492098..af6105dab6 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -92,9 +92,12 @@
</argument>
<argument index="1" name="replace_files" type="bool" default="true">
</argument>
+ <argument index="2" name="offset" type="int" default="0">
+ </argument>
<description>
Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success.
[b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code] unless [code]replace_files[/code] is set to [code]false[/code].
+ [b]Note:[/b] The optional [code]offset[/code] parameter can be used to specify the offset in bytes to the start of the resource pack. This is only supported for .pck files.
</description>
</method>
<method name="localize_path" qualifiers="const">