Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-22 11:56:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Various doc fixes.

Browse Source
This commit is contained in:
Relintai 2024-03-10 10:10:02 +01:00
parent 3f4cc73caa
commit 6f81a15fc0
5 changed files with 40 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/@GlobalScope.xml
View File

@ -1591,6 +1591,9 @@
<constant name="PROPERTY_USAGE_CATEGORY" value="256" enum="PropertyUsageFlags">
Used to categorize properties together in the editor.
</constant>
<constant name="PROPERTY_USAGE_ARRAY" value="512" enum="PropertyUsageFlags">
Used to categorize properties together in the editor as arrays.
</constant>
<constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048" enum="PropertyUsageFlags">
The property does not save its state in [PackedScene].
</constant>

12
modules/http_server_simple/doc_classes/WebServerSimple.xml
View File

@ -41,6 +41,14 @@
</member>
<member name="start_on_ready" type="bool" setter="set_start_on_ready" getter="get_start_on_ready" default="false">
</member>
<member name="upload_file_store_type" type="int" setter="upload_set_file_store_type" getter="upload_get_file_store_type" enum="WebServerSimple.FileUploadStoreType" default="0">
</member>
<member name="upload_request_max_file_size" type="int" setter="upload_set_request_max_file_size" getter="upload_get_request_max_file_size">
</member>
<member name="upload_request_max_file_size_type" type="int" setter="upload_set_request_max_file_size_type" getter="upload_get_request_max_file_size_type" enum="WebServerSimple.MaxRequestSizeTypes">
</member>
<member name="upload_temp_file_store_path" type="String" setter="upload_set_temp_file_store_path" getter="upload_get_temp_file_store_path">
</member>
<member name="use_poll_thread" type="bool" setter="set_use_poll_thread" getter="get_use_poll_thread" default="true">
</member>
<member name="use_ssl" type="bool" setter="set_use_ssl" getter="get_use_ssl" default="false">
@ -59,5 +67,9 @@
</constant>
<constant name="MAX_REQUEST_SIZE_TYPE_GIGA_BYTE" value="3" enum="MaxRequestSizeTypes">
</constant>
<constant name="FILE_UPLOAD_STORE_TYPE_MEMORY" value="0" enum="FileUploadStoreType">
</constant>
<constant name="FILE_UPLOAD_STORE_TYPE_TEMP_FILES" value="1" enum="FileUploadStoreType">
</constant>
</constants>
</class>

2
modules/web/doc_classes/ListWebPage.xml
View File

@ -49,7 +49,7 @@
<member name="max_visible_navigation_links" type="int" setter="set_max_visible_navigation_links" getter="get_max_visible_navigation_links" default="6">
This many pagination links will be visible max.
</member>
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="true">
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="false">
Whether to allow pagination or not.
</member>
<member name="placeholder_text" type="String" setter="set_placeholder_text" getter="get_placeholder_text" default="&quot;No content yet!&quot;">

16
modules/web/doc_classes/WebServerRequest.xml
View File

@ -316,10 +316,20 @@
Returns whether the active session has a csrf token or not.
</description>
</method>
<method name="parse_files">
<return type="void" />
<method name="is_file_moved" qualifiers="const">
<return type="bool" />
<argument index="0" name="index" type="int" />
<description>
Some WebSerber implementations might need a call to this in order to process files in multipart forms. Don't call it manually, these implementations need to call it when needed.
Returns whether a file contained in the request has been moved or not.
</description>
</method>
<method name="move_file">
<return type="int" enum="Error" />
<argument index="0" name="index" type="int" />
<argument index="1" name="dest_file" type="String" />
<argument index="2" name="force" type="bool" default="false" />
<description>
moves a file contained in the request to the specified destination. If the destionation file exists it will not be overwritten unless force is true.
</description>
</method>
<method name="parser_get_path">

13
modules/web/doc_classes/WebServerRequestScriptable.xml
View File

@ -117,8 +117,17 @@
<description>
</description>
</method>
<method name="_parse_files" qualifiers="virtual">
<return type="void" />
<method name="_is_file_moved" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="_move_file" qualifiers="virtual">
<return type="int" />
<argument index="0" name="index" type="int" />
<argument index="1" name="dest_file" type="String" />
<argument index="2" name="force" type="bool" />
<description>
</description>
</method>