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

classref: Sync with current source

Browse source
This commit is contained in:
Rémi Verschelde 2016-08-10 21:28:01 +02:00
parent 676b60a8b5
commit 720305d98e
1 changed files with 99 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

134
doc/base/classes.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<doc version="2.1.beta.custom_build" name="Engine Types">
<doc version="2.1.stable.custom_build" name="Engine Types">
<class name="@GDScript" category="Core">
<brief_description>
Built-in GDScript functions.
@ -653,7 +653,7 @@
</description>
</method>
<method name="yield">
<return type="Nil">
<return type="GDFunctionState">
</return>
<argument index="0" name="object" type="Object">
</argument>
@ -6016,7 +6016,7 @@
</argument>
<argument index="2" name="rect" type="Rect2">
</argument>
<argument index="3" name="align" type="Vector2" default="Vector2(0,0)">
<argument index="3" name="align" type="Vector2" default="Vector2((0, 0))">
</argument>
<argument index="4" name="advance" type="float" default="-1">
</argument>
@ -8038,7 +8038,7 @@
<method name="add_shape">
<argument index="0" name="shape" type="Shape2D">
</argument>
<argument index="1" name="transform" type="Matrix32" default="1,0, 0,1, 0,0">
<argument index="1" name="transform" type="Matrix32" default="((1, 0), (0, 1), (0, 0))">
</argument>
<description>
Add a [Shape2D] to the collision body, with a given custom transform.
@ -9308,7 +9308,7 @@
<method name="get_cursor_shape" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="pos" type="Vector2" default="Vector2(0,0)">
<argument index="0" name="pos" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Return the cursor shape at a certain position in the control.
@ -9507,7 +9507,7 @@
<method name="get_tooltip" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="atpos" type="Vector2" default="Vector2(0,0)">
<argument index="0" name="atpos" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Return the tooltip, which will appear when the cursor is resting over this control.
@ -10151,9 +10151,9 @@
<method name="add_point">
<argument index="0" name="pos" type="Vector2">
</argument>
<argument index="1" name="in" type="Vector2" default="Vector2(0,0)">
<argument index="1" name="in" type="Vector2" default="Vector2((0, 0))">
</argument>
<argument index="2" name="out" type="Vector2" default="Vector2(0,0)">
<argument index="2" name="out" type="Vector2" default="Vector2((0, 0))">
</argument>
<argument index="3" name="atpos" type="int" default="-1">
</argument>
@ -10322,9 +10322,9 @@
<method name="add_point">
<argument index="0" name="pos" type="Vector3">
</argument>
<argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)">
<argument index="1" name="in" type="Vector3" default="Vector3((0, 0, 0))">
</argument>
<argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)">
<argument index="2" name="out" type="Vector3" default="Vector3((0, 0, 0))">
</argument>
<argument index="3" name="atpos" type="int" default="-1">
</argument>
@ -10937,6 +10937,26 @@
<description>
</description>
</method>
<method name="get_spacing" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="type" type="int">
</argument>
<description>
</description>
</method>
<method name="get_use_filter" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="get_use_mipmaps" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="remove_fallback">
<argument index="0" name="idx" type="int">
</argument>
@ -10963,8 +10983,36 @@
<description>
</description>
</method>
<method name="set_spacing">
<argument index="0" name="type" type="int">
</argument>
<argument index="1" name="value" type="int">
</argument>
<description>
</description>
</method>
<method name="set_use_filter">
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_use_mipmaps">
<argument index="0" name="enable" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<constants>
<constant name="SPACING_TOP" value="0">
</constant>
<constant name="SPACING_BOTTOM" value="1">
</constant>
<constant name="SPACING_CHAR" value="2">
</constant>
<constant name="SPACING_SPACE" value="3">
</constant>
</constants>
</class>
<class name="DynamicFontData" inherits="Resource" category="Core">
@ -11285,6 +11333,8 @@
</description>
<methods>
<method name="add_control_to_bottom_panel">
<return type="ToolButton">
</return>
<argument index="0" name="control" type="Control">
</argument>
<argument index="1" name="title" type="String">
@ -12657,6 +12707,12 @@
Get the current selected path (directory and file) of the file dialog (empty if none).
</description>
</method>
<method name="get_filters" qualifiers="const">
<return type="StringArray">
</return>
<description>
</description>
</method>
<method name="get_mode" qualifiers="const">
<return type="int">
</return>
@ -12711,6 +12767,12 @@
Set the current selected file path of the file dialog.
</description>
</method>
<method name="set_filters">
<argument index="0" name="filters" type="StringArray">
</argument>
<description>
</description>
</method>
<method name="set_mode">
<argument index="0" name="mode" type="int">
</argument>
@ -15708,14 +15770,10 @@
</class>
<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core">
<brief_description>
Node to draw simple geometry from code, ala OpenGL 1.x
Node to draw simple geometry from code, ala OpenGL 1.x
</brief_description>
<description>
</description>
ImmediateGeometry is a node used for displaying simple geometry created from code, very similar to how glBegin() and glEnd() worked in old versions of OpenGL (1.x).
Simply call [method begin()], and add vertices. For custom vertex colors, uvs, normal, etc. call one of the set_ functions below before adding each vertex. When done, call [method end]
Calls to begin/end are accumulative and all geometry is added together. To clear all the geometry, call [method clear].
If a material override is set, and this material contains a texture, it's possible to override the texture used in this material for every begin/end set of calls.
<methods>
<method name="add_sphere">
<argument index="0" name="lats" type="int">
@ -15725,69 +15783,69 @@
<argument index="2" name="radius" type="float">
</argument>
<description>
Simple helper to draw an uvsphere, with given latitudes, longitude and radius.
Simple helper to draw an uvsphere, with given latitudes, longitude and radius.
</description>
</method>
<method name="add_vertex">
<argument index="0" name="pos" type="Vector3">
</argument>
<description>
Add a vertex with the currently set color/uv/etc.
Add a vertex with the currently set color/uv/etc.
</description>
</method>
<method name="begin">
<argument index="0" name="primitive" type="int">
</argument>
<argument index="1" name="texture" type="Texture">
<argument index="1" name="texture" type="Texture" default="Object()">
</argument>
<description>
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references.
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references.
For the type of primitive, use the [Mesh].PRIMITIVE_* enumerations.
</description>
</method>
<method name="clear">
<description>
Clear everything that was drawn using begin/end.
Clear everything that was drawn using begin/end.
</description>
</method>
<method name="end">
<description>
Call this when done adding a batch of geometry, otherwise it can't be displayed.
Call this when done adding a batch of geometry, otherwise it can't be displayed.
</description>
</method>
<method name="set_color">
<argument index="0" name="color" type="Color">
</argument>
<description>
Set the color that the next vertex will use to be drawn.
Set the color that the next vertex will use to be drawn.
</description>
</method>
<method name="set_normal">
<argument index="0" name="normal" type="Vector3">
</argument>
<description>
Set the normal that the next vertex will use to be drawn.
Set the normal that the next vertex will use to be drawn.
</description>
</method>
<method name="set_tangent">
<argument index="0" name="tangent" type="Plane">
</argument>
<description>
Set the tangent (and binormal facing) that the next vertex will use to be drawn.
Set the tangent (and binormal facing) that the next vertex will use to be drawn.
</description>
</method>
<method name="set_uv">
<argument index="0" name="uv" type="Vector2">
</argument>
<description>
Set the UV that the next vertex will use to be drawn.
Set the UV that the next vertex will use to be drawn.
</description>
</method>
<method name="set_uv2">
<argument index="0" name="uv" type="Vector2">
</argument>
<description>
Set the second layer of UV that the next vertex will use to be drawn.
Set the second layer of UV that the next vertex will use to be drawn.
</description>
</method>
</methods>
@ -15978,7 +16036,7 @@
<method name="set_custom_mouse_cursor">
<argument index="0" name="image" type="Texture">
</argument>
<argument index="1" name="hotspot" type="Vector2" default="Vector2(0,0)">
<argument index="1" name="hotspot" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified.
@ -22954,7 +23012,7 @@
</method>
<method name="request_attention">
<description>
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
</description>
</method>
<method name="set_borderless_window">
@ -23114,7 +23172,7 @@
</description>
</method>
<method name="show_virtual_keyboard">
<argument index="0" name="existing_text" type="String">
<argument index="0" name="existing_text" type="String" default="&quot;&quot;">
</argument>
<description>
Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
@ -25943,7 +26001,7 @@
</argument>
<argument index="1" name="shape" type="RID">
</argument>
<argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0">
<argument index="2" name="transform" type="Matrix32" default="((1, 0), (0, 1), (0, 0))">
</argument>
<description>
Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
@ -26176,7 +26234,7 @@
</argument>
<argument index="1" name="shape" type="RID">
</argument>
<argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0">
<argument index="2" name="transform" type="Matrix32" default="((1, 0), (0, 1), (0, 0))">
</argument>
<description>
Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
@ -29478,14 +29536,14 @@
</description>
</method>
<method name="popup_centered">
<argument index="0" name="size" type="Vector2" default="Vector2(0,0)">
<argument index="0" name="size" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size".
</description>
</method>
<method name="popup_centered_minsize">
<argument index="0" name="minsize" type="Vector2" default="Vector2(0,0)">
<argument index="0" name="minsize" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code].
@ -38809,6 +38867,12 @@
<description>
</description>
</method>
<method name="add_index">
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="add_normal">
<argument index="0" name="normal" type="Vector3">
</argument>
@ -44481,9 +44545,9 @@
<method name="set_size_override">
<argument index="0" name="enable" type="bool">
</argument>
<argument index="1" name="size" type="Vector2" default="Vector2(-1,-1)">
<argument index="1" name="size" type="Vector2" default="Vector2((-1, -1))">
</argument>
<argument index="2" name="margin" type="Vector2" default="Vector2(0,0)">
<argument index="2" name="margin" type="Vector2" default="Vector2((0, 0))">
</argument>
<description>
Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size.