northern-lighthouse/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Make all module docs self-contained

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-15 19:23:20 +01:00
parent e7701bb2de
commit 677e95d8d1
84 changed files with 142 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
modules/visual_script/doc_classes/VisualScriptClassConstant.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0-alpha">
<brief_description>
Gets a constant from a given class.
</brief_description>
<description>
This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants.
[b]Input Ports:[/b]
none
[b]Output Ports:[/b]
- Data (variant): [code]value[/code]
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_base_type">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_class_constant">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_base_type">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_class_constant">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">
The constant's parent class.
</member>
<member name="constant" type="String" setter="set_class_constant" getter="get_class_constant">
The constant to return. See the given class for its available constants.
</member>
</members>
<constants>
</constants>
</class>