Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 21:31:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2024-12-10 23:00:02 +01:00
parent 323016fcbe
commit a52e1f168a
12 changed files with 166 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/Basis.xml
View File

@ -221,27 +221,18 @@
<description>
</description>
</method>
<method name="make_scale_uniform">
<description>
</description>
</method>
<method name="looking_at">
<return type="Basis" />
<argument index="0" name="target" type="Vector3" />
<argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
<argument index="1" name="up" type="Vector3" default="Vector3( 0, 1, 0 )" />
<argument index="2" name="use_model_front" type="bool" default="false" />
<description>
Creates a Basis with a rotation such that the forward axis (-Z) points towards the [param target] position.
The up axis (+Y) points as close to the [param up] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [param target] and [param up] vectors cannot be zero, and cannot be parallel to each other.
</description>
</method>
<method name="set_look_at">
<argument index="0" name="target" type="Vector3" />
<argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
<argument index="2" name="use_model_front" type="bool" default="false" />
<method name="make_scale_uniform">
<description>
Sets this Basis with a rotation such that the forward axis (-Z) points towards the [param target] position.
The up axis (+Y) points as close to the [param up] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [param target] and [param up] vectors cannot be zero, and cannot be parallel to each other.
</description>
</method>
<method name="orthogonalize">
@ -413,6 +404,15 @@
<description>
</description>
</method>
<method name="set_look_at">
<argument index="0" name="target" type="Vector3" />
<argument index="1" name="up" type="Vector3" default="Vector3( 0, 1, 0 )" />
<argument index="2" name="use_model_front" type="bool" default="false" />
<description>
Sets this Basis with a rotation such that the forward axis (-Z) points towards the [param target] position.
The up axis (+Y) points as close to the [param up] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [param target] and [param up] vectors cannot be zero, and cannot be parallel to each other.
</description>
</method>
<method name="set_orthogonal_index">
<argument index="0" name="index" type="int" />
<description>

5
doc/classes/EditorImportPlugin.xml
View File

@ -143,6 +143,11 @@
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
</description>
</method>
<method name="use_on_initial_import" qualifiers="virtual">
<return type="bool" />
<description>
</description>
</method>
</methods>
<constants>
</constants>

28
doc/classes/LoggerBackend.xml
View File

@ -7,12 +7,26 @@
<tutorials>
</tutorials>
<methods>
<method name="_log_custom" qualifiers="virtual">
<return type="void" />
<argument index="0" name="category" type="StringName" />
<argument index="1" name="level" type="int" />
<argument index="2" name="str" type="String" />
<description>
</description>
</method>
<method name="_log_error" qualifiers="virtual">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="_log_important" qualifiers="virtual">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="_log_message" qualifiers="virtual">
<return type="void" />
<argument index="0" name="str" type="String" />
@ -31,12 +45,26 @@
<description>
</description>
</method>
<method name="log_custom">
<return type="void" />
<argument index="0" name="category" type="StringName" />
<argument index="1" name="level" type="int" />
<argument index="2" name="str" type="String" />
<description>
</description>
</method>
<method name="log_error">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="log_important">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="log_message">
<return type="void" />
<argument index="0" name="str" type="String" />

18
doc/classes/PLogger.xml
View File

@ -7,12 +7,26 @@
<tutorials>
</tutorials>
<methods>
<method name="log_custom">
<return type="void" />
<argument index="0" name="category" type="StringName" />
<argument index="1" name="level" type="int" />
<argument index="2" name="str" type="String" />
<description>
</description>
</method>
<method name="log_error">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="log_important">
<return type="void" />
<argument index="0" name="str" type="String" />
<description>
</description>
</method>
<method name="log_message">
<return type="void" />
<argument index="0" name="str" type="String" />
@ -47,7 +61,9 @@
</constant>
<constant name="LOG_LEVEL_ERROR" value="3" enum="LogLevel">
</constant>
<constant name="LOG_LEVEL_NONE" value="4" enum="LogLevel">
<constant name="LOG_LEVEL_IMPORTANT" value="4" enum="LogLevel">
</constant>
<constant name="LOG_LEVEL_NONE" value="5" enum="LogLevel">
</constant>
</constants>
</class>

4
doc/classes/Spatial.xml
View File

@ -125,7 +125,7 @@
<method name="look_at">
<return type="void" />
<argument index="0" name="target" type="Vector3" />
<argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
<argument index="1" name="up" type="Vector3" default="Vector3( 0, 1, 0 )" />
<argument index="2" name="use_model_front" type="bool" default="false" />
<description>
Rotates the node so that the local forward axis (-Z, [constant Vector3.FORWARD]) points toward the [code]target[/code] position. If the [param use_model_front] options is specified, then the model is oriented in reverse, towards the model front axis (+Z, [constant Vector3.MODEL_FRONT]), which is more useful for orienting 3D models.
@ -138,7 +138,7 @@
<return type="void" />
<argument index="0" name="position" type="Vector3" />
<argument index="1" name="target" type="Vector3" />
<argument index="2" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
<argument index="2" name="up" type="Vector3" default="Vector3( 0, 1, 0 )" />
<argument index="3" name="use_model_front" type="bool" default="false" />
<description>
Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space.

1
doc/classes/Transform.xml
View File

@ -211,6 +211,7 @@
<argument index="0" name="eye" type="Vector3" />
<argument index="1" name="target" type="Vector3" />
<argument index="2" name="up" type="Vector3" />
<argument index="3" name="use_model_front" type="bool" default="false" />
<description>
</description>
</method>

12
doc/classes/Vector3.xml
View File

@ -394,22 +394,22 @@
<constant name="BACK" value="Vector3( 0, 0, 1 )">
Back unit vector. Represents the local direction of back, and the global direction of south.
</constant>
<constant name="MODEL_LEFT" value="Vector3(1, 0, 0)">
<constant name="MODEL_LEFT" value="Vector3( 1, 0, 0 )">
Unit vector pointing towards the left side of imported 3D assets.
</constant>
<constant name="MODEL_RIGHT" value="Vector3(-1, 0, 0)">
<constant name="MODEL_RIGHT" value="Vector3( -1, 0, 0 )">
Unit vector pointing towards the right side of imported 3D assets.
</constant>
<constant name="MODEL_TOP" value="Vector3(0, 1, 0)">
<constant name="MODEL_TOP" value="Vector3( 0, 1, 0 )">
Unit vector pointing towards the top side (up) of imported 3D assets.
</constant>
<constant name="MODEL_BOTTOM" value="Vector3(0, -1, 0)">
<constant name="MODEL_BOTTOM" value="Vector3( 0, -1, 0 )">
Unit vector pointing towards the bottom side (down) of imported 3D assets.
</constant>
<constant name="MODEL_FRONT" value="Vector3(0, 0, 1)">
<constant name="MODEL_FRONT" value="Vector3( 0, 0, 1 )">
Unit vector pointing towards the front side (facing forward) of imported 3D assets.
</constant>
<constant name="MODEL_REAR" value="Vector3(0, 0, -1)">
<constant name="MODEL_REAR" value="Vector3( 0, 0, -1 )">
Unit vector pointing towards the rear side (back) of imported 3D assets.
</constant>
</constants>

5
modules/users/doc_classes/UserDB.xml
View File

@ -12,6 +12,11 @@
<description>
</description>
</method>
<method name="get_all_users">
<return type="Array" />
<description>
</description>
</method>
<method name="get_user">
<return type="User" />
<argument index="0" name="id" type="int" />

10
modules/users/doc_classes/UserManager.xml
View File

@ -12,6 +12,11 @@
<description>
</description>
</method>
<method name="_get_all_users" qualifiers="virtual">
<return type="Array" />
<description>
</description>
</method>
<method name="_get_user" qualifiers="virtual">
<return type="User" />
<argument index="0" name="id" type="int" />
@ -53,6 +58,11 @@
<description>
</description>
</method>
<method name="get_all_users">
<return type="Array" />
<description>
</description>
</method>
<method name="get_user">
<return type="User" />
<argument index="0" name="id" type="int" />

37
modules/web/doc_classes/HTMLTemplateMultilang.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HTMLTemplateMultilang" inherits="HTMLTemplate">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_locales" qualifiers="const">
<return type="Dictionary" />
<description>
</description>
</method>
<method name="get_template_for_locale">
<return type="HTMLTemplate" />
<argument index="0" name="locale" type="StringName" />
<description>
</description>
</method>
<method name="set_locales">
<return type="void" />
<argument index="0" name="locales" type="Dictionary" />
<description>
</description>
</method>
<method name="set_template_for_locale">
<return type="void" />
<argument index="0" name="locale" type="StringName" />
<argument index="1" name="template" type="HTMLTemplate" />
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

13
modules/web/doc_classes/LocaleSetupWebServerMiddleware.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="LocaleSetupWebServerMiddleware" inherits="WebServerMiddleware">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

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

@ -36,6 +36,11 @@
Returns true if the active [WebPermission] has view permission for this session. It you don't have a [WebPermission] set, all perissions are enabled for every user.
</description>
</method>
<method name="clear_locale_from_cookie">
<return type="void" />
<description>
</description>
</method>
<method name="compile_and_send_body">
<return type="void" />
<description>
@ -172,6 +177,11 @@
Returns the host which was present in the request header.
</description>
</method>
<method name="get_locale" qualifiers="const">
<return type="StringName" />
<description>
</description>
</method>
<method name="get_method" qualifiers="const">
<return type="int" enum="HTTPServerEnums.HTTPMethod" />
<description>
@ -316,6 +326,11 @@
Returns whether the active session has a csrf token or not.
</description>
</method>
<method name="has_locale" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="is_file_moved" qualifiers="const">
<return type="bool" />
<argument index="0" name="index" type="int" />
@ -323,6 +338,11 @@
Returns whether a file contained in the request has been moved or not.
</description>
</method>
<method name="load_locale_from_cookie">
<return type="void" />
<description>
</description>
</method>
<method name="move_file">
<return type="int" enum="Error" />
<argument index="0" name="index" type="int" />
@ -384,6 +404,11 @@
Helper method that adds a [WebServerCookie], which will ask client to delete the cookie denoted by [code]key[/code] after being sent.
</description>
</method>
<method name="save_locale_as_cookie">
<return type="void" />
<description>
</description>
</method>
<method name="send">
<return type="void" />
<description>
@ -433,6 +458,12 @@
<description>
</description>
</method>
<method name="set_locale">
<return type="void" />
<argument index="0" name="locale" type="StringName" />
<description>
</description>
</method>
<method name="set_post_parameter">
<return type="void" />
<argument index="0" name="key" type="String" />