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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2020-07-03 16:09:12 +02:00
parent 49feec7dc0
commit 96644d23a0
6 changed files with 19 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/EditorTranslationParserPlugin.xml
View file

@ -19,7 +19,7 @@
func get_recognized_extensions():
return ["csv"]
[/codeblock]
[/codeblock]
</description>
<tutorials>
</tutorials>

3
doc/classes/ProjectSettings.xml
View file

@ -256,6 +256,9 @@
<member name="audio/output_latency" type="int" setter="" getter="" default="15">
Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware.
</member>
<member name="audio/output_latency.web" type="int" setter="" getter="" default="50">
Safer override for [member audio/output_latency] in the Web platform, to avoid audio issues especially on mobile devices.
</member>
<member name="audio/video_delay_compensation_ms" type="int" setter="" getter="" default="0">
Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing.
</member>

2
doc/classes/RayCast2D.xml
View file

@ -135,7 +135,7 @@
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
</member>
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="false">
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
If [code]true[/code], collisions will be reported.
</member>
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true">

2
doc/classes/RayCast3D.xml
View file

@ -138,7 +138,7 @@
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
</member>
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="false">
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
If [code]true[/code], collisions will be reported.
</member>
<member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true">

4
doc/classes/Window.xml
View file

@ -377,9 +377,9 @@
</constant>
<constant name="CONTENT_SCALE_MODE_DISABLED" value="0" enum="ContentScaleMode">
</constant>
<constant name="CONTENT_SCALE_MODE_OBJECTS" value="1" enum="ContentScaleMode">
<constant name="CONTENT_SCALE_MODE_CANVAS_ITEMS" value="1" enum="ContentScaleMode">
</constant>
<constant name="CONTENT_SCALE_MODE_PIXELS" value="2" enum="ContentScaleMode">
<constant name="CONTENT_SCALE_MODE_VIEWPORT" value="2" enum="ContentScaleMode">
</constant>
<constant name="CONTENT_SCALE_ASPECT_IGNORE" value="0" enum="ContentScaleAspect">
</constant>

38
modules/gridmap/doc_classes/GridMap.xml
View file

@ -43,27 +43,19 @@
<method name="get_cell_item" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<description>
The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
</description>
</method>
<method name="get_cell_item_orientation" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<description>
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.
The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty.
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
@ -111,11 +103,7 @@
<method name="map_to_world" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="x" type="int">
</argument>
<argument index="1" name="y" type="int">
</argument>
<argument index="2" name="z" type="int">
<argument index="0" name="map_position" type="Vector3i">
</argument>
<description>
Returns the position of a grid cell in the GridMap's local coordinate space.
@ -132,18 +120,14 @@
<method name="set_cell_item">
<return type="void">
</return>
<argument index="0" name="x" type="int">
<argument index="0" name="position" type="Vector3i">
</argument>
<argument index="1" name="y" type="int">
<argument index="1" name="item" type="int">
</argument>
<argument index="2" name="z" type="int">
</argument>
<argument index="3" name="item" type="int">
</argument>
<argument index="4" name="orientation" type="int" default="0">
<argument index="2" name="orientation" type="int" default="0">
</argument>
<description>
Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
Sets the mesh index for the cell referenced by its grid coordinates.
A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
Optionally, the item's orientation can be passed. For valid orientation values, see [method Basis.get_orthogonal_index].
</description>
@ -185,9 +169,9 @@
</description>
</method>
<method name="world_to_map" qualifiers="const">
<return type="Vector3">
<return type="Vector3i">
</return>
<argument index="0" name="pos" type="Vector3">
<argument index="0" name="world_position" type="Vector3">
</argument>
<description>
Returns the coordinates of the grid cell containing the given point.