diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 1844 |
1 files changed, 1807 insertions, 37 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7b7430ec13..9400d7de03 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<doc version="2.1.beta.custom_build" name="Engine Types"> +<doc version="2.2.alpha.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> @@ -1945,6 +1945,16 @@ </constant> </constants> </class> +<class name="@VisualScript" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> <class name="AABB" category="Built-In Types"> <brief_description> Axis-Aligned Bounding Box. @@ -6016,7 +6026,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 +8048,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 +9318,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 +9517,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 +10161,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 +10332,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 +10947,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 +10993,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 +11343,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"> @@ -11445,6 +11505,13 @@ Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. </description> </method> + <method name="get_window_layout" qualifiers="virtual"> + <argument index="0" name="layout" type="ConfigFile"> + </argument> + <description> + Get the GUI layout of the plugin. This is used to save the project's editor layout when the [method EditorPlugin.queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). + </description> + </method> <method name="handles" qualifiers="virtual"> <return type="bool"> </return> @@ -11469,6 +11536,11 @@ Remember that you have to manage the visibility of all your editor controls manually. </description> </method> + <method name="queue_save_layout" qualifiers="const"> + <description> + Queue save the project's editor layout. + </description> + </method> <method name="remove_control_from_bottom_panel"> <argument index="0" name="control" type="Control"> </argument> @@ -11504,6 +11576,11 @@ Remove the import plugin, don't forget to call this on exit. </description> </method> + <method name="save_external_data" qualifiers="virtual"> + <description> + This method is called after the editor save the project or when the it's closed. It asks the plugin to save edited external scenes/resources. + </description> + </method> <method name="set_state" qualifiers="virtual"> <argument index="0" name="state" type="Dictionary"> </argument> @@ -11511,6 +11588,13 @@ Restore the state saved by [method EditorPlugin.get_state]. </description> </method> + <method name="set_window_layout" qualifiers="virtual"> + <argument index="0" name="layout" type="ConfigFile"> + </argument> + <description> + Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout]. + </description> + </method> </methods> <constants> <constant name="CONTAINER_TOOLBAR" value="0"> @@ -12657,6 +12741,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 +12801,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> @@ -13050,6 +13146,8 @@ </description> <methods> <method name="call_func"> + <return type="Variant"> + </return> <argument index="0" name="arg0" type="Variant" default="NULL"> </argument> <argument index="1" name="arg1" type="Variant" default="NULL"> @@ -13149,6 +13247,8 @@ </description> </method> <method name="new"> + <return type="Object"> + </return> <description> </description> </method> @@ -13817,6 +13917,12 @@ Return the scroll offset. </description> </method> + <method name="get_snap" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_zoom" qualifiers="const"> <return type="float"> </return> @@ -13846,6 +13952,12 @@ Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. </description> </method> + <method name="is_using_snap" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_right_disconnects"> <argument index="0" name="enable" type="bool"> </argument> @@ -13853,6 +13965,30 @@ Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. </description> </method> + <method name="set_scroll_ofs"> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_selected"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_snap"> + <argument index="0" name="pixels" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_use_snap"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_zoom"> <argument index="0" name="p_zoom" type="float"> </argument> @@ -13908,6 +14044,12 @@ Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. </description> </signal> + <signal name="node_selected"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> <signal name="popup_request"> <argument index="0" name="p_position" type="Vector2"> </argument> @@ -13915,18 +14057,30 @@ Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. </description> </signal> + <signal name="scroll_offset_changed"> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </signal> </signals> <constants> </constants> <theme_items> <theme_item name="bg" type="StyleBox"> </theme_item> + <theme_item name="grid_major" type="Color"> + </theme_item> + <theme_item name="grid_minor" type="Color"> + </theme_item> <theme_item name="minus" type="Texture"> </theme_item> <theme_item name="more" type="Texture"> </theme_item> <theme_item name="reset" type="Texture"> </theme_item> + <theme_item name="snap" type="Texture"> + </theme_item> </theme_items> </class> <class name="GraphNode" inherits="Container" category="Core"> @@ -14017,6 +14171,12 @@ Return the type of the output connection 'idx'. </description> </method> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> @@ -14024,6 +14184,12 @@ Return the offset of the GraphNode. </description> </method> + <method name="get_overlay" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_slot_color_left" qualifiers="const"> <return type="Color"> </return> @@ -14092,6 +14258,12 @@ Return true if right (output) slot 'idx' is enabled. False otherwise. </description> </method> + <method name="set_modulate"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> @@ -14099,6 +14271,12 @@ Set the offset of the GraphNode. </description> </method> + <method name="set_overlay"> + <argument index="0" name="overlay" type="int"> + </argument> + <description> + </description> + </method> <method name="set_show_close_button"> <argument index="0" name="show" type="bool"> </argument> @@ -14121,8 +14299,11 @@ </argument> <argument index="6" name="color_right" type="Color"> </argument> + <argument index="7" name="custom_left" type="Object" default="Object()"> + </argument> + <argument index="8" name="custom_right" type="Object" default="Object()"> + </argument> <description> - Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. </description> </method> <method name="set_title"> @@ -14160,8 +14341,16 @@ </signal> </signals> <constants> + <constant name="OVERLAY_DISABLED" value="0"> + </constant> + <constant name="OVERLAY_BREAKPOINT" value="1"> + </constant> + <constant name="OVERLAY_POSITION" value="2"> + </constant> </constants> <theme_items> + <theme_item name="breakpoint" type="StyleBox"> + </theme_item> <theme_item name="close" type="Texture"> </theme_item> <theme_item name="close_offset" type="int"> @@ -14176,6 +14365,8 @@ </theme_item> <theme_item name="port_offset" type="int"> </theme_item> + <theme_item name="position" type="StyleBox"> + </theme_item> <theme_item name="selectedframe" type="StyleBox"> </theme_item> <theme_item name="separation" type="int"> @@ -15708,14 +15899,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 +15912,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 +16165,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. @@ -17483,8 +17670,13 @@ </class> <class name="ItemList" inherits="Control" category="Core"> <brief_description> + Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. </brief_description> <description> + This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, + or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list + may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled + to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). </description> <methods> <method name="add_icon_item"> @@ -17493,6 +17685,7 @@ <argument index="1" name="selectable" type="bool" default="true"> </argument> <description> + Adds an item to the item list with no text, only an icon. </description> </method> <method name="add_item"> @@ -17503,26 +17696,32 @@ <argument index="2" name="selectable" type="bool" default="true"> </argument> <description> + Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. + If selectable is true the list item will be selectable. </description> </method> <method name="clear"> <description> + Remove all items from the list. </description> </method> <method name="ensure_current_is_visible"> <description> + Ensure selection is visible, adjusting the scroll position as necessary. </description> </method> <method name="get_allow_rmb_select" qualifiers="const"> <return type="bool"> </return> <description> + Return whether or not items may be selected via right mouse clicking. </description> </method> <method name="get_fixed_column_width" qualifiers="const"> <return type="int"> </return> <description> + If column size has been fixed to a value, return that value. </description> </method> <method name="get_fixed_icon_size" qualifiers="const"> @@ -17551,12 +17750,14 @@ <argument index="1" name="exact" type="bool" default="false"> </argument> <description> + Given a position within the control return the item (if any) at that point. </description> </method> <method name="get_item_count" qualifiers="const"> <return type="int"> </return> <description> + Return count of items currently in the item list. </description> </method> <method name="get_item_custom_bg_color" qualifiers="const"> @@ -17595,6 +17796,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Return the text for specified item index. </description> </method> <method name="get_item_tooltip" qualifiers="const"> @@ -17603,18 +17805,21 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Return tooltip hint for specified item index. </description> </method> <method name="get_max_columns" qualifiers="const"> <return type="int"> </return> <description> + Return total number of columns in use by the list. </description> </method> <method name="get_max_text_lines" qualifiers="const"> <return type="int"> </return> <description> + Return total number of lines currently in use by the list. </description> </method> <method name="get_select_mode" qualifiers="const"> @@ -17627,7 +17832,7 @@ <return type="IntArray"> </return> <description> - Returns a list of selected indexes. + Returns the list of selected indexes. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -17636,6 +17841,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns whether or not the item at the specified index is disabled </description> </method> <method name="is_item_selectable" qualifiers="const"> @@ -17644,12 +17850,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns whether or not the item at the specified index is selectable. </description> </method> <method name="is_same_column_width" qualifiers="const"> <return type="int"> </return> <description> + Returns whether or not all columns of the list are of the same size. </description> </method> <method name="is_selected" qualifiers="const"> @@ -17658,12 +17866,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns whether or not item at the specified index is currently selected. </description> </method> <method name="remove_item"> <argument index="0" name="idx" type="int"> </argument> <description> + Remove item at specified index from the list. </description> </method> <method name="select"> @@ -17672,18 +17882,22 @@ <argument index="1" name="single" type="bool" default="true"> </argument> <description> + Select the item at the specified index. + Note: This method does not trigger the item selection signal. </description> </method> <method name="set_allow_rmb_select"> <argument index="0" name="allow" type="bool"> </argument> <description> + Allow (or disallow) selection of (selectable) items in the list using right mouse button. </description> </method> <method name="set_fixed_column_width"> <argument index="0" name="width" type="int"> </argument> <description> + Set the size (width) all columns in the list are to use. </description> </method> <method name="set_fixed_icon_size"> @@ -17718,6 +17932,8 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + Disable (or enable) item at specified index. + Disabled items are not be selectable and do not fire activation (Enter or double-click) signals. </description> </method> <method name="set_item_icon"> @@ -17726,6 +17942,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> + Set (or replace) icon of the item at the specified index. </description> </method> <method name="set_item_icon_region"> @@ -17742,6 +17959,7 @@ <argument index="1" name="metadata" type="Variant"> </argument> <description> + Sets a value (of any type) to be stored with the item at the specified index. </description> </method> <method name="set_item_selectable"> @@ -17750,6 +17968,7 @@ <argument index="1" name="selectable" type="bool"> </argument> <description> + Allow or disallow selection of the item at the specified index. </description> </method> <method name="set_item_text"> @@ -17758,6 +17977,7 @@ <argument index="1" name="text" type="String"> </argument> <description> + Sets text of item at specified index. </description> </method> <method name="set_item_tooltip"> @@ -17766,24 +17986,28 @@ <argument index="1" name="tooltip" type="String"> </argument> <description> + Sets tooltip hint for item at specified index. </description> </method> <method name="set_max_columns"> <argument index="0" name="amount" type="int"> </argument> <description> + Set maximum number of columns to use for the list. </description> </method> <method name="set_max_text_lines"> <argument index="0" name="lines" type="int"> </argument> <description> + Set maximum number of lines to use for the list. </description> </method> <method name="set_same_column_width"> <argument index="0" name="enable" type="bool"> </argument> <description> + Sets a fixed size (width) to use for all columns of the list. </description> </method> <method name="set_select_mode"> @@ -17794,12 +18018,14 @@ </method> <method name="sort_items_by_text"> <description> + Sorts items in the list by their text. </description> </method> <method name="unselect"> <argument index="0" name="idx" type="int"> </argument> <description> + Ensure item at specified index is not selected. </description> </method> </methods> @@ -17808,6 +18034,7 @@ <argument index="0" name="index" type="int"> </argument> <description> + Fired when specified list item is activated via double click or Enter. </description> </signal> <signal name="item_rmb_selected"> @@ -17816,12 +18043,16 @@ <argument index="1" name="atpos" type="Vector2"> </argument> <description> + Fired when specified list item has been selected via right mouse clicking. + The click position is also provided to allow appropriate popup of context menus + at the correct location. </description> </signal> <signal name="item_selected"> <argument index="0" name="index" type="int"> </argument> <description> + Fired when specified item has been selected. </description> </signal> <signal name="multi_selected"> @@ -17830,6 +18061,7 @@ <argument index="1" name="selected" type="bool"> </argument> <description> + Fired when a multiple selection is altered on a list allowing mutliple selection. </description> </signal> </signals> @@ -22954,7 +23186,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 +23346,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=""""> </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). @@ -23257,6 +23489,8 @@ </description> </method> <method name="call"> + <return type="Variant"> + </return> <argument index="0" name="method" type="String"> </argument> <argument index="1" name="arg0" type="Variant" default="NULL"> @@ -25943,7 +26177,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 +26410,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 +29712,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]. @@ -33878,6 +34112,14 @@ <description> </description> </method> + <method name="create_timer"> + <return type="SceneTreeTimer"> + </return> + <argument index="0" name="time_sec" type="float"> + </argument> + <description> + </description> + </method> <method name="get_current_scene" qualifiers="const"> <return type="Node"> </return> @@ -34106,6 +34348,34 @@ </constant> </constants> </class> +<class name="SceneTreeTimer" inherits="Reference" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_time_left" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_time_left"> + <argument index="0" name="time" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="timeout"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> <class name="Script" inherits="Resource" category="Core"> <brief_description> Base class for scripts. @@ -38733,6 +39003,12 @@ <description> </description> </method> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> <method name="get_region_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -38767,6 +39043,12 @@ <description> </description> </method> + <method name="set_modulate"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> <method name="set_region_rect"> <argument index="0" name="region" type="Rect2"> </argument> @@ -38809,6 +39091,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 +44769,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. @@ -44859,6 +45147,1488 @@ <constants> </constants> </class> +<class name="VisualScript" inherits="Script" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="add_custom_signal"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_function"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_node"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="node" type="Object"> + </argument> + <argument index="3" name="pos" type="Vector2" default="Vector2((0, 0))"> + </argument> + <description> + </description> + </method> + <method name="add_variable"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="default_value" type="Variant" default="NULL"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_add_argument"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="argname" type="String"> + </argument> + <argument index="3" name="index" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_type" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_remove_argument"> + <argument index="0" name="argidx" type="String"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_set_argument_name"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="argname" type="String"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_set_argument_type"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="type" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_swap_argument"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="withidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="data_connect"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="data_disconnect"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_function_node_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_function_scroll" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="arg0" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_variable_default_value" qualifiers="const"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_variable_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_custom_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_data_connection" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_function" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_sequence_connection" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_variable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_custom_signal"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_function"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_node"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_variable"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_custom_signal"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_function"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_variable"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="sequence_connect"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="sequence_disconnect"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_function_scroll"> + <argument index="0" name="ofs" type="String"> + </argument> + <argument index="1" name="arg1" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_instance_base_type"> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_node_pos"> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_variable_default_value"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_variable_info"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Dictionary"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="node_ports_changed"> + <argument index="0" name="function" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> +<class name="VisualScriptBuiltinFunc" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_func"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_func"> + <argument index="0" name="which" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptCondition" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_constant_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_constant_value" qualifiers="const"> + <description> + </description> + </method> + <method name="set_constant_type"> + <argument index="0" name="type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_constant_value"> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptCustomNode" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="_get_caption" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_category" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_input_value_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_input_value_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_input_value_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_port_unsequenced" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="work_mem" type="Array"> + </argument> + <description> + </description> + </method> + <method name="_get_output_sequence_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_output_sequence_port_text" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_value_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_output_value_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_value_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_text" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_working_memory_size" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_has_input_sequence_port" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="_is_output_port_unsequenced" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_step" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="inputs" type="Array"> + </argument> + <argument index="1" name="outputs" type="Array"> + </argument> + <argument index="2" name="start_mode" type="int"> + </argument> + <argument index="3" name="working_mem" type="Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="START_MODE_BEGIN_SEQUENCE" value="0"> + </constant> + <constant name="START_MODE_CONTINUE_SEQUENCE" value="1"> + </constant> + <constant name="START_MODE_RESUME_YIELD" value="2"> + </constant> + <constant name="STEP_PUSH_STACK_BIT" value="16777216"> + </constant> + <constant name="STEP_GO_BACK_BIT" value="33554432"> + </constant> + <constant name="STEP_NO_ADVANCE_BIT" value="67108864"> + </constant> + <constant name="STEP_EXIT_FUNCTION_BIT" value="134217728"> + </constant> + <constant name="STEP_YIELD_BIT" value="268435456"> + </constant> + </constants> +</class> +<class name="VisualScriptEmitSignal" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_signal" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_signal"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptEngineSingleton" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_singleton"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_singleton"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptFunction" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptFunctionCall" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_function" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_use_default_args" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <argument index="0" name="basic_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_function"> + <argument index="0" name="function" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_use_default_args"> + <argument index="0" name="amount" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + <constant name="CALL_MODE_BASIC_TYPE" value="3"> + </constant> + </constants> +</class> +<class name="VisualScriptFunctionState" inherits="Reference" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="connect_to_signal"> + <argument index="0" name="obj" type="Object"> + </argument> + <argument index="1" name="signals" type="String"> + </argument> + <argument index="2" name="args" type="Array"> + </argument> + <description> + </description> + </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="resume"> + <return type="Array"> + </return> + <argument index="0" name="args" type="Array" default="NULL"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_global_constant"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_global_constant"> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptIndexGet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptIndexSet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptInputFilter" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptInputSelector" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_math_constant"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_math_constant"> + <argument index="0" name="which" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptNode" inherits="Resource" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_default_input_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="port_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_visual_script" qualifiers="const"> + <return type="VisualScript"> + </return> + <description> + </description> + </method> + <method name="set_default_input_value"> + <argument index="0" name="port_idx" type="int"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="ports_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> +<class name="VisualScriptOperator" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_operator" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_operator"> + <argument index="0" name="op" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_event_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_property" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <argument index="0" name="basic_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_event_type"> + <argument index="0" name="event_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_property"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + </constants> +</class> +<class name="VisualScriptPropertySet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_builtin_value" qualifiers="const"> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_event_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_property" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="is_using_builtin_value" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <argument index="0" name="basic_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_builtin_value"> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_event_type"> + <argument index="0" name="event_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_property"> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_use_builtin_value"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + </constants> +</class> +<class name="VisualScriptResourcePath" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_resource_path"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_resource_path"> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_return_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_return_value_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_enable_return_value"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_return_type"> + <argument index="0" name="type" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_node_path"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="set_node_path"> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptSceneTree" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptScriptCall" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_argument_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_function" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_argument_count"> + <argument index="0" name="argument_count" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_function"> + <argument index="0" name="function" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + </constants> +</class> +<class name="VisualScriptSelf" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_steps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_steps"> + <argument index="0" name="steps" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptSubCall" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="_subcall" qualifiers="virtual"> + <argument index="0" name="arguments" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptVariableGet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_variable" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_variable"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_variable" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_variable"> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + </methods> + <constants> + </constants> +</class> +<class name="VisualScriptYield" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_wait_time"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_yield_mode"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_wait_time"> + <argument index="0" name="sec" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_yield_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="YIELD_FRAME" value="0"> + </constant> + <constant name="YIELD_FIXED_FRAME" value="1"> + </constant> + <constant name="YIELD_WAIT" value="2"> + </constant> + </constants> +</class> +<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_signal" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_signal"> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + </constants> +</class> <class name="VisualServer" inherits="Object" category="Core"> <brief_description> Server for anything visible. |