diff options
Diffstat (limited to 'doc/classes')
41 files changed, 2269 insertions, 171 deletions
diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index d8c9a57a88..0d509e6e51 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -29,6 +29,8 @@ <member name="Geometry" type="Geometry" setter="" getter=""> [Geometry] singleton </member> + <member name="GodotSharp" type="GodotSharp" setter="" getter=""> + </member> <member name="IP" type="IP" setter="" getter=""> [IP] singleton </member> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index 8797575038..bbab7a5547 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -88,14 +88,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [Area]\ s. + Returns a list of intersecting [Area]s. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody]\ s. + Returns a list of intersecting [PhysicsBody]s. </description> </method> <method name="get_priority" qualifiers="const"> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 0cbc079962..883f952a2a 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -88,14 +88,14 @@ <return type="Array"> </return> <description> - Returns a list of intersecting [Area2D]\ s. + Returns a list of intersecting [Area2D]s. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Returns a list of intersecting [PhysicsBody2D]\ s. + Returns a list of intersecting [PhysicsBody2D]s. </description> </method> <method name="get_priority" qualifiers="const"> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 07027c4b42..48e5798008 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -168,7 +168,7 @@ The font's kernings as [PoolIntArray]. </member> <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> - The font's [Texture]\ s. + The font's [Texture]s. </member> </members> <constants> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 64e9e07925..71b0c5fa7c 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -4,7 +4,7 @@ Base node for collision objects. </brief_description> <description> - CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. + CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. </description> <tutorials> </tutorials> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 52743bd37d..ec0554d51f 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -4,7 +4,7 @@ Base node for 2D collision objects. </brief_description> <description> - CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]\ s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. + CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods. </description> <tutorials> </tutorials> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index c130add523..d7f08c85a1 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -4,7 +4,7 @@ DynamicFont renders vector font files at runtime. </brief_description> <description> - DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]\ s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. + DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 23a937791c..3a3fd43b15 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -102,7 +102,7 @@ <argument index="1" name="preview_size" type="int"> </argument> <description> - Returns mesh previews rendered at the given size as an [Array] of [Texture]\ s. + Returns mesh previews rendered at the given size as an [Array] of [Texture]s. </description> </method> <method name="open_scene_from_path"> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 9e774345a2..8856e3362a 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -4,7 +4,7 @@ Base script that can be used to add extension functions to the editor. </brief_description> <description> - Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]\ s instead. Note that extending scripts need to have [code]tool mode[/code] enabled. + Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]s instead. Note that extending scripts need to have [code]tool mode[/code] enabled. Example script: [codeblock] tool @@ -24,7 +24,7 @@ <return type="void"> </return> <description> - This method is executed by the Editor when [code]File -> Run[/code] is used. + This method is executed by the Editor when [code]File -> Run[/code] is used. </description> </method> <method name="add_root_node"> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index f064029a01..01d578be5e 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -228,8 +228,6 @@ <constants> </constants> <theme_items> - <theme_item name="SnapGrid" type="Texture"> - </theme_item> <theme_item name="bezier_len_neg" type="int"> </theme_item> <theme_item name="bezier_len_pos" type="int"> @@ -246,5 +244,7 @@ </theme_item> <theme_item name="reset" type="Texture"> </theme_item> + <theme_item name="snap" type="Texture"> + </theme_item> </theme_items> </class> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 392ee25ad6..c6abf2fee5 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -4,8 +4,10 @@ Generic input event </brief_description> <description> + Base class of all sort of input event. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -16,7 +18,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Returns true if this input event matches the event passed. + Returns [code]true[/code] if this event matches [code]event[event]. </description> </method> <method name="as_text" qualifiers="const"> @@ -30,14 +32,14 @@ <return type="int"> </return> <description> - Returns the id of the device that generated the event. + Returns the device's id that generated the event. </description> </method> <method name="get_id" qualifiers="const"> <return type="int"> </return> <description> - Returns the id of the event. + Returns the event's ID. </description> </method> <method name="is_action" qualifiers="const"> @@ -46,7 +48,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if this input event matches a pre-defined action, no matter the type. + Returns [code]true[/code] if this input event matches a pre-defined action of any type. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -55,7 +57,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="is_action_released" qualifiers="const"> @@ -64,27 +66,28 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="is_action_type" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if this input event's type is one of the [code]InputEvent[/code] constants. </description> </method> <method name="is_echo" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). + Returns [code]true[/code] if this input event is an echo event (only for events of type KEY). </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. </description> </method> <method name="set_device"> @@ -124,6 +127,7 @@ </methods> <members> <member name="device" type="int" setter="set_device" getter="get_device"> + The event's device ID. </member> </members> <constants> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 2617ea4dfa..a2f4c9b9d3 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -4,8 +4,10 @@ Input event type for actions. </brief_description> <description> + Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu [code]Project > Project Settings > Input Map[/Code]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions </tutorials> <demos> </demos> @@ -35,8 +37,10 @@ </methods> <members> <member name="action" type="String" setter="set_action" getter="get_action"> + The action's name. Actions are accessed via this [String]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + If [code]true[/code] the action's state is pressed. If [code]false[/code] the action's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 2784b06442..f13a1102b7 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Input event type for joypad button events. + Input event for gamepad buttons. </brief_description> <description> + Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -49,13 +51,13 @@ </methods> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. + Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@global Scope]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the joypad button. + If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released. </member> <member name="pressure" type="float" setter="set_pressure" getter="get_pressure"> - Intensity of the button pressure, ranges from 0 to 1.0. + Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code]. </member> </members> <constants> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 8a26007fc1..9e7edfb822 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Input event type for joypad motion/axis events. + Input event type for gamepad joysticks and other motions. For buttons see [InputEventJoypadMotion]. </brief_description> <description> + Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -41,10 +43,10 @@ </methods> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis"> - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. + Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@global Scope]. </member> <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value"> - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. + Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. </member> </members> <constants> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 151e19d25d..9565584a4f 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -4,8 +4,10 @@ Input event type for keyboard events. </brief_description> <description> + Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -63,16 +65,16 @@ </methods> <members> <member name="echo" type="bool" setter="set_echo" getter="is_echo"> - Echo state of the key, i.e. whether it's a repeat event or not. + If [code]true[/code] the key was already pressed before this event. It means the user is holding the key down. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the key. + If [code]true[/code] the key's state is pressed. If [code]false[/code] the key's state is released. </member> <member name="scancode" type="int" setter="set_scancode" getter="get_scancode"> - Scancode of the key, one of the KEY_* constants in [@Global Scope]. + Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope]. </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> - Unicode identifier of the key (when relevant). + Key unicode identifier when relevant. </member> </members> <constants> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 57f0acbf30..38eec74ffa 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -4,8 +4,10 @@ Base input event type for mouse events. </brief_description> <description> + Stores general mouse events informations. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -58,10 +60,10 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. </member> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> - Global position of the mouse click. + Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Local position of the mouse click. + Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index 63e31eb61c..afc0c331c8 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -4,8 +4,10 @@ Input event type for mouse button events. </brief_description> <description> + Contains mouse click informations. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -66,12 +68,13 @@ Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. </member> <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick"> - Whether the event is a double-click. + If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. </member> <member name="factor" type="float" setter="set_factor" getter="get_factor"> + TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the mouse button. + If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 59fe8d2e58..5be82e1ffa 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -4,8 +4,10 @@ Input event type for mouse motion events. </brief_description> <description> + Contains mouse motion informations. Supports relative, absolute positions and speed. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -41,10 +43,10 @@ </methods> <members> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Position of the mouse pointer relative to the previous mouse position. + Mouse position relative to the previous position (position at the last frame). </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Speed of the mouse pointer. + Mouse speed. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 0b0ecc17bc..0c92ad5f70 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -2,10 +2,13 @@ <class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> Input event type for screen drag events. + (only available on mobile devices) </brief_description> <description> + Contains screen drag informations. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -72,13 +75,13 @@ Drag event index in the case of a multi-drag event. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Position of the drag event. + Drag position. </member> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> - Position of the drag event relative to its start position. + Drag position relative to its start position. </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> - Speed of the drag event. + Drag speed. </member> </members> <constants> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 48c5626f14..01ba9f1285 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -2,10 +2,13 @@ <class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> Input event type for screen touch events. + (only available on mobile devices) </brief_description> <description> + Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> @@ -49,13 +52,13 @@ </methods> <members> <member name="index" type="int" setter="set_index" getter="get_index"> - Touch event index in the case of a multi-touch event. + Touch index in the case of a multi-touch event. One index = one finger. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position"> - Position of the touch event. + Touch position. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> - Pressed state of the touch event. + If [code]true[/code] the touch's state is pressed. If [code]false[/code] the touch's state is released. </member> </members> <constants> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 7bbdf0a441..46107a4ab8 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Base class for input events with modifiers. + Base class for keys events with modifiers. </brief_description> <description> + Contains keys events informations with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html </tutorials> <demos> </demos> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index bf72ba05e7..333edf02b5 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,11 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="InputMap" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Singleton that manages actions. + Singleton that manages [InputEventAction]. </brief_description> <description> + Manages all [InputEventAction] which can be created/modified from the project settings menu [code]Project > Project Settings > Input Map[/Code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap </tutorials> <demos> </demos> @@ -18,7 +20,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Add an [InputEvent] to an action. This [InputEvent] will trigger the action. + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> @@ -29,7 +31,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Remove an [InputEvent] from an action. + Removes an [InputEvent] from an action. </description> </method> <method name="action_has_event"> @@ -40,7 +42,7 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Whether an action has an [InputEvent] associated with it. + Returns [true] if an action has an [InputEvent] associated with it. </description> </method> <method name="add_action"> @@ -49,7 +51,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. + Adds an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> <method name="erase_action"> @@ -58,7 +60,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Remove an action from the [InputMap]. + Removes an action from the [code]InputMap[/code]. </description> </method> <method name="event_is_action" qualifiers="const"> @@ -69,7 +71,7 @@ <argument index="1" name="action" type="String"> </argument> <description> - Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. + Returns [true] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. </description> </method> <method name="get_action_list"> @@ -78,14 +80,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return an array of InputEvents associated with a given action. + Returns an array of [InputEvent]s associated with a given action. </description> </method> <method name="get_actions"> <return type="Array"> </return> <description> - Return an array of all actions in the [InputMap]. + Returns an array of all actions in the [code]InputMap[/code]. </description> </method> <method name="has_action" qualifiers="const"> @@ -94,14 +96,14 @@ <argument index="0" name="action" type="String"> </argument> <description> - Whether this InputMap has a registered action with the given name. + Returns [code]true[/code] if the [code]InputMap[/code] has a registered action with the given name. </description> </method> <method name="load_from_globals"> <return type="void"> </return> <description> - Clear the [InputMap] and load it anew from [ProjectSettings]. + Clears all [InputEventAction] in the [code]InputMap[/code] and load it anew from [ProjectSettings]. </description> </method> </methods> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 9bff0c9b5e..0453c16537 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -4,7 +4,7 @@ UDP packet peer. </brief_description> <description> - UDP packet peer. Can be used to send raw UDP packets as well as [Variant]\ s. + UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. </description> <tutorials> </tutorials> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index 9399227d27..5427ed1573 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -70,7 +70,7 @@ collider_id: Id of the object the point is in. collider: Object the point is inside of. rid: [RID] of the object the point is in. - Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). </description> </method> <method name="intersect_ray"> @@ -96,7 +96,7 @@ collider: Object against which the ray was stopped. rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. - Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). </description> </method> <method name="intersect_shape"> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index d838ff2317..04fe12cc07 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -22,7 +22,7 @@ <return type="Array"> </return> <description> - Return the list of objects, or object [RID]\ s, that will be excluded from collisions. + Return the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="get_margin" qualifiers="const"> @@ -75,7 +75,7 @@ <argument index="0" name="exclude" type="Array"> </argument> <description> - Set the list of objects, or object [RID]\ s, that will be excluded from collisions. + Set the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="set_margin"> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 12c1abccc6..71cdd6f6df 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -376,14 +376,15 @@ </argument> <description> Returns the physics layer or layers a body can collide with. -- </description> -- </method> -- <method name="body_get_direct_state"> -- <return type="PhysicsDirectBodyState"> -- </return> -- <argument index="0" name="body" type="RID"> -- </argument> -- <description> +- + </description> + </method> + <method name="body_get_direct_state"> + <return type="PhysicsDirectBodyState"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> Returns the [PhysicsDirectBodyState] of the body. </description> </method> @@ -534,7 +535,7 @@ <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock"> </argument> <description> - Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. + Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. </description> </method> <method name="body_set_axis_velocity"> @@ -746,7 +747,7 @@ </argument> <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> </argument> - <description> + <description> Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). </description> </method> diff --git a/doc/classes/PluginScript.xml b/doc/classes/PluginScript.xml new file mode 100644 index 0000000000..334921016b --- /dev/null +++ b/doc/classes/PluginScript.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PluginScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index 3782a98e3e..fc96a183eb 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -78,11 +78,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -147,13 +147,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> - <argument index="0" name="layer" type="int"> + <argument index="0" name="mask" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> <method name="set_enabled"> @@ -179,8 +179,8 @@ <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + 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"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 74ee0a8911..b6c657783d 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -77,11 +77,11 @@ [/codeblock] </description> </method> - <method name="get_collision_layer" qualifiers="const"> + <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision layer for this ray. + Returns the collision mask for this ray. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -153,13 +153,13 @@ Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> - <method name="set_collision_layer"> + <method name="set_collision_mask"> <return type="void"> </return> <argument index="0" name="layer" type="int"> </argument> <description> - Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. </description> </method> <method name="set_enabled"> @@ -194,8 +194,8 @@ <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> - <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + 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"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 9f8cdcce6d..0e15785d0d 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -102,6 +102,12 @@ <description> </description> </method> + <method name="is_overriding_selected_font_color" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_scroll_active" qualifiers="const"> <return type="bool"> </return> @@ -247,6 +253,14 @@ <description> </description> </method> + <method name="set_override_selected_font_color"> + <return type="void"> + </return> + <argument index="0" name="override" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_percent_visible"> <return type="void"> </return> @@ -330,6 +344,8 @@ </member> <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode"> </member> + <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> + </member> <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible"> </member> <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index f2584de5aa..2bc3fd726b 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -1,14 +1,17 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Physics Body whose position is determined through physics simulation in 2D space. + A body that is controlled by the 2D physics engine. </brief_description> <description> - This is the node that implements full 2D physics. This means that you do not control a RigidBody2D directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. - This node can use custom force integration, for writing complex physics motion behavior per node. - This node can shift state between regular Rigid body, Kinematic, Character or Static. - Character mode forbids this node from being rotated. - As a warning, don't change RigidBody2D's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. + This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties. + A RigidBody2D has 4 behavior modes (see [member mode]): + - [b]Rigid[/b]: The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. + - [b]Static[/b]: The body behaves like a [StaticBody2D] and does not move. + - [b]Character[/b]: Similar to [code]Rigid[/code] mode, but the body can not rotate. + - [b]Kinematic[/b]: The body behaves like a [KinematicBody2D], and must be moved by code. + [b]Note:[/b] You should not change a RigidBody2D's [code]position[/code] or [code]linear_velocity[/code] every frame or even very often. If you need to directly affect the body's state, use [method _integrate_forces], which allows you to directly access the physics state. + If you need to override the default physics behavior, you can write a custom force integration. See [member custom_integrator]. </description> <tutorials> </tutorials> @@ -21,7 +24,7 @@ <argument index="0" name="state" type="Physics2DDirectBodyState"> </argument> <description> - Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + Allows you to read and safely modify the simulation state for the object. Use this instead of [Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. </description> </method> <method name="add_force"> @@ -32,7 +35,7 @@ <argument index="1" name="force" type="Vector2"> </argument> <description> - Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates. + Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. </description> </method> <method name="apply_impulse"> @@ -43,7 +46,7 @@ <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + Applies a positioned impulse to the body (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied instantaneously. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> <method name="get_angular_damp" qualifiers="const"> @@ -64,14 +67,14 @@ <return type="Vector2"> </return> <description> - Return the applied force vector. + Returns the body's total applied force. </description> </method> <method name="get_applied_torque" qualifiers="const"> <return type="float"> </return> <description> - Return the torque which is being applied to this body. + Returns the body's total applied torque. </description> </method> <method name="get_bounce" qualifiers="const"> @@ -85,7 +88,7 @@ <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. You must also enable contact monitor, see [method set_contact_monitor] + Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code]. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> @@ -113,7 +116,7 @@ <return type="float"> </return> <description> - Returns the body's moment of inertia. Automatically computed from associated [class CollisionShape2D]s' mass during physic frames. Inertia is not computed the same frame in which the node was added in. Therefore inertia is not computed during the [code]_ready[/code] function. + Returns the body's moment of inertia, which is computed automatically from the body's mass and assigned [Shape2D]s during the physics frame. Note that it will not yet have a value in the [code]_ready()[/code] function. </description> </method> <method name="get_linear_damp" qualifiers="const"> @@ -210,7 +213,7 @@ <argument index="0" name="force" type="Vector2"> </argument> <description> - Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. + Sets the applied force vector. This is the equivalent of firing a rocket: the force is applied constantly. </description> </method> <method name="set_applied_torque"> @@ -219,7 +222,7 @@ <argument index="0" name="torque" type="float"> </argument> <description> - Set a constant torque which will be applied to this body. + Sets the applied torque. </description> </method> <method name="set_axis_velocity"> @@ -228,7 +231,7 @@ <argument index="0" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="set_bounce"> @@ -378,59 +381,59 @@ <argument index="2" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> - Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). + Returns [code]true[/code] if a collision would result from moving in the given vector. [code]margin[/code] increases the size of the shapes involved in the collision detection, and [code]result[/code] is an object of type [Physics2DTestMotionResult], which contains additional information about the collision (should there be one). </description> </method> </methods> <members> <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> - Damps RigidBody2D's rotational forces. + Damps the body's [member angular_velocity]. If [code]-1[/code] the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code]. </member> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> - RigidBody2D's rotational velocity. + The body's rotational velocity. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - RigidBody2D's bounciness. + The body's bounciness. Default value: [code]0[/code]. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep"> - If [code]true[/code] RigidBody2D will not calculate forces and will act as a static body while there is no movement. It will wake up when other forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. Default value: [code]true[/code] + If [code]true[/code] the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. Default value: [code]true[/code]. </member> <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled"> - If [code]true[/code] RigidBody2D will emit signals when it collides with another RigidBody2D. + If [code]true[/code] the body will emit signals when it collides with another RigidBody2D. See also [member contacts_reported]. Default value: [code]false[/code]. </member> <member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported"> - The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + The maximum number of contacts to report. Default value: [code]0[/code]. </member> <member name="continuous_cd" type="int" setter="set_continuous_collision_detection_mode" getter="get_continuous_collision_detection_mode" enum="RigidBody2D.CCDMode"> - If [code]true[/code] continuous collision detection is used. Default value: [code]false[/code] - Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. + Continuous collision detection mode. Default value: [code]CCD_MODE_DISABLED[/code]. + Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See [code]CCD_MODE_[/code] constants for details. </member> <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator"> - If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + If [code]true[/code] internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the [method _integrate_forces] function. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> - The body friction, from 0 (frictionless) to 1 (max friction). + The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Default value: [code]1[/code]. </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> - This is multiplied by the global 2D gravity setting found in "Project > Project Settings > Physics > 2d" to produce RigidBody2D's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. + Multiplies the gravity applied to the body. The body's gravity is calculated from the "Default Gravity" value in "Project > Project Settings > Physics > 2d" and/or any additional gravity vector applied by [Area2D]s. Default value: [code]1[/code]. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> - RigidBody2D's linear damp. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + Damps the body's [member linear_velocity]. If [code]-1[/code] the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: [code]-1[/code]. </member> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> - RigidBody2D's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. + The body's linear velocity. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass"> - RigidBody2D's mass. + The body's mass. Default value: [code]1[/code]. </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody2D.Mode"> - The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + The body's mode. See [code]MODE_*[/code] constants. Default value: [code]MODE_RIGID[/code]. </member> <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping"> - If [code]true[/code] RigidBody2D is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. + If [code]true[/code] the body is sleeping and will not calculate forces until woken up by a collision or by using [method apply_impulse] or [method add_force]. </member> <member name="weight" type="float" setter="set_weight" getter="get_weight"> - RigidBody2D's weight based on its mass and the global 2D gravity. Global values are set in "Project > Project Settings > Physics > 2d". + The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". </member> </members> <signals> @@ -438,14 +441,14 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_exited"> <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body exits contact with this one. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_shape_entered"> @@ -458,8 +461,7 @@ <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. - This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + Emitted when a body enters into contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="body_shape_exited"> @@ -472,37 +474,36 @@ <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. - This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + Emitted when a body shape exits contact with this one. Reports colliding shape information. See [CollisionObject2D] for shape index information. [member contact_monitor] must be [code]true[/code] and [member contacts_reported] greater than [code]0[/code]. </description> </signal> <signal name="sleeping_state_changed"> <description> - Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Emitted when [member sleeping] changes. </description> </signal> </signals> <constants> <constant name="MODE_STATIC" value="1"> - Static mode. The body behaves like a [StaticBody2D], and can only move by user code. + Static mode. The body behaves like a [StaticBody2D] and does not move. </constant> <constant name="MODE_KINEMATIC" value="3"> - Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. + Kinematic mode. The body behaves like a [KinematicBody2D], and must be moved by code. </constant> <constant name="MODE_RIGID" value="0"> - Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. + Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode. </constant> <constant name="MODE_CHARACTER" value="2"> - Character body. This behaves like a rigid body, but can not rotate. + Character mode. Similar to [code]MODE_RIGID[/code], but the body can not rotate. </constant> <constant name="CCD_MODE_DISABLED" value="0"> - Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> <constant name="CCD_MODE_CAST_RAY" value="1"> - Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. </constant> <constant name="CCD_MODE_CAST_SHAPE" value="2"> - Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. </constant> </constants> </class> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index fd32f35a06..f6a6ce36e3 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -313,7 +313,7 @@ </argument> <argument index="2" name="minsize" type="Vector2"> </argument> - <argument index="3" name="shrink" type="int" default="1"> + <argument index="3" name="shrink" type="float" default="1"> </argument> <description> </description> @@ -352,6 +352,12 @@ <description> </description> </signal> + <signal name="node_added"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> <signal name="node_configuration_warning_changed"> <argument index="0" name="node" type="Object"> </argument> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index db47875050..da89c37ff4 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -1085,7 +1085,7 @@ </constant> <constant name="DIFFUSE_TOON" value="4"> </constant> - <constant name="SPECULAR_SCHLICK_GGX" value="0"> + <constant name="SPECULAR_GGX" value="0"> </constant> <constant name="SPECULAR_BLINN" value="1"> </constant> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 756b7f9225..eb9f82af6c 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -202,7 +202,7 @@ </argument> <argument index="1" name="radius_top_right" type="int"> </argument> - <argument index="2" name="radius_botton_right" type="int"> + <argument index="2" name="radius_bottom_right" type="int"> </argument> <argument index="3" name="radius_bottom_left" type="int"> </argument> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d77cb69eef..9a500af347 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -239,6 +239,12 @@ Returns true if highlight all occurrences is enabled. </description> </method> + <method name="is_overriding_selected_font_color" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_selection_active" qualifiers="const"> <return type="bool"> </return> @@ -343,6 +349,14 @@ Set the maximum amount of characters editable. </description> </method> + <method name="set_override_selected_font_color"> + <return type="void"> + </return> + <argument index="0" name="override" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_readonly"> <return type="void"> </return> @@ -421,6 +435,8 @@ </member> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> </member> + <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color"> + </member> <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled"> </member> <member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled"> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 2156d04614..b2467bca7f 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -4,7 +4,7 @@ A unit of execution in a process. </brief_description> <description> - A unit of execution in a process. Can run methods on [Object]\ s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. + A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. </description> <tutorials> </tutorials> @@ -15,7 +15,7 @@ <return type="String"> </return> <description> - Returns the current [Thread]\ s id, uniquely identifying it among all threads. + Returns the current [Thread]s id, uniquely identifying it among all threads. </description> </method> <method name="is_active" qualifiers="const"> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 3cf56bbf11..47292ec200 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -4,7 +4,7 @@ Control for a single item inside a [Tree]. </brief_description> <description> - Control for a single item inside a [Tree]. May have child [TreeItem]\ s and be styled as well as contain buttons. + Control for a single item inside a [Tree]. May have child [TreeItem]s and be styled as well as contain buttons. </description> <tutorials> </tutorials> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 58626356bf..28a7cb7c8e 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -303,7 +303,7 @@ <argument index="0" name="xform" type="Transform2D"> </argument> <description> - Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]\ s. This is relative to the global canvas transform of the viewport. + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. </description> </method> <method name="set_clear_mode"> diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml index f48f5a5308..5891b24bfd 100644 --- a/doc/classes/VisualScriptBuiltinFunc.xml +++ b/doc/classes/VisualScriptBuiltinFunc.xml @@ -114,97 +114,101 @@ <constant name="MATH_LERP" value="26"> Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. </constant> - <constant name="MATH_DECTIME" value="27"> + <constant name="MATH_INVERSE_LERP" value="27"> + </constant> + <constant name="MATH_RANGE_LERP" value="28"> + </constant> + <constant name="MATH_DECTIME" value="29"> Return the result of 'value' decreased by 'step' * 'amount'. </constant> - <constant name="MATH_RANDOMIZE" value="28"> + <constant name="MATH_RANDOMIZE" value="30"> Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. </constant> - <constant name="MATH_RAND" value="29"> + <constant name="MATH_RAND" value="31"> Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. </constant> - <constant name="MATH_RANDF" value="30"> + <constant name="MATH_RANDF" value="32"> Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. </constant> - <constant name="MATH_RANDOM" value="31"> + <constant name="MATH_RANDOM" value="33"> Return a random floating-point value between the two inputs. </constant> - <constant name="MATH_SEED" value="32"> + <constant name="MATH_SEED" value="34"> Set the seed for the random number generator. </constant> - <constant name="MATH_RANDSEED" value="33"> + <constant name="MATH_RANDSEED" value="35"> Return a random value from the given seed, along with the new seed. </constant> - <constant name="MATH_DEG2RAD" value="34"> + <constant name="MATH_DEG2RAD" value="36"> Convert the input from degrees to radians. </constant> - <constant name="MATH_RAD2DEG" value="35"> + <constant name="MATH_RAD2DEG" value="37"> Convert the input from radians to degrees. </constant> - <constant name="MATH_LINEAR2DB" value="36"> + <constant name="MATH_LINEAR2DB" value="38"> Convert the input from linear volume to decibel volume. </constant> - <constant name="MATH_DB2LINEAR" value="37"> + <constant name="MATH_DB2LINEAR" value="39"> Convert the input from decibel volume to linear volume. </constant> - <constant name="LOGIC_MAX" value="38"> + <constant name="LOGIC_MAX" value="40"> Return the greater of the two numbers, also known as their maximum. </constant> - <constant name="LOGIC_MIN" value="39"> + <constant name="LOGIC_MIN" value="41"> Return the lesser of the two numbers, also known as their minimum. </constant> - <constant name="LOGIC_CLAMP" value="40"> + <constant name="LOGIC_CLAMP" value="42"> Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` </constant> - <constant name="LOGIC_NEAREST_PO2" value="41"> + <constant name="LOGIC_NEAREST_PO2" value="43"> Return the nearest power of 2 to the input. </constant> - <constant name="OBJ_WEAKREF" value="42"> + <constant name="OBJ_WEAKREF" value="44"> Create a [WeakRef] from the input. </constant> - <constant name="FUNC_FUNCREF" value="43"> + <constant name="FUNC_FUNCREF" value="45"> Create a [FuncRef] from the input. </constant> - <constant name="TYPE_CONVERT" value="44"> + <constant name="TYPE_CONVERT" value="46"> Convert between types. </constant> - <constant name="TYPE_OF" value="45"> + <constant name="TYPE_OF" value="47"> Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. </constant> - <constant name="TYPE_EXISTS" value="46"> + <constant name="TYPE_EXISTS" value="48"> Checks if a type is registered in the [ClassDB]. </constant> - <constant name="TEXT_CHAR" value="47"> + <constant name="TEXT_CHAR" value="49"> Return a character with the given ascii value. </constant> - <constant name="TEXT_STR" value="48"> + <constant name="TEXT_STR" value="50"> Convert the input to a string. </constant> - <constant name="TEXT_PRINT" value="49"> + <constant name="TEXT_PRINT" value="51"> Print the given string to the output window. </constant> - <constant name="TEXT_PRINTERR" value="50"> + <constant name="TEXT_PRINTERR" value="52"> Print the given string to the standard error output. </constant> - <constant name="TEXT_PRINTRAW" value="51"> + <constant name="TEXT_PRINTRAW" value="53"> Print the given string to the standard output, without adding a newline. </constant> - <constant name="VAR_TO_STR" value="52"> + <constant name="VAR_TO_STR" value="54"> Serialize a [Variant] to a string. </constant> - <constant name="STR_TO_VAR" value="53"> + <constant name="STR_TO_VAR" value="55"> Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. </constant> - <constant name="VAR_TO_BYTES" value="54"> + <constant name="VAR_TO_BYTES" value="56"> Serialize a [Variant] to a [PoolByteArray]. </constant> - <constant name="BYTES_TO_VAR" value="55"> + <constant name="BYTES_TO_VAR" value="57"> Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. </constant> - <constant name="COLORN" value="56"> + <constant name="COLORN" value="58"> Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. </constant> - <constant name="FUNC_MAX" value="57"> + <constant name="FUNC_MAX" value="59"> The maximum value the [member function] property can have. </constant> </constants> diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml index 4ea4203407..845da4e50b 100644 --- a/doc/classes/VisualScriptSequence.xml +++ b/doc/classes/VisualScriptSequence.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Executes a series of Sequence ports. + Executes a series of Sequence ports. </brief_description> <description> Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 4bc6a49e91..5c6a951e7d 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -12,6 +12,820 @@ <demos> </demos> <methods> + <method name="black_bars_set_images"> + <return type="void"> + </return> + <argument index="0" name="left" type="RID"> + </argument> + <argument index="1" name="top" type="RID"> + </argument> + <argument index="2" name="right" type="RID"> + </argument> + <argument index="3" name="bottom" type="RID"> + </argument> + <description> + </description> + </method> + <method name="black_bars_set_margins"> + <return type="void"> + </return> + <argument index="0" name="left" type="int"> + </argument> + <argument index="1" name="top" type="int"> + </argument> + <argument index="2" name="right" type="int"> + </argument> + <argument index="3" name="bottom" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_item_add_circle"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="radius" type="float"> + </argument> + <argument index="3" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_clip_ignore"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="ignore" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_line"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="from" type="Vector2"> + </argument> + <argument index="2" name="to" type="Vector2"> + </argument> + <argument index="3" name="color" type="Color"> + </argument> + <argument index="4" name="width" type="float" default="1.0"> + </argument> + <argument index="5" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_mesh"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mesh" type="RID"> + </argument> + <argument index="2" name="skeleton" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_multimesh"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mesh" type="RID"> + </argument> + <argument index="2" name="skeleton" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_nine_patch"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="source" type="Rect2"> + </argument> + <argument index="3" name="texture" type="RID"> + </argument> + <argument index="4" name="topleft" type="Vector2"> + </argument> + <argument index="5" name="bottomright" type="Vector2"> + </argument> + <argument index="6" name="x_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0"> + </argument> + <argument index="7" name="y_axis_mode" type="int" enum="VisualServer.NinePatchAxisMode" default="0"> + </argument> + <argument index="8" name="draw_center" type="bool" default="true"> + </argument> + <argument index="9" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="10" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_particles"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="particles" type="RID"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="normal_map" type="RID"> + </argument> + <argument index="4" name="h_frames" type="int"> + </argument> + <argument index="5" name="v_frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_polygon"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="4" name="texture" type="RID"> + </argument> + <argument index="5" name="normal_map" type="RID"> + </argument> + <argument index="6" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_polyline"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="width" type="float" default="1.0"> + </argument> + <argument index="4" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_primitive"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="points" type="PoolVector2Array"> + </argument> + <argument index="2" name="colors" type="PoolColorArray"> + </argument> + <argument index="3" name="uvs" type="PoolVector2Array"> + </argument> + <argument index="4" name="texture" type="RID"> + </argument> + <argument index="5" name="width" type="float" default="1.0"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_set_transform"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_texture_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="tile" type="bool" default="false"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="5" name="transpose" type="bool" default="false"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_texture_rect_region"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <argument index="3" name="src_rect" type="Rect2"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="5" name="transpose" type="bool" default="false"> + </argument> + <argument index="6" name="normal_map" type="RID"> + </argument> + <argument index="7" name="clip_uv" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_add_triangle_array"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="indices" type="PoolIntArray"> + </argument> + <argument index="2" name="points" type="PoolVector2Array"> + </argument> + <argument index="3" name="colors" type="PoolColorArray"> + </argument> + <argument index="4" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="5" name="texture" type="RID"> + </argument> + <argument index="6" name="count" type="int" default="-1"> + </argument> + <argument index="7" name="normal_map" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_clear"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_item_set_clip"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="clip" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_copy_to_backbuffer"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <argument index="2" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_custom_rect"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="use_custom_rect" type="bool"> + </argument> + <argument index="2" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_distance_field_mode"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_draw_behind_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_draw_index"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_light_mask"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_material"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_modulate"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="parent" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_self_modulate"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_sort_children_by_y"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_transform"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_use_parent_material"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_visible"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="visible" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_z"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="z" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_item_set_z_as_relative_to_parent"> + <return type="void"> + </return> + <argument index="0" name="item" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_attach_to_canvas"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_light_occluder_attach_to_canvas"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_enabled"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_light_mask"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_polygon"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="polygon" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_occluder_set_transform"> + <return type="void"> + </return> + <argument index="0" name="occluder" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_color"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_enabled"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_energy"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_height"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_item_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_item_shadow_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_layer_range"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="min_layer" type="int"> + </argument> + <argument index="2" name="max_layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_mode"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.CanvasLightMode"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_scale"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_buffer_size"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_enabled"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_filter"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="filter" type="int" enum="VisualServer.CanvasLightShadowFilter"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_gradient_length"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_shadow_smooth"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="smooth" type="float"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_texture"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_texture_offset"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_transform"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="canvas_light_set_z_range"> + <return type="void"> + </return> + <argument index="0" name="light" type="RID"> + </argument> + <argument index="1" name="min_z" type="int"> + </argument> + <argument index="2" name="max_z" type="int"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_cull_mode"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.CanvasOccluderPolygonCullMode"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_shape"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="shape" type="PoolVector2Array"> + </argument> + <argument index="2" name="closed" type="bool"> + </argument> + <description> + </description> + </method> + <method name="canvas_occluder_polygon_set_shape_as_lines"> + <return type="void"> + </return> + <argument index="0" name="occluder_polygon" type="RID"> + </argument> + <argument index="1" name="shape" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="canvas_set_item_mirroring"> + <return type="void"> + </return> + <argument index="0" name="canvas" type="RID"> + </argument> + <argument index="1" name="item" type="RID"> + </argument> + <argument index="2" name="mirroring" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="canvas_set_modulate"> + <return type="void"> + </return> + <argument index="0" name="canvas" type="RID"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="draw"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="finish"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="force_draw"> <return type="void"> </return> @@ -24,6 +838,380 @@ <description> </description> </method> + <method name="free"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + </description> + </method> + <method name="get_render_info"> + <return type="int"> + </return> + <argument index="0" name="info" type="int" enum="VisualServer.RenderInfo"> + </argument> + <description> + </description> + </method> + <method name="get_test_cube"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_test_texture"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_white_texture"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="has_changed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="has_feature" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="feature" type="int" enum="VisualServer.Features"> + </argument> + <description> + </description> + </method> + <method name="has_os_feature" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="feature" type="String"> + </argument> + <description> + </description> + </method> + <method name="init"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="make_sphere_mesh"> + <return type="RID"> + </return> + <argument index="0" name="latitudes" type="int"> + </argument> + <argument index="1" name="longitudes" type="int"> + </argument> + <argument index="2" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="material_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="material_get_param" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="parameter" type="String"> + </argument> + <description> + </description> + </method> + <method name="material_get_shader" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="shader_material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="material_set_line_width"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="width" type="float"> + </argument> + <description> + </description> + </method> + <method name="material_set_next_pass"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="next_material" type="RID"> + </argument> + <description> + </description> + </method> + <method name="material_set_param"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="parameter" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="material_set_render_priority"> + <return type="void"> + </return> + <argument index="0" name="material" type="RID"> + </argument> + <argument index="1" name="priority" type="int"> + </argument> + <description> + </description> + </method> + <method name="material_set_shader"> + <return type="void"> + </return> + <argument index="0" name="shader_material" type="RID"> + </argument> + <argument index="1" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_add_surface_from_arrays"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="primtive" type="int" enum="VisualServer.PrimitiveType"> + </argument> + <argument index="2" name="arrays" type="Array"> + </argument> + <argument index="3" name="blend_shapes" type="Array" default="[ ]"> + </argument> + <argument index="4" name="compress_format" type="int" default="97792"> + </argument> + <description> + </description> + </method> + <method name="mesh_clear"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="mesh_get_blend_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_blend_shape_mode" qualifiers="const"> + <return type="int" enum="VisualServer.BlendShapeMode"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_custom_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_get_surface_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <description> + </description> + </method> + <method name="mesh_remove_surface"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_blend_shape_count"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_blend_shape_mode"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="VisualServer.BlendShapeMode"> + </argument> + <description> + </description> + </method> + <method name="mesh_set_custom_aabb"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array_index_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_array_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_blend_shape_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_format" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_index_array" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_material" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_primitive_type" qualifiers="const"> + <return type="int" enum="VisualServer.PrimitiveType"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_get_skeleton_aabb" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="mesh_surface_set_material"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="RID"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="material" type="RID"> + </argument> + <description> + </description> + </method> <method name="request_frame_drawn_callback"> <return type="void"> </return> @@ -38,6 +1226,128 @@ The callback method must use only 1 argument which will be called with 'userdata'. </description> </method> + <method name="set_boot_image"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="scale" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_debug_generate_wireframes"> + <return type="void"> + </return> + <argument index="0" name="generate" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_default_clear_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="shader_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="shader_get_code" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shader_get_default_texture_param" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="shader_get_param_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shader_set_code"> + <return type="void"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="code" type="String"> + </argument> + <description> + </description> + </method> + <method name="shader_set_default_texture_param"> + <return type="void"> + </return> + <argument index="0" name="shader" type="RID"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <argument index="2" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="sky_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="sky_set_texture"> + <return type="void"> + </return> + <argument index="0" name="sky" type="RID"> + </argument> + <argument index="1" name="cube_map" type="RID"> + </argument> + <argument index="2" name="radiance_size" type="int"> + </argument> + <description> + </description> + </method> + <method name="sync"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="texture_allocate"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="4" name="flags" type="int" default="7"> + </argument> + <description> + </description> + </method> <method name="texture_create"> <return type="RID"> </return> @@ -54,6 +1364,22 @@ <description> </description> </method> + <method name="texture_debug_usage"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="texture_get_data" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + </argument> + <description> + </description> + </method> <method name="texture_get_flags" qualifiers="const"> <return type="int"> </return> @@ -62,6 +1388,14 @@ <description> </description> </method> + <method name="texture_get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_height" qualifiers="const"> <return type="int"> </return> @@ -70,6 +1404,22 @@ <description> </description> </method> + <method name="texture_get_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="texture_get_texid" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_width" qualifiers="const"> <return type="int"> </return> @@ -78,6 +1428,18 @@ <description> </description> </method> + <method name="texture_set_data"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="image" type="Image"> + </argument> + <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + </argument> + <description> + </description> + </method> <method name="texture_set_flags"> <return type="void"> </return> @@ -88,6 +1450,16 @@ <description> </description> </method> + <method name="texture_set_path"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <description> + </description> + </method> <method name="texture_set_shrink_all_x2_on_set_data"> <return type="void"> </return> @@ -96,7 +1468,641 @@ <description> </description> </method> + <method name="texture_set_size_override"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="textures_keep_original"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_camera"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="camera" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_attach_to_screen"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> + </argument> + <argument index="2" name="screen" type="int" default="0"> + </argument> + <description> + </description> + </method> + <method name="viewport_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="viewport_detach"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_get_render_info"> + <return type="int"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="info" type="int" enum="VisualServer.ViewportRenderInfo"> + </argument> + <description> + </description> + </method> + <method name="viewport_get_texture" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_remove_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_active"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_canvas_layer"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <argument index="2" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="canvas" type="RID"> + </argument> + <argument index="2" name="offset" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_clear_mode"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_debug_draw"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_disable_3d"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_disable_environment"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_global_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hdr"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hide_canvas"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_hide_scenario"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_msaa"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="msaa" type="int" enum="VisualServer.ViewportMSAA"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_parent_viewport"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="parent_viewport" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_scenario"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="scenario" type="RID"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_shadow_atlas_quadrant_subdivision"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="quadrant" type="int"> + </argument> + <argument index="2" name="subdivision" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_shadow_atlas_size"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_size"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <argument index="2" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_transparent_background"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_update_mode"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="update_mode" type="int" enum="VisualServer.ViewportUpdateMode"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_usage"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="usage" type="int" enum="VisualServer.ViewportUsage"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_use_arvr"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="use_arvr" type="bool"> + </argument> + <description> + </description> + </method> + <method name="viewport_set_vflip"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="RID"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> </methods> <constants> + <constant name="NO_INDEX_ARRAY" value="-1" enum=""> + </constant> + <constant name="ARRAY_WEIGHTS_SIZE" value="4" enum=""> + </constant> + <constant name="CANVAS_ITEM_Z_MIN" value="-4096" enum=""> + </constant> + <constant name="CANVAS_ITEM_Z_MAX" value="4096" enum=""> + </constant> + <constant name="MAX_GLOW_LEVELS" value="7" enum=""> + </constant> + <constant name="MAX_CURSORS" value="8" enum=""> + </constant> + <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128" enum=""> + </constant> + <constant name="MATERIAL_RENDER_PRIORITY_MAX" value="127" enum=""> + </constant> + <constant name="CUBEMAP_LEFT" value="0"> + </constant> + <constant name="CUBEMAP_RIGHT" value="1"> + </constant> + <constant name="CUBEMAP_BOTTOM" value="2"> + </constant> + <constant name="CUBEMAP_TOP" value="3"> + </constant> + <constant name="CUBEMAP_FRONT" value="4"> + </constant> + <constant name="CUBEMAP_BACK" value="5"> + </constant> + <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> + </constant> + <constant name="TEXTURE_FLAG_REPEAT" value="2"> + </constant> + <constant name="TEXTURE_FLAG_FILTER" value="4"> + </constant> + <constant name="TEXTURE_FLAG_ANISOTROPIC_FILTER" value="8"> + </constant> + <constant name="TEXTURE_FLAG_CONVERT_TO_LINEAR" value="16"> + </constant> + <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32"> + </constant> + <constant name="TEXTURE_FLAG_CUBEMAP" value="2048"> + </constant> + <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096"> + </constant> + <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> + </constant> + <constant name="SHADER_SPATIAL" value="0"> + </constant> + <constant name="SHADER_CANVAS_ITEM" value="1"> + </constant> + <constant name="SHADER_PARTICLES" value="2"> + </constant> + <constant name="SHADER_MAX" value="3"> + </constant> + <constant name="ARRAY_VERTEX" value="0"> + </constant> + <constant name="ARRAY_NORMAL" value="1"> + </constant> + <constant name="ARRAY_TANGENT" value="2"> + </constant> + <constant name="ARRAY_COLOR" value="3"> + </constant> + <constant name="ARRAY_TEX_UV" value="4"> + </constant> + <constant name="ARRAY_TEX_UV2" value="5"> + </constant> + <constant name="ARRAY_BONES" value="6"> + </constant> + <constant name="ARRAY_WEIGHTS" value="7"> + </constant> + <constant name="ARRAY_INDEX" value="8"> + </constant> + <constant name="ARRAY_MAX" value="9"> + </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + </constant> + <constant name="ARRAY_FORMAT_COLOR" value="8"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + </constant> + <constant name="ARRAY_COMPRESS_BASE" value="9"> + </constant> + <constant name="ARRAY_COMPRESS_VERTEX" value="512"> + </constant> + <constant name="ARRAY_COMPRESS_NORMAL" value="1024"> + </constant> + <constant name="ARRAY_COMPRESS_TANGENT" value="2048"> + </constant> + <constant name="ARRAY_COMPRESS_COLOR" value="4096"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV" value="8192"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384"> + </constant> + <constant name="ARRAY_COMPRESS_BONES" value="32768"> + </constant> + <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536"> + </constant> + <constant name="ARRAY_COMPRESS_INDEX" value="131072"> + </constant> + <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144"> + </constant> + <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288"> + </constant> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97792"> + </constant> + <constant name="PRIMITIVE_POINTS" value="0"> + </constant> + <constant name="PRIMITIVE_LINES" value="1"> + </constant> + <constant name="PRIMITIVE_LINE_STRIP" value="2"> + </constant> + <constant name="PRIMITIVE_LINE_LOOP" value="3"> + </constant> + <constant name="PRIMITIVE_TRIANGLES" value="4"> + </constant> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + </constant> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + </constant> + <constant name="PRIMITIVE_MAX" value="7"> + </constant> + <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0"> + </constant> + <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1"> + </constant> + <constant name="LIGHT_DIRECTIONAL" value="0"> + </constant> + <constant name="LIGHT_OMNI" value="1"> + </constant> + <constant name="LIGHT_SPOT" value="2"> + </constant> + <constant name="LIGHT_PARAM_ENERGY" value="0"> + </constant> + <constant name="LIGHT_PARAM_SPECULAR" value="1"> + </constant> + <constant name="LIGHT_PARAM_RANGE" value="2"> + </constant> + <constant name="LIGHT_PARAM_ATTENUATION" value="3"> + </constant> + <constant name="LIGHT_PARAM_SPOT_ANGLE" value="4"> + </constant> + <constant name="LIGHT_PARAM_SPOT_ATTENUATION" value="5"> + </constant> + <constant name="LIGHT_PARAM_CONTACT_SHADOW_SIZE" value="6"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_MAX_DISTANCE" value="7"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET" value="8"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET" value="9"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET" value="10"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_NORMAL_BIAS" value="11"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_BIAS" value="12"> + </constant> + <constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="13"> + </constant> + <constant name="LIGHT_PARAM_MAX" value="14"> + </constant> + <constant name="VIEWPORT_UPDATE_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_UPDATE_ONCE" value="1"> + </constant> + <constant name="VIEWPORT_UPDATE_WHEN_VISIBLE" value="2"> + </constant> + <constant name="VIEWPORT_UPDATE_ALWAYS" value="3"> + </constant> + <constant name="VIEWPORT_CLEAR_ALWAYS" value="0"> + </constant> + <constant name="VIEWPORT_CLEAR_NEVER" value="1"> + </constant> + <constant name="VIEWPORT_CLEAR_ONLY_NEXT_FRAME" value="2"> + </constant> + <constant name="VIEWPORT_MSAA_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_MSAA_2X" value="1"> + </constant> + <constant name="VIEWPORT_MSAA_4X" value="2"> + </constant> + <constant name="VIEWPORT_MSAA_8X" value="3"> + </constant> + <constant name="VIEWPORT_MSAA_16X" value="4"> + </constant> + <constant name="VIEWPORT_USAGE_2D" value="0"> + </constant> + <constant name="VIEWPORT_USAGE_2D_NO_SAMPLING" value="1"> + </constant> + <constant name="VIEWPORT_USAGE_3D" value="2"> + </constant> + <constant name="VIEWPORT_USAGE_3D_NO_EFFECTS" value="3"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="VIEWPORT_RENDER_INFO_MAX" value="6"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_UNSHADED" value="1"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="2"> + </constant> + <constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="3"> + </constant> + <constant name="SCENARIO_DEBUG_DISABLED" value="0"> + </constant> + <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> + </constant> + <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> + </constant> + <constant name="SCENARIO_DEBUG_SHADELESS" value="3"> + </constant> + <constant name="INSTANCE_NONE" value="0"> + </constant> + <constant name="INSTANCE_MESH" value="1"> + </constant> + <constant name="INSTANCE_MULTIMESH" value="2"> + </constant> + <constant name="INSTANCE_IMMEDIATE" value="3"> + </constant> + <constant name="INSTANCE_PARTICLES" value="4"> + </constant> + <constant name="INSTANCE_LIGHT" value="5"> + </constant> + <constant name="INSTANCE_REFLECTION_PROBE" value="6"> + </constant> + <constant name="INSTANCE_GI_PROBE" value="7"> + </constant> + <constant name="INSTANCE_MAX" value="8"> + </constant> + <constant name="INSTANCE_GEOMETRY_MASK" value="30"> + </constant> + <constant name="NINE_PATCH_STRETCH" value="0"> + </constant> + <constant name="NINE_PATCH_TILE" value="1"> + </constant> + <constant name="NINE_PATCH_TILE_FIT" value="2"> + </constant> + <constant name="CANVAS_LIGHT_MODE_ADD" value="0"> + </constant> + <constant name="CANVAS_LIGHT_MODE_SUB" value="1"> + </constant> + <constant name="CANVAS_LIGHT_MODE_MIX" value="2"> + </constant> + <constant name="CANVAS_LIGHT_MODE_MASK" value="3"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_NONE" value="0"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF3" value="1"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF5" value="2"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF7" value="3"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF9" value="4"> + </constant> + <constant name="CANVAS_LIGHT_FILTER_PCF13" value="5"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_DISABLED" value="0"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE" value="1"> + </constant> + <constant name="CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE" value="2"> + </constant> + <constant name="INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="6"> + </constant> + <constant name="INFO_VIDEO_MEM_USED" value="7"> + </constant> + <constant name="INFO_TEXTURE_MEM_USED" value="8"> + </constant> + <constant name="INFO_VERTEX_MEM_USED" value="9"> + </constant> + <constant name="FEATURE_SHADERS" value="0"> + </constant> + <constant name="FEATURE_MULTITHREADED" value="1"> + </constant> </constants> </class> |