asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Complete documentation of some more classes

Browse source
This commit is contained in:
Tomasz Chabora 2020-01-13 23:08:42 +01:00
parent 34ad33d9e0
commit c09b9c488f
10 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/BaseButton.xml
View file

@ -112,6 +112,7 @@
The state of buttons are disabled.
</constant>
<constant name="DRAW_HOVER_PRESSED" value="4" enum="DrawMode">
The state of buttons are both hovered and pressed.
</constant>
<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
Require just a press to consider the button clicked.

2
doc/classes/CollisionObject2D.xml
View file

@ -44,6 +44,7 @@
<argument index="0" name="owner_id" type="int">
</argument>
<description>
Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code].
</description>
</method>
<method name="get_shape_owners">
@ -199,6 +200,7 @@
<argument index="1" name="margin" type="float">
</argument>
<description>
Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels.
</description>
</method>
<method name="shape_owner_set_transform">

2
doc/classes/ColorPickerButton.xml
View file

@ -43,10 +43,12 @@
</signal>
<signal name="picker_created">
<description>
Emitted when the [ColorPicker] is created (the button is pressed for the first time).
</description>
</signal>
<signal name="popup_closed">
<description>
Emitted when the [ColorPicker] is closed.
</description>
</signal>
</signals>

1
doc/classes/MainLoop.xml
View file

@ -69,6 +69,7 @@
<argument index="1" name="meta" type="Variant">
</argument>
<description>
Called when the user performs an action in the system global menu (e.g. the Mac OS menu bar).
</description>
</method>
<method name="_idle" qualifiers="virtual">

2
doc/classes/NinePatchRect.xml
View file

@ -15,6 +15,7 @@
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Returns the size of the margin identified by the given [enum Margin] constant.
</description>
</method>
<method name="set_patch_margin">
@ -25,6 +26,7 @@
<argument index="1" name="value" type="int">
</argument>
<description>
Sets the size of the margin identified by the given [enum Margin] constant to [code]value[/code] in pixels.
</description>
</method>
</methods>

5
doc/classes/PoolByteArray.xml
View file

@ -78,6 +78,11 @@
<return type="String">
</return>
<description>
Returns a hexadecimal representation of this array as a [String].
[codeblock]
var array = PoolByteArray([11, 46, 255])
print(array.hex_encode()) # Prints: 0b2eff
[/codeblock]
</description>
</method>
<method name="insert">

2
doc/classes/ShaderMaterial.xml
View file

@ -25,6 +25,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value.
</description>
</method>
<method name="property_get_revert">
@ -33,6 +34,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the default value of the material property with given [code]name[/code].
</description>
</method>
<method name="set_shader_param">

1
doc/classes/SpriteFrames.xml
View file

@ -170,6 +170,7 @@
</methods>
<members>
<member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
Compatibility property, always equals to an empty array.
</member>
</members>
<constants>

8
doc/classes/StyleBox.xml
View file

@ -17,18 +17,22 @@
<argument index="1" name="rect" type="Rect2">
</argument>
<description>
Draws this stylebox using a [CanvasItem] with given [RID].
You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node.
</description>
</method>
<method name="get_center_size" qualifiers="const">
<return type="Vector2">
</return>
<description>
Returns the size of this [StyleBox] without the margins.
</description>
</method>
<method name="get_current_item_drawn" qualifiers="const">
<return type="CanvasItem">
</return>
<description>
Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment.
</description>
</method>
<method name="get_default_margin" qualifiers="const">
@ -37,6 +41,7 @@
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Returns the default value of the specified [enum Margin].
</description>
</method>
<method name="get_margin" qualifiers="const">
@ -45,7 +50,7 @@
<argument index="0" name="margin" type="int" enum="Margin">
</argument>
<description>
Returns the content margin offset for the specified margin.
Returns the content margin offset for the specified [enum Margin].
Positive values reduce size inwards, unlike [Control]'s margin values.
</description>
</method>
@ -71,6 +76,7 @@
<argument index="1" name="offset" type="float">
</argument>
<description>
Sets the default value of the specified [enum Margin] to given [code]offset[/code] in pixels.
</description>
</method>
<method name="test_mask" qualifiers="const">

3
doc/classes/Thread.xml
View file

@ -50,10 +50,13 @@
</methods>
<constants>
<constant name="PRIORITY_LOW" value="0" enum="Priority">
A thread running with lower priority than normally.
</constant>
<constant name="PRIORITY_NORMAL" value="1" enum="Priority">
A thread with a standard priority.
</constant>
<constant name="PRIORITY_HIGH" value="2" enum="Priority">
A thread running with higher priority than normally.
</constant>
</constants>
</class>