pandemonium_engine/modules/web/doc_classes/StaticWebPageFolderFiles.xml

37 lines
1.2 KiB
XML
Raw Normal View History

2022-08-21 00:40:49 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-06-13 17:34:41 +02:00
<class name="StaticWebPageFolderFiles" inherits="StaticWebPage" version="3.12">
2022-08-21 00:40:49 +02:00
<brief_description>
2022-12-22 19:51:25 +01:00
A [StaticWebPage] that loads all files from the given folder to [StaticWebPage]'s [code]data[/code] property when entering the [SceneTree].
2022-08-21 00:40:49 +02:00
</brief_description>
<description>
2022-12-22 19:51:25 +01:00
A [StaticWebPage] that loads all files from the given folder to [StaticWebPage]'s [code]data[/code] property when entering the [SceneTree].
2022-08-21 00:40:49 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="append_data">
<return type="void" />
<argument index="0" name="val" type="String" />
<description>
Appends to [StaticWebPage]'s [code]data[/code] property.
2022-08-21 00:40:49 +02:00
</description>
</method>
<method name="load">
<return type="void" />
<description>
Load the files manually.
2022-08-21 00:40:49 +02:00
</description>
</method>
</methods>
<members>
<member name="dir_path" type="String" setter="set_dir_path" getter="get_dir_path" default="&quot;&quot;">
The path to the files.
2022-08-21 00:40:49 +02:00
</member>
<member name="process_if_can" type="bool" setter="set_process_if_can" getter="get_process_if_can" default="true">
Whenther to try to process the files. (Renders markdown.)
2022-08-21 00:40:49 +02:00
</member>
</members>
<constants>
</constants>
</class>