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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2020-05-15 18:24:38 +02:00
parent 3a6d9a41bb
commit 2800c8f43d
4 changed files with 46 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/@GlobalScope.xml
View file

@ -1063,10 +1063,10 @@
<constant name="JOY_XBOX_RB" value="10" enum="JoyButtonList">
Xbox game controller right bumper button maps to SDL right shoulder button.
</constant>
<constant name="JOY_BUTTON_MAX" value="36" enum="JoyAxisList">
<constant name="JOY_BUTTON_MAX" value="36" enum="JoyButtonList">
The maximum number of game controller buttons.
</constant>
<constant name="JOY_INVALID_BUTTON" value="-1" enum="JoyButtonList">
<constant name="JOY_INVALID_AXIS" value="-1" enum="JoyAxisList">
An invalid game controller axis.
</constant>
<constant name="JOY_AXIS_LEFT_X" value="0" enum="JoyAxisList">

31
doc/classes/ImageTextureLayered.xml Normal file
View file

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ImageTextureLayered" inherits="TextureLayered" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="create_from_images">
<return type="int" enum="Error">
</return>
<argument index="0" name="images" type="Array">
</argument>
<description>
</description>
</method>
<method name="update_layer">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<argument index="1" name="layer" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

13
doc/classes/Lightmapper.xml Normal file
View file

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

24
doc/classes/ProjectSettings.xml
View file

@ -844,30 +844,6 @@
<member name="network/limits/webrtc/max_channel_in_buffer_kb" type="int" setter="" getter="" default="64">
Maximum size (in kiB) for the [WebRTCDataChannel] input buffer.
</member>
<member name="network/limits/websocket_client/max_in_buffer_kb" type="int" setter="" getter="" default="64">
Maximum size (in kiB) for the [WebSocketClient] input buffer.
</member>
<member name="network/limits/websocket_client/max_in_packets" type="int" setter="" getter="" default="1024">
Maximum number of concurrent input packets for [WebSocketClient].
</member>
<member name="network/limits/websocket_client/max_out_buffer_kb" type="int" setter="" getter="" default="64">
Maximum size (in kiB) for the [WebSocketClient] output buffer.
</member>
<member name="network/limits/websocket_client/max_out_packets" type="int" setter="" getter="" default="1024">
Maximum number of concurrent output packets for [WebSocketClient].
</member>
<member name="network/limits/websocket_server/max_in_buffer_kb" type="int" setter="" getter="" default="64">
Maximum size (in kiB) for the [WebSocketServer] input buffer.
</member>
<member name="network/limits/websocket_server/max_in_packets" type="int" setter="" getter="" default="1024">
Maximum number of concurrent input packets for [WebSocketServer].
</member>
<member name="network/limits/websocket_server/max_out_buffer_kb" type="int" setter="" getter="" default="64">
Maximum size (in kiB) for the [WebSocketServer] output buffer.
</member>
<member name="network/limits/websocket_server/max_out_packets" type="int" setter="" getter="" default="1024">
Maximum number of concurrent output packets for [WebSocketServer].
</member>
<member name="network/remote_fs/page_read_ahead" type="int" setter="" getter="" default="4">
Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage.
</member>