diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 61c535f0d..34a3c8b47 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -14,13 +14,13 @@ Brief Description Built-in GDScript functions. -Member Functions ----------------- +Methods +------- +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | +| :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** | +| :ref:`Color` | :ref:`ColorN` **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`abs` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,17 +34,17 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | +| :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`ceil` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | +| :ref:`String` | :ref:`char` **(** :ref:`int` ascii **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`clamp` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | +| :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`cos` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,7 +58,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`deg2rad` **(** :ref:`float` deg **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | +| :ref:`Object` | :ref:`dict2inst` **(** :ref:`Dictionary` dict **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`ease` **(** :ref:`float` s, :ref:`float` curve **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,31 +70,31 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`fposmod` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | +| :ref:`FuncRef` | :ref:`funcref` **(** :ref:`Object` instance, :ref:`String` funcname **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_stack` **(** **)** | +| :ref:`Array` | :ref:`get_stack` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | +| :ref:`int` | :ref:`hash` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | +| :ref:`Dictionary` | :ref:`inst2dict` **(** :ref:`Object` inst **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | +| :ref:`Object` | :ref:`instance_from_id` **(** :ref:`int` instance_id **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_instance_valid` **(** :ref:`Object` instance **)** | +| :ref:`bool` | :ref:`is_instance_valid` **(** :ref:`Object` instance **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | +| :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lerp` **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** | +| :ref:`float` | :ref:`lerp` **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear2db` **(** :ref:`float` nrg **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`log` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,13 +104,13 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`nearest_po2` **(** :ref:`int` value **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | +| :ref:`Variant` | :ref:`parse_json` **(** :ref:`String` json **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | +| :ref:`Vector2` | :ref:`polar2cartesian` **(** :ref:`float` r, :ref:`float` th **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`pow` **(** :ref:`float` x, :ref:`float` y **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | +| :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print` **(** **)** vararg | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,7 +130,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | +| :ref:`Array` | :ref:`rand_seed` **(** :ref:`int` seed **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`randf` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -138,7 +138,7 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`randomize` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`range` **(** **)** vararg | +| :ref:`Array` | :ref:`range` **(** **)** vararg | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -156,37 +156,37 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`str` **(** **)** vararg | +| :ref:`String` | :ref:`str` **(** **)** vararg | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | +| :ref:`Variant` | :ref:`str2var` **(** :ref:`String` string **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tan` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tanh` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | +| :ref:`String` | :ref:`to_json` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | +| :ref:`bool` | :ref:`type_exists` **(** :ref:`String` type **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | +| :ref:`int` | :ref:`typeof` **(** :ref:`Variant` what **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | +| :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | +| :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | +| :ref:`WeakRef` | :ref:`weakref` **(** :ref:`Object` obj **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`wrapf` **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`wrapi` **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object=null, :ref:`String` signal="" **)** | +| :ref:`GDScriptFunctionState` | :ref:`yield` **(** :ref:`Object` object=null, :ref:`String` signal="" **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ +Constants +--------- - **PI** = **3.141593** --- Constant that represents how many times the diameter of a circle fits around its perimeter. - **TAU** = **6.283185** --- The circle constant, the circumference of the unit circle. @@ -200,12 +200,12 @@ Description List of core built-in GDScript functions. Math functions and other utilities. Everything else is provided by objects. (Keywords: builtin, built in, global functions.) -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_@GDScript_Color8: -- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** +- :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. @@ -223,7 +223,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha .. _class_@GDScript_ColorN: -- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** +- :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** Returns a color according to the standardised ``name`` with ``alpha`` ranging from 0 to 1. @@ -306,13 +306,13 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` .. _class_@GDScript_bytes2var: -- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** +- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** Decodes a byte array back to a value. .. _class_@GDScript_cartesian2polar: -- :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`Vector2` **cartesian2polar** **(** :ref:`float` x, :ref:`float` y **)** Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). @@ -329,7 +329,7 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than .. _class_@GDScript_char: -- :ref:`String` **char** **(** :ref:`int` ascii **)** +- :ref:`String` **char** **(** :ref:`int` ascii **)** Returns a character as a String of the given ASCII code. @@ -358,9 +358,9 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m .. _class_@GDScript_convert: -- :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** +- :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** -Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@GlobalScope`. +Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@GlobalScope`. :: @@ -436,7 +436,7 @@ Returns degrees converted to radians. .. _class_@GDScript_dict2inst: -- :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** +- :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. @@ -512,9 +512,9 @@ Produces: .. _class_@GDScript_funcref: -- :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** +- :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** -Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef` in a variable and call it later. +Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef` in a variable and call it later. :: @@ -526,11 +526,11 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n .. _class_@GDScript_get_stack: -- void **get_stack** **(** **)** +- :ref:`Array` **get_stack** **(** **)** .. _class_@GDScript_hash: -- :ref:`int` **hash** **(** :ref:`Variant` var **)** +- :ref:`int` **hash** **(** :ref:`Variant` var **)** Returns the integer hash of the variable passed. @@ -540,7 +540,7 @@ Returns the integer hash of the variable passed. .. _class_@GDScript_inst2dict: -- :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** +- :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** Returns the passed instance converted to a dictionary (useful for serializing). @@ -561,7 +561,7 @@ Prints out: .. _class_@GDScript_instance_from_id: -- :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** +- :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** Returns the Object that corresponds to ``instance_id``. All Objects have a unique instance ID. @@ -591,7 +591,7 @@ Returns True/False whether ``s`` is an infinity value (either positive infinity .. _class_@GDScript_is_instance_valid: -- :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** +- :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** .. _class_@GDScript_is_nan: @@ -601,7 +601,7 @@ Returns True/False whether ``s`` is a NaN (Not-A-Number) value. .. _class_@GDScript_len: -- :ref:`int` **len** **(** :ref:`Variant` var **)** +- :ref:`int` **len** **(** :ref:`Variant` var **)** Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. @@ -614,7 +614,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem .. _class_@GDScript_lerp: -- :ref:`float` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** +- :ref:`float` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** Linearly interpolates between two values by a normalized value. @@ -630,7 +630,7 @@ Converts from linear energy to decibels (audio). .. _class_@GDScript_load: -- :ref:`Resource` **load** **(** :ref:`String` path **)** +- :ref:`Resource` **load** **(** :ref:`String` path **)** Loads a resource from the filesystem located at ``path``. @@ -689,7 +689,7 @@ Returns the nearest larger power of 2 for integer ``value``. .. _class_@GDScript_parse_json: -- :ref:`Variant` **parse_json** **(** :ref:`String` json **)** +- :ref:`Variant` **parse_json** **(** :ref:`String` json **)** Parse JSON text to a Variant (use :ref:`typeof` to check if it is what you expect). @@ -707,7 +707,7 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y .. _class_@GDScript_polar2cartesian: -- :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** +- :ref:`Vector2` **polar2cartesian** **(** :ref:`float` r, :ref:`float` th **)** Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis). @@ -723,7 +723,7 @@ Returns the result of ``x`` raised to the power of ``y``. .. _class_@GDScript_preload: -- :ref:`Resource` **preload** **(** :ref:`String` path **)** +- :ref:`Resource` **preload** **(** :ref:`String` path **)** Returns a resource from the filesystem that is loaded during script parsing. @@ -825,7 +825,7 @@ Random range, any floating point value between ``from`` and ``to``. .. _class_@GDScript_rand_seed: -- :ref:`Array` **rand_seed** **(** :ref:`int` seed **)** +- :ref:`Array` **rand_seed** **(** :ref:`int` seed **)** Random from seed: pass a ``seed``, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. @@ -864,7 +864,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr .. _class_@GDScript_range: -- :ref:`Array` **range** **(** **)** vararg +- :ref:`Array` **range** **(** **)** vararg Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). @@ -976,7 +976,7 @@ Snaps float value ``s`` to a given ``step``. .. _class_@GDScript_str: -- :ref:`String` **str** **(** **)** vararg +- :ref:`String` **str** **(** **)** vararg Converts one or more arguments to string in the best way possible. @@ -989,7 +989,7 @@ Converts one or more arguments to string in the best way possible. .. _class_@GDScript_str2var: -- :ref:`Variant` **str2var** **(** :ref:`String` string **)** +- :ref:`Variant` **str2var** **(** :ref:`String` string **)** Converts a formatted string that was returned by :ref:`var2str` to the original value. @@ -1022,7 +1022,7 @@ Returns the hyperbolic tangent of ``s``. .. _class_@GDScript_to_json: -- :ref:`String` **to_json** **(** :ref:`Variant` var **)** +- :ref:`String` **to_json** **(** :ref:`Variant` var **)** Converts a Variant ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network. @@ -1034,9 +1034,9 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial .. _class_@GDScript_type_exists: -- :ref:`bool` **type_exists** **(** :ref:`String` type **)** +- :ref:`bool` **type_exists** **(** :ref:`String` type **)** -Returns whether the given class exists in :ref:`ClassDB`. +Returns whether the given class exists in :ref:`ClassDB`. :: @@ -1045,9 +1045,9 @@ Returns whether the given class exists in :ref:`ClassDB`. .. _class_@GDScript_typeof: -- :ref:`int` **typeof** **(** :ref:`Variant` what **)** +- :ref:`int` **typeof** **(** :ref:`Variant` what **)** -Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@GlobalScope`. +Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@GlobalScope`. :: @@ -1059,7 +1059,7 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i .. _class_@GDScript_validate_json: -- :ref:`String` **validate_json** **(** :ref:`String` json **)** +- :ref:`String` **validate_json** **(** :ref:`String` json **)** Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns error message if not valid. @@ -1074,13 +1074,13 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns .. _class_@GDScript_var2bytes: -- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** +- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** Encodes a variable value to a byte array. .. _class_@GDScript_var2str: -- :ref:`String` **var2str** **(** :ref:`Variant` var **)** +- :ref:`String` **var2str** **(** :ref:`Variant` var **)** Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var`. @@ -1100,7 +1100,7 @@ prints .. _class_@GDScript_weakref: -- :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** +- :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** Returns a weak reference to an object. @@ -1154,7 +1154,7 @@ Usable for creating loop-alike behavior or infinite surfaces. .. _class_@GDScript_yield: -- :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** +- :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** Stops the function execution and returns the current suspended state to the calling function. diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index a453dc8b9..31144cbb0 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -14,101 +14,8 @@ Brief Description Global scope constants and variables. -Member Variables ----------------- - - .. _class_@GlobalScope_ARVRServer: - -- :ref:`ARVRServer` **ARVRServer** - :ref:`ARVRServer` singleton - - .. _class_@GlobalScope_AudioServer: - -- :ref:`AudioServer` **AudioServer** - :ref:`AudioServer` singleton - - .. _class_@GlobalScope_ClassDB: - -- :ref:`ClassDB` **ClassDB** - :ref:`ClassDB` singleton - - .. _class_@GlobalScope_Engine: - -- :ref:`Engine` **Engine** - :ref:`Engine` singleton - - .. _class_@GlobalScope_Geometry: - -- :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton - - .. _class_@GlobalScope_IP: - -- :ref:`IP` **IP** - :ref:`IP` singleton - - .. _class_@GlobalScope_Input: - -- :ref:`Input` **Input** - :ref:`Input` singleton - - .. _class_@GlobalScope_InputMap: - -- :ref:`InputMap` **InputMap** - :ref:`InputMap` singleton - - .. _class_@GlobalScope_JSON: - -- :ref:`JSON` **JSON** - :ref:`JSON` singleton - - .. _class_@GlobalScope_JavaScript: - -- :ref:`JavaScript` **JavaScript** - :ref:`JavaScript` singleton - - .. _class_@GlobalScope_Marshalls: - -- :ref:`Reference` **Marshalls** - :ref:`Marshalls` singleton - - .. _class_@GlobalScope_OS: - -- :ref:`OS` **OS** - :ref:`OS` singleton - - .. _class_@GlobalScope_Performance: - -- :ref:`Performance` **Performance** - :ref:`Performance` singleton - - .. _class_@GlobalScope_Physics2DServer: - -- :ref:`Physics2DServer` **Physics2DServer** - :ref:`Physics2DServer` singleton - - .. _class_@GlobalScope_PhysicsServer: - -- :ref:`PhysicsServer` **PhysicsServer** - :ref:`PhysicsServer` singleton - - .. _class_@GlobalScope_ProjectSettings: - -- :ref:`ProjectSettings` **ProjectSettings** - :ref:`ProjectSettings` singleton - - .. _class_@GlobalScope_ResourceLoader: - -- :ref:`ResourceLoader` **ResourceLoader** - :ref:`ResourceLoader` singleton - - .. _class_@GlobalScope_ResourceSaver: - -- :ref:`ResourceSaver` **ResourceSaver** - :ref:`ResourceSaver` singleton - - .. _class_@GlobalScope_TranslationServer: - -- :ref:`TranslationServer` **TranslationServer** - :ref:`TranslationServer` singleton - - .. _class_@GlobalScope_VisualScriptEditor: - -- :ref:`VisualScriptEditor` **VisualScriptEditor** - :ref:`VisualScriptEditor` singleton - - .. _class_@GlobalScope_VisualServer: - -- :ref:`VisualServer` **VisualServer** - :ref:`VisualServer` singleton - - -Numeric Constants ------------------ - -- **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. - -Enums ------ +Enumerations +------------ .. _enum_@GlobalScope_Variant.Operator: @@ -158,8 +65,8 @@ enum **MethodFlags** enum **Orientation** -- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. -- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. +- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. +- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator`, :ref:`ScrollBar`, :ref:`Slider`, etc. .. _enum_@GlobalScope_PropertyUsageFlags: @@ -625,39 +532,39 @@ enum **Variant.Type** - **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool`. - **TYPE_INT** = **2** --- Variable is of type :ref:`int`. - **TYPE_REAL** = **3** --- Variable is of type :ref:`float`/real. -- **TYPE_STRING** = **4** --- Variable is of type :ref:`String`. -- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2`. -- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2`. -- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3`. -- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D`. -- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. -- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. -- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. -- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. -- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. -- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. -- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath`. -- **TYPE_RID** = **16** --- Variable is of type :ref:`RID`. -- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object`. -- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary`. -- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array`. -- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray`. -- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray`. -- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray`. -- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray`. -- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array`. -- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array`. -- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray`. +- **TYPE_STRING** = **4** --- Variable is of type :ref:`String`. +- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2`. +- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2`. +- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3`. +- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D`. +- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. +- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. +- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. +- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. +- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. +- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. +- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath`. +- **TYPE_RID** = **16** --- Variable is of type :ref:`RID`. +- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object`. +- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary`. +- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array`. +- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray`. +- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray`. +- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray`. +- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray`. +- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array`. +- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array`. +- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray`. - **TYPE_MAX** = **27** --- Marker for end of type constants. .. _enum_@GlobalScope_Margin: enum **Margin** -- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. -- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. +- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control` or :ref:`StyleBox` derived classes. .. _enum_@GlobalScope_ButtonList: @@ -679,6 +586,11 @@ enum **ButtonList** - **BUTTON_MASK_XBUTTON2** = **256** +Constants +--------- + +- **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. + Description ----------- @@ -686,3 +598,95 @@ Global scope constants and variables. This is all that resides in the globals, c Singletons are also documented here, since they can be accessed from anywhere. +Property Descriptions +--------------------- + + .. _class_@GlobalScope_ARVRServer: + +- :ref:`ARVRServer` **ARVRServer** - :ref:`ARVRServer` singleton + + .. _class_@GlobalScope_AudioServer: + +- :ref:`AudioServer` **AudioServer** - :ref:`AudioServer` singleton + + .. _class_@GlobalScope_ClassDB: + +- :ref:`ClassDB` **ClassDB** - :ref:`ClassDB` singleton + + .. _class_@GlobalScope_Engine: + +- :ref:`Engine` **Engine** - :ref:`Engine` singleton + + .. _class_@GlobalScope_Geometry: + +- :ref:`Geometry` **Geometry** - :ref:`Geometry` singleton + + .. _class_@GlobalScope_GodotSharp: + +- :ref:`GodotSharp` **GodotSharp** + + .. _class_@GlobalScope_IP: + +- :ref:`IP` **IP** - :ref:`IP` singleton + + .. _class_@GlobalScope_Input: + +- :ref:`Input` **Input** - :ref:`Input` singleton + + .. _class_@GlobalScope_InputMap: + +- :ref:`InputMap` **InputMap** - :ref:`InputMap` singleton + + .. _class_@GlobalScope_JSON: + +- :ref:`JSON` **JSON** - :ref:`JSON` singleton + + .. _class_@GlobalScope_JavaScript: + +- :ref:`JavaScript` **JavaScript** - :ref:`JavaScript` singleton + + .. _class_@GlobalScope_Marshalls: + +- :ref:`Reference` **Marshalls** - :ref:`Marshalls` singleton + + .. _class_@GlobalScope_OS: + +- :ref:`OS` **OS** - :ref:`OS` singleton + + .. _class_@GlobalScope_Performance: + +- :ref:`Performance` **Performance** - :ref:`Performance` singleton + + .. _class_@GlobalScope_Physics2DServer: + +- :ref:`Physics2DServer` **Physics2DServer** - :ref:`Physics2DServer` singleton + + .. _class_@GlobalScope_PhysicsServer: + +- :ref:`PhysicsServer` **PhysicsServer** - :ref:`PhysicsServer` singleton + + .. _class_@GlobalScope_ProjectSettings: + +- :ref:`ProjectSettings` **ProjectSettings** - :ref:`ProjectSettings` singleton + + .. _class_@GlobalScope_ResourceLoader: + +- :ref:`ResourceLoader` **ResourceLoader** - :ref:`ResourceLoader` singleton + + .. _class_@GlobalScope_ResourceSaver: + +- :ref:`ResourceSaver` **ResourceSaver** - :ref:`ResourceSaver` singleton + + .. _class_@GlobalScope_TranslationServer: + +- :ref:`TranslationServer` **TranslationServer** - :ref:`TranslationServer` singleton + + .. _class_@GlobalScope_VisualScriptEditor: + +- :ref:`VisualScriptEditor` **VisualScriptEditor** - :ref:`VisualScriptEditor` singleton + + .. _class_@GlobalScope_VisualServer: + +- :ref:`VisualServer` **VisualServer** - :ref:`VisualServer` singleton + + diff --git a/classes/class_@visualscript.rst b/classes/class_@visualscript.rst index f6c2fbb90..ccf1dceb8 100644 --- a/classes/class_@visualscript.rst +++ b/classes/class_@visualscript.rst @@ -17,5 +17,5 @@ Built-in visual script functions. Description ----------- -A list of built-in visual script functions, see :ref:`VisualScriptBuiltinFunc` and :ref:`VisualScript`. +A list of built-in visual script functions, see :ref:`VisualScriptBuiltinFunc` and :ref:`VisualScript`. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 6355c8611..78ccfc449 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -14,69 +14,53 @@ Brief Description Axis-Aligned Bounding Box. -Member Functions ----------------- +Methods +------- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | +| :ref:`AABB` | :ref:`AABB` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | +| :ref:`bool` | :ref:`encloses` **(** :ref:`AABB` with **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | +| :ref:`AABB` | :ref:`expand` **(** :ref:`Vector3` to_point **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_area` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | +| :ref:`Vector3` | :ref:`get_endpoint` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | +| :ref:`Vector3` | :ref:`get_longest_axis` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_longest_axis_index` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_longest_axis_size` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | +| :ref:`Vector3` | :ref:`get_shortest_axis` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shortest_axis_index` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shortest_axis_size` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | +| :ref:`Vector3` | :ref:`get_support` **(** :ref:`Vector3` dir **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | +| :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_area` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_surface` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | +| :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | +| :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | +| :ref:`bool` | :ref:`intersects_plane` **(** :ref:`Plane` plane **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | +| :ref:`bool` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | +| :ref:`AABB` | :ref:`merge` **(** :ref:`AABB` with **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_AABB_end: - -- :ref:`Vector3` **end** - Ending corner. - - .. _class_AABB_position: - -- :ref:`Vector3` **position** - Beginning corner. - - .. _class_AABB_size: - -- :ref:`Vector3` **size** - Size from position to end. - - Description ----------- @@ -87,24 +71,40 @@ Tutorials - :doc:`../tutorials/math/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AABB_end: + +- :ref:`Vector3` **end** - Ending corner. + + .. _class_AABB_position: + +- :ref:`Vector3` **position** - Beginning corner. + + .. _class_AABB_size: + +- :ref:`Vector3` **size** - Size from position to end. + + +Method Descriptions +------------------- .. _class_AABB_AABB: -- :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** +- :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. .. _class_AABB_encloses: -- :ref:`bool` **encloses** **(** :ref:`AABB` with **)** +- :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this ``AABB`` completely encloses another one. .. _class_AABB_expand: -- :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** +- :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns this ``AABB`` expanded to include a given point. @@ -116,13 +116,13 @@ Gets the area of the ``AABB``. .. _class_AABB_get_endpoint: -- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** +- :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the ``AABB`` in space. .. _class_AABB_get_longest_axis: -- :ref:`Vector3` **get_longest_axis** **(** **)** +- :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the ``AABB``. @@ -130,7 +130,7 @@ Returns the normalized longest axis of the ``AABB``. - :ref:`int` **get_longest_axis_index** **(** **)** -Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). +Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). .. _class_AABB_get_longest_axis_size: @@ -140,7 +140,7 @@ Returns the scalar length of the longest axis of the ``AABB``. .. _class_AABB_get_shortest_axis: -- :ref:`Vector3` **get_shortest_axis** **(** **)** +- :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the ``AABB``. @@ -148,7 +148,7 @@ Returns the normalized shortest axis of the ``AABB``. - :ref:`int` **get_shortest_axis_index** **(** **)** -Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). +Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). .. _class_AABB_get_shortest_axis_size: @@ -158,13 +158,13 @@ Returns the scalar length of the shortest axis of the ``AABB``. .. _class_AABB_get_support: -- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** +- :ref:`Vector3` **get_support** **(** :ref:`Vector3` dir **)** Returns the support point in a given direction. This is useful for collision detection algorithms. .. _class_AABB_grow: -- :ref:`AABB` **grow** **(** :ref:`float` by **)** +- :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. @@ -182,37 +182,37 @@ Returns ``true`` if the ``AABB`` is empty. .. _class_AABB_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** +- :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the ``AABB`` contains a point. .. _class_AABB_intersection: -- :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** +- :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure. .. _class_AABB_intersects: -- :ref:`bool` **intersects** **(** :ref:`AABB` with **)** +- :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the ``AABB`` overlaps with another. .. _class_AABB_intersects_plane: -- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** +- :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the ``AABB`` is on both sides of a plane. .. _class_AABB_intersects_segment: -- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** +- :ref:`bool` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``. .. _class_AABB_merge: -- :ref:`AABB` **merge** **(** :ref:`AABB` with **)** +- :ref:`AABB` **merge** **(** :ref:`AABB` with **)** Returns a larger AABB that contains this AABB and ``with``. diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 2fcd680e0..5f20ce270 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -7,10 +7,8 @@ AcceptDialog ============ -**Inherits:** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`ConfirmationDialog` - +**Inherits:** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ConfirmationDialog` **Category:** Core Brief Description @@ -18,19 +16,19 @@ Brief Description Base dialog for user notification. -Member Functions ----------------- +Methods +------- +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | +| :ref:`Button` | :ref:`add_button` **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | +| :ref:`Button` | :ref:`add_cancel` **(** :ref:`String` name **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Label` | :ref:`get_label` **(** **)** | +| :ref:`Label` | :ref:`get_label` **(** **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_ok` **(** **)** | +| :ref:`Button` | :ref:`get_ok` **(** **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | +| void | :ref:`register_text_enter` **(** :ref:`Node` line_edit **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -44,36 +42,36 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed. .. _class_AcceptDialog_custom_action: -- **custom_action** **(** :ref:`String` action **)** +- **custom_action** **(** :ref:`String` action **)** Emitted when a custom button is pressed. See :ref:`add_button`. -Member Variables ----------------- - - .. _class_AcceptDialog_dialog_hide_on_ok: - -- :ref:`bool` **dialog_hide_on_ok** - If ``true`` the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. - -Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog` to disable hiding the dialog when pressing OK. - - .. _class_AcceptDialog_dialog_text: - -- :ref:`String` **dialog_text** - The text displayed by this dialog. - - Description ----------- This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AcceptDialog_dialog_hide_on_ok: + +- :ref:`bool` **dialog_hide_on_ok** - If ``true`` the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. + +Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog` to disable hiding the dialog when pressing OK. + + .. _class_AcceptDialog_dialog_text: + +- :ref:`String` **dialog_text** - The text displayed by this dialog. + + +Method Descriptions +------------------- .. _class_AcceptDialog_add_button: -- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** +- :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the :ref:`custom_action` signal when pressed. @@ -81,26 +79,26 @@ If ``true``, *right* will place the button to the right of any sibling buttons. .. _class_AcceptDialog_add_cancel: -- :ref:`Button` **add_cancel** **(** :ref:`String` name **)** +- :ref:`Button` **add_cancel** **(** :ref:`String` name **)** Adds a button with label *name* and a cancel action to the dialog and returns the created button. .. _class_AcceptDialog_get_label: -- :ref:`Label` **get_label** **(** **)** +- :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. .. _class_AcceptDialog_get_ok: -- :ref:`Button` **get_ok** **(** **)** +- :ref:`Button` **get_ok** **(** **)** Return the OK Button. .. _class_AcceptDialog_register_text_enter: -- void **register_text_enter** **(** :ref:`Node` line_edit **)** +- void **register_text_enter** **(** :ref:`Node` line_edit **)** -Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. +Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index ac0b9bd74..626eaae49 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -7,8 +7,7 @@ AnimatedSprite ============== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Sprite node that can use multiple textures for animation. -Member Functions ----------------- +Methods +------- +--------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +--------------------------+----------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | +| void | :ref:`play` **(** :ref:`String` anim="" **)** | +--------------------------+----------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +--------------------------+----------------------------------------------------------------------------------------+ @@ -43,12 +42,17 @@ Emitted when the animation is finished (when it plays the last frame). If the an Emitted when :ref:`frame` changed. -Member Variables ----------------- +Description +----------- + +Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. + +Property Descriptions +--------------------- .. _class_AnimatedSprite_animation: -- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. .. _class_AnimatedSprite_centered: @@ -68,11 +72,11 @@ Member Variables .. _class_AnimatedSprite_frames: -- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). +- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). .. _class_AnimatedSprite_offset: -- :ref:`Vector2` **offset** - The texture's drawing offset. +- :ref:`Vector2` **offset** - The texture's drawing offset. .. _class_AnimatedSprite_playing: @@ -83,13 +87,8 @@ Member Variables - :ref:`float` **speed_scale** -Description ------------ - -Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimatedSprite_is_playing: @@ -99,7 +98,7 @@ Return true if an animation if currently being played. .. _class_AnimatedSprite_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index b777bbc05..75ab61fe9 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -7,8 +7,7 @@ AnimatedSprite3D ================ -**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description 2D sprite node in 3D world, that can use multiple 2D textures for animation. -Member Functions ----------------- +Methods +------- +--------------------------+------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +--------------------------+------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | +| void | :ref:`play` **(** :ref:`String` anim="" **)** | +--------------------------+------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +--------------------------+------------------------------------------------------------------------------------------+ @@ -37,12 +36,17 @@ Signals Emitted when :ref:`frame` changed. -Member Variables ----------------- +Description +----------- + +Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. + +Property Descriptions +--------------------- .. _class_AnimatedSprite3D_animation: -- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. +- :ref:`String` **animation** - The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. .. _class_AnimatedSprite3D_frame: @@ -50,20 +54,15 @@ Member Variables .. _class_AnimatedSprite3D_frames: -- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). +- :ref:`SpriteFrames` **frames** - The :ref:`SpriteFrames` resource containing the animation(s). .. _class_AnimatedSprite3D_playing: - :ref:`bool` **playing** - If ``true`` the :ref:`animation` is currently playing. -Description ------------ - -Animations are created using a :ref:`SpriteFrames` resource, which can be configured in the editor via the SpriteFrames panel. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimatedSprite3D_is_playing: @@ -73,7 +72,7 @@ Return true if an animation if currently being played. .. _class_AnimatedSprite3D_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index b08168b0e..0351df64e 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -7,8 +7,7 @@ AnimatedTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimatedTexture_fps: @@ -29,7 +28,7 @@ Member Variables .. _class_AnimatedTexture_frame_0/texture: -- :ref:`Texture` **frame_0/texture** +- :ref:`Texture` **frame_0/texture** .. _class_AnimatedTexture_frame_1/delay_sec: @@ -37,7 +36,7 @@ Member Variables .. _class_AnimatedTexture_frame_1/texture: -- :ref:`Texture` **frame_1/texture** +- :ref:`Texture` **frame_1/texture** .. _class_AnimatedTexture_frame_10/delay_sec: @@ -45,7 +44,7 @@ Member Variables .. _class_AnimatedTexture_frame_10/texture: -- :ref:`Texture` **frame_10/texture** +- :ref:`Texture` **frame_10/texture** .. _class_AnimatedTexture_frame_100/delay_sec: @@ -53,7 +52,7 @@ Member Variables .. _class_AnimatedTexture_frame_100/texture: -- :ref:`Texture` **frame_100/texture** +- :ref:`Texture` **frame_100/texture** .. _class_AnimatedTexture_frame_101/delay_sec: @@ -61,7 +60,7 @@ Member Variables .. _class_AnimatedTexture_frame_101/texture: -- :ref:`Texture` **frame_101/texture** +- :ref:`Texture` **frame_101/texture** .. _class_AnimatedTexture_frame_102/delay_sec: @@ -69,7 +68,7 @@ Member Variables .. _class_AnimatedTexture_frame_102/texture: -- :ref:`Texture` **frame_102/texture** +- :ref:`Texture` **frame_102/texture** .. _class_AnimatedTexture_frame_103/delay_sec: @@ -77,7 +76,7 @@ Member Variables .. _class_AnimatedTexture_frame_103/texture: -- :ref:`Texture` **frame_103/texture** +- :ref:`Texture` **frame_103/texture** .. _class_AnimatedTexture_frame_104/delay_sec: @@ -85,7 +84,7 @@ Member Variables .. _class_AnimatedTexture_frame_104/texture: -- :ref:`Texture` **frame_104/texture** +- :ref:`Texture` **frame_104/texture** .. _class_AnimatedTexture_frame_105/delay_sec: @@ -93,7 +92,7 @@ Member Variables .. _class_AnimatedTexture_frame_105/texture: -- :ref:`Texture` **frame_105/texture** +- :ref:`Texture` **frame_105/texture** .. _class_AnimatedTexture_frame_106/delay_sec: @@ -101,7 +100,7 @@ Member Variables .. _class_AnimatedTexture_frame_106/texture: -- :ref:`Texture` **frame_106/texture** +- :ref:`Texture` **frame_106/texture** .. _class_AnimatedTexture_frame_107/delay_sec: @@ -109,7 +108,7 @@ Member Variables .. _class_AnimatedTexture_frame_107/texture: -- :ref:`Texture` **frame_107/texture** +- :ref:`Texture` **frame_107/texture** .. _class_AnimatedTexture_frame_108/delay_sec: @@ -117,7 +116,7 @@ Member Variables .. _class_AnimatedTexture_frame_108/texture: -- :ref:`Texture` **frame_108/texture** +- :ref:`Texture` **frame_108/texture** .. _class_AnimatedTexture_frame_109/delay_sec: @@ -125,7 +124,7 @@ Member Variables .. _class_AnimatedTexture_frame_109/texture: -- :ref:`Texture` **frame_109/texture** +- :ref:`Texture` **frame_109/texture** .. _class_AnimatedTexture_frame_11/delay_sec: @@ -133,7 +132,7 @@ Member Variables .. _class_AnimatedTexture_frame_11/texture: -- :ref:`Texture` **frame_11/texture** +- :ref:`Texture` **frame_11/texture** .. _class_AnimatedTexture_frame_110/delay_sec: @@ -141,7 +140,7 @@ Member Variables .. _class_AnimatedTexture_frame_110/texture: -- :ref:`Texture` **frame_110/texture** +- :ref:`Texture` **frame_110/texture** .. _class_AnimatedTexture_frame_111/delay_sec: @@ -149,7 +148,7 @@ Member Variables .. _class_AnimatedTexture_frame_111/texture: -- :ref:`Texture` **frame_111/texture** +- :ref:`Texture` **frame_111/texture** .. _class_AnimatedTexture_frame_112/delay_sec: @@ -157,7 +156,7 @@ Member Variables .. _class_AnimatedTexture_frame_112/texture: -- :ref:`Texture` **frame_112/texture** +- :ref:`Texture` **frame_112/texture** .. _class_AnimatedTexture_frame_113/delay_sec: @@ -165,7 +164,7 @@ Member Variables .. _class_AnimatedTexture_frame_113/texture: -- :ref:`Texture` **frame_113/texture** +- :ref:`Texture` **frame_113/texture** .. _class_AnimatedTexture_frame_114/delay_sec: @@ -173,7 +172,7 @@ Member Variables .. _class_AnimatedTexture_frame_114/texture: -- :ref:`Texture` **frame_114/texture** +- :ref:`Texture` **frame_114/texture** .. _class_AnimatedTexture_frame_115/delay_sec: @@ -181,7 +180,7 @@ Member Variables .. _class_AnimatedTexture_frame_115/texture: -- :ref:`Texture` **frame_115/texture** +- :ref:`Texture` **frame_115/texture** .. _class_AnimatedTexture_frame_116/delay_sec: @@ -189,7 +188,7 @@ Member Variables .. _class_AnimatedTexture_frame_116/texture: -- :ref:`Texture` **frame_116/texture** +- :ref:`Texture` **frame_116/texture** .. _class_AnimatedTexture_frame_117/delay_sec: @@ -197,7 +196,7 @@ Member Variables .. _class_AnimatedTexture_frame_117/texture: -- :ref:`Texture` **frame_117/texture** +- :ref:`Texture` **frame_117/texture** .. _class_AnimatedTexture_frame_118/delay_sec: @@ -205,7 +204,7 @@ Member Variables .. _class_AnimatedTexture_frame_118/texture: -- :ref:`Texture` **frame_118/texture** +- :ref:`Texture` **frame_118/texture** .. _class_AnimatedTexture_frame_119/delay_sec: @@ -213,7 +212,7 @@ Member Variables .. _class_AnimatedTexture_frame_119/texture: -- :ref:`Texture` **frame_119/texture** +- :ref:`Texture` **frame_119/texture** .. _class_AnimatedTexture_frame_12/delay_sec: @@ -221,7 +220,7 @@ Member Variables .. _class_AnimatedTexture_frame_12/texture: -- :ref:`Texture` **frame_12/texture** +- :ref:`Texture` **frame_12/texture** .. _class_AnimatedTexture_frame_120/delay_sec: @@ -229,7 +228,7 @@ Member Variables .. _class_AnimatedTexture_frame_120/texture: -- :ref:`Texture` **frame_120/texture** +- :ref:`Texture` **frame_120/texture** .. _class_AnimatedTexture_frame_121/delay_sec: @@ -237,7 +236,7 @@ Member Variables .. _class_AnimatedTexture_frame_121/texture: -- :ref:`Texture` **frame_121/texture** +- :ref:`Texture` **frame_121/texture** .. _class_AnimatedTexture_frame_122/delay_sec: @@ -245,7 +244,7 @@ Member Variables .. _class_AnimatedTexture_frame_122/texture: -- :ref:`Texture` **frame_122/texture** +- :ref:`Texture` **frame_122/texture** .. _class_AnimatedTexture_frame_123/delay_sec: @@ -253,7 +252,7 @@ Member Variables .. _class_AnimatedTexture_frame_123/texture: -- :ref:`Texture` **frame_123/texture** +- :ref:`Texture` **frame_123/texture** .. _class_AnimatedTexture_frame_124/delay_sec: @@ -261,7 +260,7 @@ Member Variables .. _class_AnimatedTexture_frame_124/texture: -- :ref:`Texture` **frame_124/texture** +- :ref:`Texture` **frame_124/texture** .. _class_AnimatedTexture_frame_125/delay_sec: @@ -269,7 +268,7 @@ Member Variables .. _class_AnimatedTexture_frame_125/texture: -- :ref:`Texture` **frame_125/texture** +- :ref:`Texture` **frame_125/texture** .. _class_AnimatedTexture_frame_126/delay_sec: @@ -277,7 +276,7 @@ Member Variables .. _class_AnimatedTexture_frame_126/texture: -- :ref:`Texture` **frame_126/texture** +- :ref:`Texture` **frame_126/texture** .. _class_AnimatedTexture_frame_127/delay_sec: @@ -285,7 +284,7 @@ Member Variables .. _class_AnimatedTexture_frame_127/texture: -- :ref:`Texture` **frame_127/texture** +- :ref:`Texture` **frame_127/texture** .. _class_AnimatedTexture_frame_128/delay_sec: @@ -293,7 +292,7 @@ Member Variables .. _class_AnimatedTexture_frame_128/texture: -- :ref:`Texture` **frame_128/texture** +- :ref:`Texture` **frame_128/texture** .. _class_AnimatedTexture_frame_129/delay_sec: @@ -301,7 +300,7 @@ Member Variables .. _class_AnimatedTexture_frame_129/texture: -- :ref:`Texture` **frame_129/texture** +- :ref:`Texture` **frame_129/texture** .. _class_AnimatedTexture_frame_13/delay_sec: @@ -309,7 +308,7 @@ Member Variables .. _class_AnimatedTexture_frame_13/texture: -- :ref:`Texture` **frame_13/texture** +- :ref:`Texture` **frame_13/texture** .. _class_AnimatedTexture_frame_130/delay_sec: @@ -317,7 +316,7 @@ Member Variables .. _class_AnimatedTexture_frame_130/texture: -- :ref:`Texture` **frame_130/texture** +- :ref:`Texture` **frame_130/texture** .. _class_AnimatedTexture_frame_131/delay_sec: @@ -325,7 +324,7 @@ Member Variables .. _class_AnimatedTexture_frame_131/texture: -- :ref:`Texture` **frame_131/texture** +- :ref:`Texture` **frame_131/texture** .. _class_AnimatedTexture_frame_132/delay_sec: @@ -333,7 +332,7 @@ Member Variables .. _class_AnimatedTexture_frame_132/texture: -- :ref:`Texture` **frame_132/texture** +- :ref:`Texture` **frame_132/texture** .. _class_AnimatedTexture_frame_133/delay_sec: @@ -341,7 +340,7 @@ Member Variables .. _class_AnimatedTexture_frame_133/texture: -- :ref:`Texture` **frame_133/texture** +- :ref:`Texture` **frame_133/texture** .. _class_AnimatedTexture_frame_134/delay_sec: @@ -349,7 +348,7 @@ Member Variables .. _class_AnimatedTexture_frame_134/texture: -- :ref:`Texture` **frame_134/texture** +- :ref:`Texture` **frame_134/texture** .. _class_AnimatedTexture_frame_135/delay_sec: @@ -357,7 +356,7 @@ Member Variables .. _class_AnimatedTexture_frame_135/texture: -- :ref:`Texture` **frame_135/texture** +- :ref:`Texture` **frame_135/texture** .. _class_AnimatedTexture_frame_136/delay_sec: @@ -365,7 +364,7 @@ Member Variables .. _class_AnimatedTexture_frame_136/texture: -- :ref:`Texture` **frame_136/texture** +- :ref:`Texture` **frame_136/texture** .. _class_AnimatedTexture_frame_137/delay_sec: @@ -373,7 +372,7 @@ Member Variables .. _class_AnimatedTexture_frame_137/texture: -- :ref:`Texture` **frame_137/texture** +- :ref:`Texture` **frame_137/texture** .. _class_AnimatedTexture_frame_138/delay_sec: @@ -381,7 +380,7 @@ Member Variables .. _class_AnimatedTexture_frame_138/texture: -- :ref:`Texture` **frame_138/texture** +- :ref:`Texture` **frame_138/texture** .. _class_AnimatedTexture_frame_139/delay_sec: @@ -389,7 +388,7 @@ Member Variables .. _class_AnimatedTexture_frame_139/texture: -- :ref:`Texture` **frame_139/texture** +- :ref:`Texture` **frame_139/texture** .. _class_AnimatedTexture_frame_14/delay_sec: @@ -397,7 +396,7 @@ Member Variables .. _class_AnimatedTexture_frame_14/texture: -- :ref:`Texture` **frame_14/texture** +- :ref:`Texture` **frame_14/texture** .. _class_AnimatedTexture_frame_140/delay_sec: @@ -405,7 +404,7 @@ Member Variables .. _class_AnimatedTexture_frame_140/texture: -- :ref:`Texture` **frame_140/texture** +- :ref:`Texture` **frame_140/texture** .. _class_AnimatedTexture_frame_141/delay_sec: @@ -413,7 +412,7 @@ Member Variables .. _class_AnimatedTexture_frame_141/texture: -- :ref:`Texture` **frame_141/texture** +- :ref:`Texture` **frame_141/texture** .. _class_AnimatedTexture_frame_142/delay_sec: @@ -421,7 +420,7 @@ Member Variables .. _class_AnimatedTexture_frame_142/texture: -- :ref:`Texture` **frame_142/texture** +- :ref:`Texture` **frame_142/texture** .. _class_AnimatedTexture_frame_143/delay_sec: @@ -429,7 +428,7 @@ Member Variables .. _class_AnimatedTexture_frame_143/texture: -- :ref:`Texture` **frame_143/texture** +- :ref:`Texture` **frame_143/texture** .. _class_AnimatedTexture_frame_144/delay_sec: @@ -437,7 +436,7 @@ Member Variables .. _class_AnimatedTexture_frame_144/texture: -- :ref:`Texture` **frame_144/texture** +- :ref:`Texture` **frame_144/texture** .. _class_AnimatedTexture_frame_145/delay_sec: @@ -445,7 +444,7 @@ Member Variables .. _class_AnimatedTexture_frame_145/texture: -- :ref:`Texture` **frame_145/texture** +- :ref:`Texture` **frame_145/texture** .. _class_AnimatedTexture_frame_146/delay_sec: @@ -453,7 +452,7 @@ Member Variables .. _class_AnimatedTexture_frame_146/texture: -- :ref:`Texture` **frame_146/texture** +- :ref:`Texture` **frame_146/texture** .. _class_AnimatedTexture_frame_147/delay_sec: @@ -461,7 +460,7 @@ Member Variables .. _class_AnimatedTexture_frame_147/texture: -- :ref:`Texture` **frame_147/texture** +- :ref:`Texture` **frame_147/texture** .. _class_AnimatedTexture_frame_148/delay_sec: @@ -469,7 +468,7 @@ Member Variables .. _class_AnimatedTexture_frame_148/texture: -- :ref:`Texture` **frame_148/texture** +- :ref:`Texture` **frame_148/texture** .. _class_AnimatedTexture_frame_149/delay_sec: @@ -477,7 +476,7 @@ Member Variables .. _class_AnimatedTexture_frame_149/texture: -- :ref:`Texture` **frame_149/texture** +- :ref:`Texture` **frame_149/texture** .. _class_AnimatedTexture_frame_15/delay_sec: @@ -485,7 +484,7 @@ Member Variables .. _class_AnimatedTexture_frame_15/texture: -- :ref:`Texture` **frame_15/texture** +- :ref:`Texture` **frame_15/texture** .. _class_AnimatedTexture_frame_150/delay_sec: @@ -493,7 +492,7 @@ Member Variables .. _class_AnimatedTexture_frame_150/texture: -- :ref:`Texture` **frame_150/texture** +- :ref:`Texture` **frame_150/texture** .. _class_AnimatedTexture_frame_151/delay_sec: @@ -501,7 +500,7 @@ Member Variables .. _class_AnimatedTexture_frame_151/texture: -- :ref:`Texture` **frame_151/texture** +- :ref:`Texture` **frame_151/texture** .. _class_AnimatedTexture_frame_152/delay_sec: @@ -509,7 +508,7 @@ Member Variables .. _class_AnimatedTexture_frame_152/texture: -- :ref:`Texture` **frame_152/texture** +- :ref:`Texture` **frame_152/texture** .. _class_AnimatedTexture_frame_153/delay_sec: @@ -517,7 +516,7 @@ Member Variables .. _class_AnimatedTexture_frame_153/texture: -- :ref:`Texture` **frame_153/texture** +- :ref:`Texture` **frame_153/texture** .. _class_AnimatedTexture_frame_154/delay_sec: @@ -525,7 +524,7 @@ Member Variables .. _class_AnimatedTexture_frame_154/texture: -- :ref:`Texture` **frame_154/texture** +- :ref:`Texture` **frame_154/texture** .. _class_AnimatedTexture_frame_155/delay_sec: @@ -533,7 +532,7 @@ Member Variables .. _class_AnimatedTexture_frame_155/texture: -- :ref:`Texture` **frame_155/texture** +- :ref:`Texture` **frame_155/texture** .. _class_AnimatedTexture_frame_156/delay_sec: @@ -541,7 +540,7 @@ Member Variables .. _class_AnimatedTexture_frame_156/texture: -- :ref:`Texture` **frame_156/texture** +- :ref:`Texture` **frame_156/texture** .. _class_AnimatedTexture_frame_157/delay_sec: @@ -549,7 +548,7 @@ Member Variables .. _class_AnimatedTexture_frame_157/texture: -- :ref:`Texture` **frame_157/texture** +- :ref:`Texture` **frame_157/texture** .. _class_AnimatedTexture_frame_158/delay_sec: @@ -557,7 +556,7 @@ Member Variables .. _class_AnimatedTexture_frame_158/texture: -- :ref:`Texture` **frame_158/texture** +- :ref:`Texture` **frame_158/texture** .. _class_AnimatedTexture_frame_159/delay_sec: @@ -565,7 +564,7 @@ Member Variables .. _class_AnimatedTexture_frame_159/texture: -- :ref:`Texture` **frame_159/texture** +- :ref:`Texture` **frame_159/texture** .. _class_AnimatedTexture_frame_16/delay_sec: @@ -573,7 +572,7 @@ Member Variables .. _class_AnimatedTexture_frame_16/texture: -- :ref:`Texture` **frame_16/texture** +- :ref:`Texture` **frame_16/texture** .. _class_AnimatedTexture_frame_160/delay_sec: @@ -581,7 +580,7 @@ Member Variables .. _class_AnimatedTexture_frame_160/texture: -- :ref:`Texture` **frame_160/texture** +- :ref:`Texture` **frame_160/texture** .. _class_AnimatedTexture_frame_161/delay_sec: @@ -589,7 +588,7 @@ Member Variables .. _class_AnimatedTexture_frame_161/texture: -- :ref:`Texture` **frame_161/texture** +- :ref:`Texture` **frame_161/texture** .. _class_AnimatedTexture_frame_162/delay_sec: @@ -597,7 +596,7 @@ Member Variables .. _class_AnimatedTexture_frame_162/texture: -- :ref:`Texture` **frame_162/texture** +- :ref:`Texture` **frame_162/texture** .. _class_AnimatedTexture_frame_163/delay_sec: @@ -605,7 +604,7 @@ Member Variables .. _class_AnimatedTexture_frame_163/texture: -- :ref:`Texture` **frame_163/texture** +- :ref:`Texture` **frame_163/texture** .. _class_AnimatedTexture_frame_164/delay_sec: @@ -613,7 +612,7 @@ Member Variables .. _class_AnimatedTexture_frame_164/texture: -- :ref:`Texture` **frame_164/texture** +- :ref:`Texture` **frame_164/texture** .. _class_AnimatedTexture_frame_165/delay_sec: @@ -621,7 +620,7 @@ Member Variables .. _class_AnimatedTexture_frame_165/texture: -- :ref:`Texture` **frame_165/texture** +- :ref:`Texture` **frame_165/texture** .. _class_AnimatedTexture_frame_166/delay_sec: @@ -629,7 +628,7 @@ Member Variables .. _class_AnimatedTexture_frame_166/texture: -- :ref:`Texture` **frame_166/texture** +- :ref:`Texture` **frame_166/texture** .. _class_AnimatedTexture_frame_167/delay_sec: @@ -637,7 +636,7 @@ Member Variables .. _class_AnimatedTexture_frame_167/texture: -- :ref:`Texture` **frame_167/texture** +- :ref:`Texture` **frame_167/texture** .. _class_AnimatedTexture_frame_168/delay_sec: @@ -645,7 +644,7 @@ Member Variables .. _class_AnimatedTexture_frame_168/texture: -- :ref:`Texture` **frame_168/texture** +- :ref:`Texture` **frame_168/texture** .. _class_AnimatedTexture_frame_169/delay_sec: @@ -653,7 +652,7 @@ Member Variables .. _class_AnimatedTexture_frame_169/texture: -- :ref:`Texture` **frame_169/texture** +- :ref:`Texture` **frame_169/texture** .. _class_AnimatedTexture_frame_17/delay_sec: @@ -661,7 +660,7 @@ Member Variables .. _class_AnimatedTexture_frame_17/texture: -- :ref:`Texture` **frame_17/texture** +- :ref:`Texture` **frame_17/texture** .. _class_AnimatedTexture_frame_170/delay_sec: @@ -669,7 +668,7 @@ Member Variables .. _class_AnimatedTexture_frame_170/texture: -- :ref:`Texture` **frame_170/texture** +- :ref:`Texture` **frame_170/texture** .. _class_AnimatedTexture_frame_171/delay_sec: @@ -677,7 +676,7 @@ Member Variables .. _class_AnimatedTexture_frame_171/texture: -- :ref:`Texture` **frame_171/texture** +- :ref:`Texture` **frame_171/texture** .. _class_AnimatedTexture_frame_172/delay_sec: @@ -685,7 +684,7 @@ Member Variables .. _class_AnimatedTexture_frame_172/texture: -- :ref:`Texture` **frame_172/texture** +- :ref:`Texture` **frame_172/texture** .. _class_AnimatedTexture_frame_173/delay_sec: @@ -693,7 +692,7 @@ Member Variables .. _class_AnimatedTexture_frame_173/texture: -- :ref:`Texture` **frame_173/texture** +- :ref:`Texture` **frame_173/texture** .. _class_AnimatedTexture_frame_174/delay_sec: @@ -701,7 +700,7 @@ Member Variables .. _class_AnimatedTexture_frame_174/texture: -- :ref:`Texture` **frame_174/texture** +- :ref:`Texture` **frame_174/texture** .. _class_AnimatedTexture_frame_175/delay_sec: @@ -709,7 +708,7 @@ Member Variables .. _class_AnimatedTexture_frame_175/texture: -- :ref:`Texture` **frame_175/texture** +- :ref:`Texture` **frame_175/texture** .. _class_AnimatedTexture_frame_176/delay_sec: @@ -717,7 +716,7 @@ Member Variables .. _class_AnimatedTexture_frame_176/texture: -- :ref:`Texture` **frame_176/texture** +- :ref:`Texture` **frame_176/texture** .. _class_AnimatedTexture_frame_177/delay_sec: @@ -725,7 +724,7 @@ Member Variables .. _class_AnimatedTexture_frame_177/texture: -- :ref:`Texture` **frame_177/texture** +- :ref:`Texture` **frame_177/texture** .. _class_AnimatedTexture_frame_178/delay_sec: @@ -733,7 +732,7 @@ Member Variables .. _class_AnimatedTexture_frame_178/texture: -- :ref:`Texture` **frame_178/texture** +- :ref:`Texture` **frame_178/texture** .. _class_AnimatedTexture_frame_179/delay_sec: @@ -741,7 +740,7 @@ Member Variables .. _class_AnimatedTexture_frame_179/texture: -- :ref:`Texture` **frame_179/texture** +- :ref:`Texture` **frame_179/texture** .. _class_AnimatedTexture_frame_18/delay_sec: @@ -749,7 +748,7 @@ Member Variables .. _class_AnimatedTexture_frame_18/texture: -- :ref:`Texture` **frame_18/texture** +- :ref:`Texture` **frame_18/texture** .. _class_AnimatedTexture_frame_180/delay_sec: @@ -757,7 +756,7 @@ Member Variables .. _class_AnimatedTexture_frame_180/texture: -- :ref:`Texture` **frame_180/texture** +- :ref:`Texture` **frame_180/texture** .. _class_AnimatedTexture_frame_181/delay_sec: @@ -765,7 +764,7 @@ Member Variables .. _class_AnimatedTexture_frame_181/texture: -- :ref:`Texture` **frame_181/texture** +- :ref:`Texture` **frame_181/texture** .. _class_AnimatedTexture_frame_182/delay_sec: @@ -773,7 +772,7 @@ Member Variables .. _class_AnimatedTexture_frame_182/texture: -- :ref:`Texture` **frame_182/texture** +- :ref:`Texture` **frame_182/texture** .. _class_AnimatedTexture_frame_183/delay_sec: @@ -781,7 +780,7 @@ Member Variables .. _class_AnimatedTexture_frame_183/texture: -- :ref:`Texture` **frame_183/texture** +- :ref:`Texture` **frame_183/texture** .. _class_AnimatedTexture_frame_184/delay_sec: @@ -789,7 +788,7 @@ Member Variables .. _class_AnimatedTexture_frame_184/texture: -- :ref:`Texture` **frame_184/texture** +- :ref:`Texture` **frame_184/texture** .. _class_AnimatedTexture_frame_185/delay_sec: @@ -797,7 +796,7 @@ Member Variables .. _class_AnimatedTexture_frame_185/texture: -- :ref:`Texture` **frame_185/texture** +- :ref:`Texture` **frame_185/texture** .. _class_AnimatedTexture_frame_186/delay_sec: @@ -805,7 +804,7 @@ Member Variables .. _class_AnimatedTexture_frame_186/texture: -- :ref:`Texture` **frame_186/texture** +- :ref:`Texture` **frame_186/texture** .. _class_AnimatedTexture_frame_187/delay_sec: @@ -813,7 +812,7 @@ Member Variables .. _class_AnimatedTexture_frame_187/texture: -- :ref:`Texture` **frame_187/texture** +- :ref:`Texture` **frame_187/texture** .. _class_AnimatedTexture_frame_188/delay_sec: @@ -821,7 +820,7 @@ Member Variables .. _class_AnimatedTexture_frame_188/texture: -- :ref:`Texture` **frame_188/texture** +- :ref:`Texture` **frame_188/texture** .. _class_AnimatedTexture_frame_189/delay_sec: @@ -829,7 +828,7 @@ Member Variables .. _class_AnimatedTexture_frame_189/texture: -- :ref:`Texture` **frame_189/texture** +- :ref:`Texture` **frame_189/texture** .. _class_AnimatedTexture_frame_19/delay_sec: @@ -837,7 +836,7 @@ Member Variables .. _class_AnimatedTexture_frame_19/texture: -- :ref:`Texture` **frame_19/texture** +- :ref:`Texture` **frame_19/texture** .. _class_AnimatedTexture_frame_190/delay_sec: @@ -845,7 +844,7 @@ Member Variables .. _class_AnimatedTexture_frame_190/texture: -- :ref:`Texture` **frame_190/texture** +- :ref:`Texture` **frame_190/texture** .. _class_AnimatedTexture_frame_191/delay_sec: @@ -853,7 +852,7 @@ Member Variables .. _class_AnimatedTexture_frame_191/texture: -- :ref:`Texture` **frame_191/texture** +- :ref:`Texture` **frame_191/texture** .. _class_AnimatedTexture_frame_192/delay_sec: @@ -861,7 +860,7 @@ Member Variables .. _class_AnimatedTexture_frame_192/texture: -- :ref:`Texture` **frame_192/texture** +- :ref:`Texture` **frame_192/texture** .. _class_AnimatedTexture_frame_193/delay_sec: @@ -869,7 +868,7 @@ Member Variables .. _class_AnimatedTexture_frame_193/texture: -- :ref:`Texture` **frame_193/texture** +- :ref:`Texture` **frame_193/texture** .. _class_AnimatedTexture_frame_194/delay_sec: @@ -877,7 +876,7 @@ Member Variables .. _class_AnimatedTexture_frame_194/texture: -- :ref:`Texture` **frame_194/texture** +- :ref:`Texture` **frame_194/texture** .. _class_AnimatedTexture_frame_195/delay_sec: @@ -885,7 +884,7 @@ Member Variables .. _class_AnimatedTexture_frame_195/texture: -- :ref:`Texture` **frame_195/texture** +- :ref:`Texture` **frame_195/texture** .. _class_AnimatedTexture_frame_196/delay_sec: @@ -893,7 +892,7 @@ Member Variables .. _class_AnimatedTexture_frame_196/texture: -- :ref:`Texture` **frame_196/texture** +- :ref:`Texture` **frame_196/texture** .. _class_AnimatedTexture_frame_197/delay_sec: @@ -901,7 +900,7 @@ Member Variables .. _class_AnimatedTexture_frame_197/texture: -- :ref:`Texture` **frame_197/texture** +- :ref:`Texture` **frame_197/texture** .. _class_AnimatedTexture_frame_198/delay_sec: @@ -909,7 +908,7 @@ Member Variables .. _class_AnimatedTexture_frame_198/texture: -- :ref:`Texture` **frame_198/texture** +- :ref:`Texture` **frame_198/texture** .. _class_AnimatedTexture_frame_199/delay_sec: @@ -917,7 +916,7 @@ Member Variables .. _class_AnimatedTexture_frame_199/texture: -- :ref:`Texture` **frame_199/texture** +- :ref:`Texture` **frame_199/texture** .. _class_AnimatedTexture_frame_2/delay_sec: @@ -925,7 +924,7 @@ Member Variables .. _class_AnimatedTexture_frame_2/texture: -- :ref:`Texture` **frame_2/texture** +- :ref:`Texture` **frame_2/texture** .. _class_AnimatedTexture_frame_20/delay_sec: @@ -933,7 +932,7 @@ Member Variables .. _class_AnimatedTexture_frame_20/texture: -- :ref:`Texture` **frame_20/texture** +- :ref:`Texture` **frame_20/texture** .. _class_AnimatedTexture_frame_200/delay_sec: @@ -941,7 +940,7 @@ Member Variables .. _class_AnimatedTexture_frame_200/texture: -- :ref:`Texture` **frame_200/texture** +- :ref:`Texture` **frame_200/texture** .. _class_AnimatedTexture_frame_201/delay_sec: @@ -949,7 +948,7 @@ Member Variables .. _class_AnimatedTexture_frame_201/texture: -- :ref:`Texture` **frame_201/texture** +- :ref:`Texture` **frame_201/texture** .. _class_AnimatedTexture_frame_202/delay_sec: @@ -957,7 +956,7 @@ Member Variables .. _class_AnimatedTexture_frame_202/texture: -- :ref:`Texture` **frame_202/texture** +- :ref:`Texture` **frame_202/texture** .. _class_AnimatedTexture_frame_203/delay_sec: @@ -965,7 +964,7 @@ Member Variables .. _class_AnimatedTexture_frame_203/texture: -- :ref:`Texture` **frame_203/texture** +- :ref:`Texture` **frame_203/texture** .. _class_AnimatedTexture_frame_204/delay_sec: @@ -973,7 +972,7 @@ Member Variables .. _class_AnimatedTexture_frame_204/texture: -- :ref:`Texture` **frame_204/texture** +- :ref:`Texture` **frame_204/texture** .. _class_AnimatedTexture_frame_205/delay_sec: @@ -981,7 +980,7 @@ Member Variables .. _class_AnimatedTexture_frame_205/texture: -- :ref:`Texture` **frame_205/texture** +- :ref:`Texture` **frame_205/texture** .. _class_AnimatedTexture_frame_206/delay_sec: @@ -989,7 +988,7 @@ Member Variables .. _class_AnimatedTexture_frame_206/texture: -- :ref:`Texture` **frame_206/texture** +- :ref:`Texture` **frame_206/texture** .. _class_AnimatedTexture_frame_207/delay_sec: @@ -997,7 +996,7 @@ Member Variables .. _class_AnimatedTexture_frame_207/texture: -- :ref:`Texture` **frame_207/texture** +- :ref:`Texture` **frame_207/texture** .. _class_AnimatedTexture_frame_208/delay_sec: @@ -1005,7 +1004,7 @@ Member Variables .. _class_AnimatedTexture_frame_208/texture: -- :ref:`Texture` **frame_208/texture** +- :ref:`Texture` **frame_208/texture** .. _class_AnimatedTexture_frame_209/delay_sec: @@ -1013,7 +1012,7 @@ Member Variables .. _class_AnimatedTexture_frame_209/texture: -- :ref:`Texture` **frame_209/texture** +- :ref:`Texture` **frame_209/texture** .. _class_AnimatedTexture_frame_21/delay_sec: @@ -1021,7 +1020,7 @@ Member Variables .. _class_AnimatedTexture_frame_21/texture: -- :ref:`Texture` **frame_21/texture** +- :ref:`Texture` **frame_21/texture** .. _class_AnimatedTexture_frame_210/delay_sec: @@ -1029,7 +1028,7 @@ Member Variables .. _class_AnimatedTexture_frame_210/texture: -- :ref:`Texture` **frame_210/texture** +- :ref:`Texture` **frame_210/texture** .. _class_AnimatedTexture_frame_211/delay_sec: @@ -1037,7 +1036,7 @@ Member Variables .. _class_AnimatedTexture_frame_211/texture: -- :ref:`Texture` **frame_211/texture** +- :ref:`Texture` **frame_211/texture** .. _class_AnimatedTexture_frame_212/delay_sec: @@ -1045,7 +1044,7 @@ Member Variables .. _class_AnimatedTexture_frame_212/texture: -- :ref:`Texture` **frame_212/texture** +- :ref:`Texture` **frame_212/texture** .. _class_AnimatedTexture_frame_213/delay_sec: @@ -1053,7 +1052,7 @@ Member Variables .. _class_AnimatedTexture_frame_213/texture: -- :ref:`Texture` **frame_213/texture** +- :ref:`Texture` **frame_213/texture** .. _class_AnimatedTexture_frame_214/delay_sec: @@ -1061,7 +1060,7 @@ Member Variables .. _class_AnimatedTexture_frame_214/texture: -- :ref:`Texture` **frame_214/texture** +- :ref:`Texture` **frame_214/texture** .. _class_AnimatedTexture_frame_215/delay_sec: @@ -1069,7 +1068,7 @@ Member Variables .. _class_AnimatedTexture_frame_215/texture: -- :ref:`Texture` **frame_215/texture** +- :ref:`Texture` **frame_215/texture** .. _class_AnimatedTexture_frame_216/delay_sec: @@ -1077,7 +1076,7 @@ Member Variables .. _class_AnimatedTexture_frame_216/texture: -- :ref:`Texture` **frame_216/texture** +- :ref:`Texture` **frame_216/texture** .. _class_AnimatedTexture_frame_217/delay_sec: @@ -1085,7 +1084,7 @@ Member Variables .. _class_AnimatedTexture_frame_217/texture: -- :ref:`Texture` **frame_217/texture** +- :ref:`Texture` **frame_217/texture** .. _class_AnimatedTexture_frame_218/delay_sec: @@ -1093,7 +1092,7 @@ Member Variables .. _class_AnimatedTexture_frame_218/texture: -- :ref:`Texture` **frame_218/texture** +- :ref:`Texture` **frame_218/texture** .. _class_AnimatedTexture_frame_219/delay_sec: @@ -1101,7 +1100,7 @@ Member Variables .. _class_AnimatedTexture_frame_219/texture: -- :ref:`Texture` **frame_219/texture** +- :ref:`Texture` **frame_219/texture** .. _class_AnimatedTexture_frame_22/delay_sec: @@ -1109,7 +1108,7 @@ Member Variables .. _class_AnimatedTexture_frame_22/texture: -- :ref:`Texture` **frame_22/texture** +- :ref:`Texture` **frame_22/texture** .. _class_AnimatedTexture_frame_220/delay_sec: @@ -1117,7 +1116,7 @@ Member Variables .. _class_AnimatedTexture_frame_220/texture: -- :ref:`Texture` **frame_220/texture** +- :ref:`Texture` **frame_220/texture** .. _class_AnimatedTexture_frame_221/delay_sec: @@ -1125,7 +1124,7 @@ Member Variables .. _class_AnimatedTexture_frame_221/texture: -- :ref:`Texture` **frame_221/texture** +- :ref:`Texture` **frame_221/texture** .. _class_AnimatedTexture_frame_222/delay_sec: @@ -1133,7 +1132,7 @@ Member Variables .. _class_AnimatedTexture_frame_222/texture: -- :ref:`Texture` **frame_222/texture** +- :ref:`Texture` **frame_222/texture** .. _class_AnimatedTexture_frame_223/delay_sec: @@ -1141,7 +1140,7 @@ Member Variables .. _class_AnimatedTexture_frame_223/texture: -- :ref:`Texture` **frame_223/texture** +- :ref:`Texture` **frame_223/texture** .. _class_AnimatedTexture_frame_224/delay_sec: @@ -1149,7 +1148,7 @@ Member Variables .. _class_AnimatedTexture_frame_224/texture: -- :ref:`Texture` **frame_224/texture** +- :ref:`Texture` **frame_224/texture** .. _class_AnimatedTexture_frame_225/delay_sec: @@ -1157,7 +1156,7 @@ Member Variables .. _class_AnimatedTexture_frame_225/texture: -- :ref:`Texture` **frame_225/texture** +- :ref:`Texture` **frame_225/texture** .. _class_AnimatedTexture_frame_226/delay_sec: @@ -1165,7 +1164,7 @@ Member Variables .. _class_AnimatedTexture_frame_226/texture: -- :ref:`Texture` **frame_226/texture** +- :ref:`Texture` **frame_226/texture** .. _class_AnimatedTexture_frame_227/delay_sec: @@ -1173,7 +1172,7 @@ Member Variables .. _class_AnimatedTexture_frame_227/texture: -- :ref:`Texture` **frame_227/texture** +- :ref:`Texture` **frame_227/texture** .. _class_AnimatedTexture_frame_228/delay_sec: @@ -1181,7 +1180,7 @@ Member Variables .. _class_AnimatedTexture_frame_228/texture: -- :ref:`Texture` **frame_228/texture** +- :ref:`Texture` **frame_228/texture** .. _class_AnimatedTexture_frame_229/delay_sec: @@ -1189,7 +1188,7 @@ Member Variables .. _class_AnimatedTexture_frame_229/texture: -- :ref:`Texture` **frame_229/texture** +- :ref:`Texture` **frame_229/texture** .. _class_AnimatedTexture_frame_23/delay_sec: @@ -1197,7 +1196,7 @@ Member Variables .. _class_AnimatedTexture_frame_23/texture: -- :ref:`Texture` **frame_23/texture** +- :ref:`Texture` **frame_23/texture** .. _class_AnimatedTexture_frame_230/delay_sec: @@ -1205,7 +1204,7 @@ Member Variables .. _class_AnimatedTexture_frame_230/texture: -- :ref:`Texture` **frame_230/texture** +- :ref:`Texture` **frame_230/texture** .. _class_AnimatedTexture_frame_231/delay_sec: @@ -1213,7 +1212,7 @@ Member Variables .. _class_AnimatedTexture_frame_231/texture: -- :ref:`Texture` **frame_231/texture** +- :ref:`Texture` **frame_231/texture** .. _class_AnimatedTexture_frame_232/delay_sec: @@ -1221,7 +1220,7 @@ Member Variables .. _class_AnimatedTexture_frame_232/texture: -- :ref:`Texture` **frame_232/texture** +- :ref:`Texture` **frame_232/texture** .. _class_AnimatedTexture_frame_233/delay_sec: @@ -1229,7 +1228,7 @@ Member Variables .. _class_AnimatedTexture_frame_233/texture: -- :ref:`Texture` **frame_233/texture** +- :ref:`Texture` **frame_233/texture** .. _class_AnimatedTexture_frame_234/delay_sec: @@ -1237,7 +1236,7 @@ Member Variables .. _class_AnimatedTexture_frame_234/texture: -- :ref:`Texture` **frame_234/texture** +- :ref:`Texture` **frame_234/texture** .. _class_AnimatedTexture_frame_235/delay_sec: @@ -1245,7 +1244,7 @@ Member Variables .. _class_AnimatedTexture_frame_235/texture: -- :ref:`Texture` **frame_235/texture** +- :ref:`Texture` **frame_235/texture** .. _class_AnimatedTexture_frame_236/delay_sec: @@ -1253,7 +1252,7 @@ Member Variables .. _class_AnimatedTexture_frame_236/texture: -- :ref:`Texture` **frame_236/texture** +- :ref:`Texture` **frame_236/texture** .. _class_AnimatedTexture_frame_237/delay_sec: @@ -1261,7 +1260,7 @@ Member Variables .. _class_AnimatedTexture_frame_237/texture: -- :ref:`Texture` **frame_237/texture** +- :ref:`Texture` **frame_237/texture** .. _class_AnimatedTexture_frame_238/delay_sec: @@ -1269,7 +1268,7 @@ Member Variables .. _class_AnimatedTexture_frame_238/texture: -- :ref:`Texture` **frame_238/texture** +- :ref:`Texture` **frame_238/texture** .. _class_AnimatedTexture_frame_239/delay_sec: @@ -1277,7 +1276,7 @@ Member Variables .. _class_AnimatedTexture_frame_239/texture: -- :ref:`Texture` **frame_239/texture** +- :ref:`Texture` **frame_239/texture** .. _class_AnimatedTexture_frame_24/delay_sec: @@ -1285,7 +1284,7 @@ Member Variables .. _class_AnimatedTexture_frame_24/texture: -- :ref:`Texture` **frame_24/texture** +- :ref:`Texture` **frame_24/texture** .. _class_AnimatedTexture_frame_240/delay_sec: @@ -1293,7 +1292,7 @@ Member Variables .. _class_AnimatedTexture_frame_240/texture: -- :ref:`Texture` **frame_240/texture** +- :ref:`Texture` **frame_240/texture** .. _class_AnimatedTexture_frame_241/delay_sec: @@ -1301,7 +1300,7 @@ Member Variables .. _class_AnimatedTexture_frame_241/texture: -- :ref:`Texture` **frame_241/texture** +- :ref:`Texture` **frame_241/texture** .. _class_AnimatedTexture_frame_242/delay_sec: @@ -1309,7 +1308,7 @@ Member Variables .. _class_AnimatedTexture_frame_242/texture: -- :ref:`Texture` **frame_242/texture** +- :ref:`Texture` **frame_242/texture** .. _class_AnimatedTexture_frame_243/delay_sec: @@ -1317,7 +1316,7 @@ Member Variables .. _class_AnimatedTexture_frame_243/texture: -- :ref:`Texture` **frame_243/texture** +- :ref:`Texture` **frame_243/texture** .. _class_AnimatedTexture_frame_244/delay_sec: @@ -1325,7 +1324,7 @@ Member Variables .. _class_AnimatedTexture_frame_244/texture: -- :ref:`Texture` **frame_244/texture** +- :ref:`Texture` **frame_244/texture** .. _class_AnimatedTexture_frame_245/delay_sec: @@ -1333,7 +1332,7 @@ Member Variables .. _class_AnimatedTexture_frame_245/texture: -- :ref:`Texture` **frame_245/texture** +- :ref:`Texture` **frame_245/texture** .. _class_AnimatedTexture_frame_246/delay_sec: @@ -1341,7 +1340,7 @@ Member Variables .. _class_AnimatedTexture_frame_246/texture: -- :ref:`Texture` **frame_246/texture** +- :ref:`Texture` **frame_246/texture** .. _class_AnimatedTexture_frame_247/delay_sec: @@ -1349,7 +1348,7 @@ Member Variables .. _class_AnimatedTexture_frame_247/texture: -- :ref:`Texture` **frame_247/texture** +- :ref:`Texture` **frame_247/texture** .. _class_AnimatedTexture_frame_248/delay_sec: @@ -1357,7 +1356,7 @@ Member Variables .. _class_AnimatedTexture_frame_248/texture: -- :ref:`Texture` **frame_248/texture** +- :ref:`Texture` **frame_248/texture** .. _class_AnimatedTexture_frame_249/delay_sec: @@ -1365,7 +1364,7 @@ Member Variables .. _class_AnimatedTexture_frame_249/texture: -- :ref:`Texture` **frame_249/texture** +- :ref:`Texture` **frame_249/texture** .. _class_AnimatedTexture_frame_25/delay_sec: @@ -1373,7 +1372,7 @@ Member Variables .. _class_AnimatedTexture_frame_25/texture: -- :ref:`Texture` **frame_25/texture** +- :ref:`Texture` **frame_25/texture** .. _class_AnimatedTexture_frame_250/delay_sec: @@ -1381,7 +1380,7 @@ Member Variables .. _class_AnimatedTexture_frame_250/texture: -- :ref:`Texture` **frame_250/texture** +- :ref:`Texture` **frame_250/texture** .. _class_AnimatedTexture_frame_251/delay_sec: @@ -1389,7 +1388,7 @@ Member Variables .. _class_AnimatedTexture_frame_251/texture: -- :ref:`Texture` **frame_251/texture** +- :ref:`Texture` **frame_251/texture** .. _class_AnimatedTexture_frame_252/delay_sec: @@ -1397,7 +1396,7 @@ Member Variables .. _class_AnimatedTexture_frame_252/texture: -- :ref:`Texture` **frame_252/texture** +- :ref:`Texture` **frame_252/texture** .. _class_AnimatedTexture_frame_253/delay_sec: @@ -1405,7 +1404,7 @@ Member Variables .. _class_AnimatedTexture_frame_253/texture: -- :ref:`Texture` **frame_253/texture** +- :ref:`Texture` **frame_253/texture** .. _class_AnimatedTexture_frame_254/delay_sec: @@ -1413,7 +1412,7 @@ Member Variables .. _class_AnimatedTexture_frame_254/texture: -- :ref:`Texture` **frame_254/texture** +- :ref:`Texture` **frame_254/texture** .. _class_AnimatedTexture_frame_255/delay_sec: @@ -1421,7 +1420,7 @@ Member Variables .. _class_AnimatedTexture_frame_255/texture: -- :ref:`Texture` **frame_255/texture** +- :ref:`Texture` **frame_255/texture** .. _class_AnimatedTexture_frame_26/delay_sec: @@ -1429,7 +1428,7 @@ Member Variables .. _class_AnimatedTexture_frame_26/texture: -- :ref:`Texture` **frame_26/texture** +- :ref:`Texture` **frame_26/texture** .. _class_AnimatedTexture_frame_27/delay_sec: @@ -1437,7 +1436,7 @@ Member Variables .. _class_AnimatedTexture_frame_27/texture: -- :ref:`Texture` **frame_27/texture** +- :ref:`Texture` **frame_27/texture** .. _class_AnimatedTexture_frame_28/delay_sec: @@ -1445,7 +1444,7 @@ Member Variables .. _class_AnimatedTexture_frame_28/texture: -- :ref:`Texture` **frame_28/texture** +- :ref:`Texture` **frame_28/texture** .. _class_AnimatedTexture_frame_29/delay_sec: @@ -1453,7 +1452,7 @@ Member Variables .. _class_AnimatedTexture_frame_29/texture: -- :ref:`Texture` **frame_29/texture** +- :ref:`Texture` **frame_29/texture** .. _class_AnimatedTexture_frame_3/delay_sec: @@ -1461,7 +1460,7 @@ Member Variables .. _class_AnimatedTexture_frame_3/texture: -- :ref:`Texture` **frame_3/texture** +- :ref:`Texture` **frame_3/texture** .. _class_AnimatedTexture_frame_30/delay_sec: @@ -1469,7 +1468,7 @@ Member Variables .. _class_AnimatedTexture_frame_30/texture: -- :ref:`Texture` **frame_30/texture** +- :ref:`Texture` **frame_30/texture** .. _class_AnimatedTexture_frame_31/delay_sec: @@ -1477,7 +1476,7 @@ Member Variables .. _class_AnimatedTexture_frame_31/texture: -- :ref:`Texture` **frame_31/texture** +- :ref:`Texture` **frame_31/texture** .. _class_AnimatedTexture_frame_32/delay_sec: @@ -1485,7 +1484,7 @@ Member Variables .. _class_AnimatedTexture_frame_32/texture: -- :ref:`Texture` **frame_32/texture** +- :ref:`Texture` **frame_32/texture** .. _class_AnimatedTexture_frame_33/delay_sec: @@ -1493,7 +1492,7 @@ Member Variables .. _class_AnimatedTexture_frame_33/texture: -- :ref:`Texture` **frame_33/texture** +- :ref:`Texture` **frame_33/texture** .. _class_AnimatedTexture_frame_34/delay_sec: @@ -1501,7 +1500,7 @@ Member Variables .. _class_AnimatedTexture_frame_34/texture: -- :ref:`Texture` **frame_34/texture** +- :ref:`Texture` **frame_34/texture** .. _class_AnimatedTexture_frame_35/delay_sec: @@ -1509,7 +1508,7 @@ Member Variables .. _class_AnimatedTexture_frame_35/texture: -- :ref:`Texture` **frame_35/texture** +- :ref:`Texture` **frame_35/texture** .. _class_AnimatedTexture_frame_36/delay_sec: @@ -1517,7 +1516,7 @@ Member Variables .. _class_AnimatedTexture_frame_36/texture: -- :ref:`Texture` **frame_36/texture** +- :ref:`Texture` **frame_36/texture** .. _class_AnimatedTexture_frame_37/delay_sec: @@ -1525,7 +1524,7 @@ Member Variables .. _class_AnimatedTexture_frame_37/texture: -- :ref:`Texture` **frame_37/texture** +- :ref:`Texture` **frame_37/texture** .. _class_AnimatedTexture_frame_38/delay_sec: @@ -1533,7 +1532,7 @@ Member Variables .. _class_AnimatedTexture_frame_38/texture: -- :ref:`Texture` **frame_38/texture** +- :ref:`Texture` **frame_38/texture** .. _class_AnimatedTexture_frame_39/delay_sec: @@ -1541,7 +1540,7 @@ Member Variables .. _class_AnimatedTexture_frame_39/texture: -- :ref:`Texture` **frame_39/texture** +- :ref:`Texture` **frame_39/texture** .. _class_AnimatedTexture_frame_4/delay_sec: @@ -1549,7 +1548,7 @@ Member Variables .. _class_AnimatedTexture_frame_4/texture: -- :ref:`Texture` **frame_4/texture** +- :ref:`Texture` **frame_4/texture** .. _class_AnimatedTexture_frame_40/delay_sec: @@ -1557,7 +1556,7 @@ Member Variables .. _class_AnimatedTexture_frame_40/texture: -- :ref:`Texture` **frame_40/texture** +- :ref:`Texture` **frame_40/texture** .. _class_AnimatedTexture_frame_41/delay_sec: @@ -1565,7 +1564,7 @@ Member Variables .. _class_AnimatedTexture_frame_41/texture: -- :ref:`Texture` **frame_41/texture** +- :ref:`Texture` **frame_41/texture** .. _class_AnimatedTexture_frame_42/delay_sec: @@ -1573,7 +1572,7 @@ Member Variables .. _class_AnimatedTexture_frame_42/texture: -- :ref:`Texture` **frame_42/texture** +- :ref:`Texture` **frame_42/texture** .. _class_AnimatedTexture_frame_43/delay_sec: @@ -1581,7 +1580,7 @@ Member Variables .. _class_AnimatedTexture_frame_43/texture: -- :ref:`Texture` **frame_43/texture** +- :ref:`Texture` **frame_43/texture** .. _class_AnimatedTexture_frame_44/delay_sec: @@ -1589,7 +1588,7 @@ Member Variables .. _class_AnimatedTexture_frame_44/texture: -- :ref:`Texture` **frame_44/texture** +- :ref:`Texture` **frame_44/texture** .. _class_AnimatedTexture_frame_45/delay_sec: @@ -1597,7 +1596,7 @@ Member Variables .. _class_AnimatedTexture_frame_45/texture: -- :ref:`Texture` **frame_45/texture** +- :ref:`Texture` **frame_45/texture** .. _class_AnimatedTexture_frame_46/delay_sec: @@ -1605,7 +1604,7 @@ Member Variables .. _class_AnimatedTexture_frame_46/texture: -- :ref:`Texture` **frame_46/texture** +- :ref:`Texture` **frame_46/texture** .. _class_AnimatedTexture_frame_47/delay_sec: @@ -1613,7 +1612,7 @@ Member Variables .. _class_AnimatedTexture_frame_47/texture: -- :ref:`Texture` **frame_47/texture** +- :ref:`Texture` **frame_47/texture** .. _class_AnimatedTexture_frame_48/delay_sec: @@ -1621,7 +1620,7 @@ Member Variables .. _class_AnimatedTexture_frame_48/texture: -- :ref:`Texture` **frame_48/texture** +- :ref:`Texture` **frame_48/texture** .. _class_AnimatedTexture_frame_49/delay_sec: @@ -1629,7 +1628,7 @@ Member Variables .. _class_AnimatedTexture_frame_49/texture: -- :ref:`Texture` **frame_49/texture** +- :ref:`Texture` **frame_49/texture** .. _class_AnimatedTexture_frame_5/delay_sec: @@ -1637,7 +1636,7 @@ Member Variables .. _class_AnimatedTexture_frame_5/texture: -- :ref:`Texture` **frame_5/texture** +- :ref:`Texture` **frame_5/texture** .. _class_AnimatedTexture_frame_50/delay_sec: @@ -1645,7 +1644,7 @@ Member Variables .. _class_AnimatedTexture_frame_50/texture: -- :ref:`Texture` **frame_50/texture** +- :ref:`Texture` **frame_50/texture** .. _class_AnimatedTexture_frame_51/delay_sec: @@ -1653,7 +1652,7 @@ Member Variables .. _class_AnimatedTexture_frame_51/texture: -- :ref:`Texture` **frame_51/texture** +- :ref:`Texture` **frame_51/texture** .. _class_AnimatedTexture_frame_52/delay_sec: @@ -1661,7 +1660,7 @@ Member Variables .. _class_AnimatedTexture_frame_52/texture: -- :ref:`Texture` **frame_52/texture** +- :ref:`Texture` **frame_52/texture** .. _class_AnimatedTexture_frame_53/delay_sec: @@ -1669,7 +1668,7 @@ Member Variables .. _class_AnimatedTexture_frame_53/texture: -- :ref:`Texture` **frame_53/texture** +- :ref:`Texture` **frame_53/texture** .. _class_AnimatedTexture_frame_54/delay_sec: @@ -1677,7 +1676,7 @@ Member Variables .. _class_AnimatedTexture_frame_54/texture: -- :ref:`Texture` **frame_54/texture** +- :ref:`Texture` **frame_54/texture** .. _class_AnimatedTexture_frame_55/delay_sec: @@ -1685,7 +1684,7 @@ Member Variables .. _class_AnimatedTexture_frame_55/texture: -- :ref:`Texture` **frame_55/texture** +- :ref:`Texture` **frame_55/texture** .. _class_AnimatedTexture_frame_56/delay_sec: @@ -1693,7 +1692,7 @@ Member Variables .. _class_AnimatedTexture_frame_56/texture: -- :ref:`Texture` **frame_56/texture** +- :ref:`Texture` **frame_56/texture** .. _class_AnimatedTexture_frame_57/delay_sec: @@ -1701,7 +1700,7 @@ Member Variables .. _class_AnimatedTexture_frame_57/texture: -- :ref:`Texture` **frame_57/texture** +- :ref:`Texture` **frame_57/texture** .. _class_AnimatedTexture_frame_58/delay_sec: @@ -1709,7 +1708,7 @@ Member Variables .. _class_AnimatedTexture_frame_58/texture: -- :ref:`Texture` **frame_58/texture** +- :ref:`Texture` **frame_58/texture** .. _class_AnimatedTexture_frame_59/delay_sec: @@ -1717,7 +1716,7 @@ Member Variables .. _class_AnimatedTexture_frame_59/texture: -- :ref:`Texture` **frame_59/texture** +- :ref:`Texture` **frame_59/texture** .. _class_AnimatedTexture_frame_6/delay_sec: @@ -1725,7 +1724,7 @@ Member Variables .. _class_AnimatedTexture_frame_6/texture: -- :ref:`Texture` **frame_6/texture** +- :ref:`Texture` **frame_6/texture** .. _class_AnimatedTexture_frame_60/delay_sec: @@ -1733,7 +1732,7 @@ Member Variables .. _class_AnimatedTexture_frame_60/texture: -- :ref:`Texture` **frame_60/texture** +- :ref:`Texture` **frame_60/texture** .. _class_AnimatedTexture_frame_61/delay_sec: @@ -1741,7 +1740,7 @@ Member Variables .. _class_AnimatedTexture_frame_61/texture: -- :ref:`Texture` **frame_61/texture** +- :ref:`Texture` **frame_61/texture** .. _class_AnimatedTexture_frame_62/delay_sec: @@ -1749,7 +1748,7 @@ Member Variables .. _class_AnimatedTexture_frame_62/texture: -- :ref:`Texture` **frame_62/texture** +- :ref:`Texture` **frame_62/texture** .. _class_AnimatedTexture_frame_63/delay_sec: @@ -1757,7 +1756,7 @@ Member Variables .. _class_AnimatedTexture_frame_63/texture: -- :ref:`Texture` **frame_63/texture** +- :ref:`Texture` **frame_63/texture** .. _class_AnimatedTexture_frame_64/delay_sec: @@ -1765,7 +1764,7 @@ Member Variables .. _class_AnimatedTexture_frame_64/texture: -- :ref:`Texture` **frame_64/texture** +- :ref:`Texture` **frame_64/texture** .. _class_AnimatedTexture_frame_65/delay_sec: @@ -1773,7 +1772,7 @@ Member Variables .. _class_AnimatedTexture_frame_65/texture: -- :ref:`Texture` **frame_65/texture** +- :ref:`Texture` **frame_65/texture** .. _class_AnimatedTexture_frame_66/delay_sec: @@ -1781,7 +1780,7 @@ Member Variables .. _class_AnimatedTexture_frame_66/texture: -- :ref:`Texture` **frame_66/texture** +- :ref:`Texture` **frame_66/texture** .. _class_AnimatedTexture_frame_67/delay_sec: @@ -1789,7 +1788,7 @@ Member Variables .. _class_AnimatedTexture_frame_67/texture: -- :ref:`Texture` **frame_67/texture** +- :ref:`Texture` **frame_67/texture** .. _class_AnimatedTexture_frame_68/delay_sec: @@ -1797,7 +1796,7 @@ Member Variables .. _class_AnimatedTexture_frame_68/texture: -- :ref:`Texture` **frame_68/texture** +- :ref:`Texture` **frame_68/texture** .. _class_AnimatedTexture_frame_69/delay_sec: @@ -1805,7 +1804,7 @@ Member Variables .. _class_AnimatedTexture_frame_69/texture: -- :ref:`Texture` **frame_69/texture** +- :ref:`Texture` **frame_69/texture** .. _class_AnimatedTexture_frame_7/delay_sec: @@ -1813,7 +1812,7 @@ Member Variables .. _class_AnimatedTexture_frame_7/texture: -- :ref:`Texture` **frame_7/texture** +- :ref:`Texture` **frame_7/texture** .. _class_AnimatedTexture_frame_70/delay_sec: @@ -1821,7 +1820,7 @@ Member Variables .. _class_AnimatedTexture_frame_70/texture: -- :ref:`Texture` **frame_70/texture** +- :ref:`Texture` **frame_70/texture** .. _class_AnimatedTexture_frame_71/delay_sec: @@ -1829,7 +1828,7 @@ Member Variables .. _class_AnimatedTexture_frame_71/texture: -- :ref:`Texture` **frame_71/texture** +- :ref:`Texture` **frame_71/texture** .. _class_AnimatedTexture_frame_72/delay_sec: @@ -1837,7 +1836,7 @@ Member Variables .. _class_AnimatedTexture_frame_72/texture: -- :ref:`Texture` **frame_72/texture** +- :ref:`Texture` **frame_72/texture** .. _class_AnimatedTexture_frame_73/delay_sec: @@ -1845,7 +1844,7 @@ Member Variables .. _class_AnimatedTexture_frame_73/texture: -- :ref:`Texture` **frame_73/texture** +- :ref:`Texture` **frame_73/texture** .. _class_AnimatedTexture_frame_74/delay_sec: @@ -1853,7 +1852,7 @@ Member Variables .. _class_AnimatedTexture_frame_74/texture: -- :ref:`Texture` **frame_74/texture** +- :ref:`Texture` **frame_74/texture** .. _class_AnimatedTexture_frame_75/delay_sec: @@ -1861,7 +1860,7 @@ Member Variables .. _class_AnimatedTexture_frame_75/texture: -- :ref:`Texture` **frame_75/texture** +- :ref:`Texture` **frame_75/texture** .. _class_AnimatedTexture_frame_76/delay_sec: @@ -1869,7 +1868,7 @@ Member Variables .. _class_AnimatedTexture_frame_76/texture: -- :ref:`Texture` **frame_76/texture** +- :ref:`Texture` **frame_76/texture** .. _class_AnimatedTexture_frame_77/delay_sec: @@ -1877,7 +1876,7 @@ Member Variables .. _class_AnimatedTexture_frame_77/texture: -- :ref:`Texture` **frame_77/texture** +- :ref:`Texture` **frame_77/texture** .. _class_AnimatedTexture_frame_78/delay_sec: @@ -1885,7 +1884,7 @@ Member Variables .. _class_AnimatedTexture_frame_78/texture: -- :ref:`Texture` **frame_78/texture** +- :ref:`Texture` **frame_78/texture** .. _class_AnimatedTexture_frame_79/delay_sec: @@ -1893,7 +1892,7 @@ Member Variables .. _class_AnimatedTexture_frame_79/texture: -- :ref:`Texture` **frame_79/texture** +- :ref:`Texture` **frame_79/texture** .. _class_AnimatedTexture_frame_8/delay_sec: @@ -1901,7 +1900,7 @@ Member Variables .. _class_AnimatedTexture_frame_8/texture: -- :ref:`Texture` **frame_8/texture** +- :ref:`Texture` **frame_8/texture** .. _class_AnimatedTexture_frame_80/delay_sec: @@ -1909,7 +1908,7 @@ Member Variables .. _class_AnimatedTexture_frame_80/texture: -- :ref:`Texture` **frame_80/texture** +- :ref:`Texture` **frame_80/texture** .. _class_AnimatedTexture_frame_81/delay_sec: @@ -1917,7 +1916,7 @@ Member Variables .. _class_AnimatedTexture_frame_81/texture: -- :ref:`Texture` **frame_81/texture** +- :ref:`Texture` **frame_81/texture** .. _class_AnimatedTexture_frame_82/delay_sec: @@ -1925,7 +1924,7 @@ Member Variables .. _class_AnimatedTexture_frame_82/texture: -- :ref:`Texture` **frame_82/texture** +- :ref:`Texture` **frame_82/texture** .. _class_AnimatedTexture_frame_83/delay_sec: @@ -1933,7 +1932,7 @@ Member Variables .. _class_AnimatedTexture_frame_83/texture: -- :ref:`Texture` **frame_83/texture** +- :ref:`Texture` **frame_83/texture** .. _class_AnimatedTexture_frame_84/delay_sec: @@ -1941,7 +1940,7 @@ Member Variables .. _class_AnimatedTexture_frame_84/texture: -- :ref:`Texture` **frame_84/texture** +- :ref:`Texture` **frame_84/texture** .. _class_AnimatedTexture_frame_85/delay_sec: @@ -1949,7 +1948,7 @@ Member Variables .. _class_AnimatedTexture_frame_85/texture: -- :ref:`Texture` **frame_85/texture** +- :ref:`Texture` **frame_85/texture** .. _class_AnimatedTexture_frame_86/delay_sec: @@ -1957,7 +1956,7 @@ Member Variables .. _class_AnimatedTexture_frame_86/texture: -- :ref:`Texture` **frame_86/texture** +- :ref:`Texture` **frame_86/texture** .. _class_AnimatedTexture_frame_87/delay_sec: @@ -1965,7 +1964,7 @@ Member Variables .. _class_AnimatedTexture_frame_87/texture: -- :ref:`Texture` **frame_87/texture** +- :ref:`Texture` **frame_87/texture** .. _class_AnimatedTexture_frame_88/delay_sec: @@ -1973,7 +1972,7 @@ Member Variables .. _class_AnimatedTexture_frame_88/texture: -- :ref:`Texture` **frame_88/texture** +- :ref:`Texture` **frame_88/texture** .. _class_AnimatedTexture_frame_89/delay_sec: @@ -1981,7 +1980,7 @@ Member Variables .. _class_AnimatedTexture_frame_89/texture: -- :ref:`Texture` **frame_89/texture** +- :ref:`Texture` **frame_89/texture** .. _class_AnimatedTexture_frame_9/delay_sec: @@ -1989,7 +1988,7 @@ Member Variables .. _class_AnimatedTexture_frame_9/texture: -- :ref:`Texture` **frame_9/texture** +- :ref:`Texture` **frame_9/texture** .. _class_AnimatedTexture_frame_90/delay_sec: @@ -1997,7 +1996,7 @@ Member Variables .. _class_AnimatedTexture_frame_90/texture: -- :ref:`Texture` **frame_90/texture** +- :ref:`Texture` **frame_90/texture** .. _class_AnimatedTexture_frame_91/delay_sec: @@ -2005,7 +2004,7 @@ Member Variables .. _class_AnimatedTexture_frame_91/texture: -- :ref:`Texture` **frame_91/texture** +- :ref:`Texture` **frame_91/texture** .. _class_AnimatedTexture_frame_92/delay_sec: @@ -2013,7 +2012,7 @@ Member Variables .. _class_AnimatedTexture_frame_92/texture: -- :ref:`Texture` **frame_92/texture** +- :ref:`Texture` **frame_92/texture** .. _class_AnimatedTexture_frame_93/delay_sec: @@ -2021,7 +2020,7 @@ Member Variables .. _class_AnimatedTexture_frame_93/texture: -- :ref:`Texture` **frame_93/texture** +- :ref:`Texture` **frame_93/texture** .. _class_AnimatedTexture_frame_94/delay_sec: @@ -2029,7 +2028,7 @@ Member Variables .. _class_AnimatedTexture_frame_94/texture: -- :ref:`Texture` **frame_94/texture** +- :ref:`Texture` **frame_94/texture** .. _class_AnimatedTexture_frame_95/delay_sec: @@ -2037,7 +2036,7 @@ Member Variables .. _class_AnimatedTexture_frame_95/texture: -- :ref:`Texture` **frame_95/texture** +- :ref:`Texture` **frame_95/texture** .. _class_AnimatedTexture_frame_96/delay_sec: @@ -2045,7 +2044,7 @@ Member Variables .. _class_AnimatedTexture_frame_96/texture: -- :ref:`Texture` **frame_96/texture** +- :ref:`Texture` **frame_96/texture** .. _class_AnimatedTexture_frame_97/delay_sec: @@ -2053,7 +2052,7 @@ Member Variables .. _class_AnimatedTexture_frame_97/texture: -- :ref:`Texture` **frame_97/texture** +- :ref:`Texture` **frame_97/texture** .. _class_AnimatedTexture_frame_98/delay_sec: @@ -2061,7 +2060,7 @@ Member Variables .. _class_AnimatedTexture_frame_98/texture: -- :ref:`Texture` **frame_98/texture** +- :ref:`Texture` **frame_98/texture** .. _class_AnimatedTexture_frame_99/delay_sec: @@ -2069,7 +2068,7 @@ Member Variables .. _class_AnimatedTexture_frame_99/texture: -- :ref:`Texture` **frame_99/texture** +- :ref:`Texture` **frame_99/texture** .. _class_AnimatedTexture_frames: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 3cb666aac..e0b0eeb22 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -7,8 +7,7 @@ Animation ========= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,61 +15,61 @@ Brief Description Contains data used to animate everything in the engine. -Member Functions ----------------- +Methods +------- +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | +| :ref:`int` | :ref:`add_track` **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`String` | :ref:`animation_track_get_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** | +| :ref:`int` | :ref:`animation_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** | +| void | :ref:`animation_track_set_key_animation` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`audio_track_get_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`audio_track_get_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Resource` | :ref:`audio_track_get_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | +| :ref:`int` | :ref:`audio_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`audio_track_set_key_end_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`audio_track_set_key_start_offset` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`audio_track_set_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | +| void | :ref:`audio_track_set_key_stream` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Vector2` | :ref:`bezier_track_get_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Vector2` | :ref:`bezier_track_get_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`bezier_track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** | +| :ref:`int` | :ref:`bezier_track_insert_key` **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`bezier_track_interpolate` **(** :ref:`int` track, :ref:`float` time **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | +| void | :ref:`bezier_track_set_key_in_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** | +| void | :ref:`bezier_track_set_key_out_handle` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bezier_track_set_key_value` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | +| void | :ref:`copy_track` **(** :ref:`int` track, :ref:`Animation` to_animation **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_track_count` **(** **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_track` **(** :ref:`int` idx **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -78,7 +77,7 @@ Member Functions +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | +| :ref:`InterpolationType` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -86,13 +85,13 @@ Member Functions +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | +| :ref:`TrackType` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`track_is_enabled` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -112,45 +111,29 @@ Member Functions +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`track_swap` **(** :ref:`int` idx, :ref:`int` with_idx **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | +| :ref:`UpdateMode` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Animation_length: - -- :ref:`float` **length** - The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. - - .. _class_Animation_loop: - -- :ref:`bool` **loop** - A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. - - .. _class_Animation_step: - -- :ref:`float` **step** - The animation step value. - - -Enums ------ +Enumerations +------------ .. _enum_Animation_UpdateMode: @@ -186,33 +169,49 @@ Description An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. -Animations are just data containers, and must be added to odes such as an :ref:`AnimationPlayer` or :ref:`AnimationTreePlayer` to be played back. +Animations are just data containers, and must be added to odes such as an :ref:`AnimationPlayer` or :ref:`AnimationTreePlayer` to be played back. Tutorials --------- - :doc:`../tutorials/animation/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Animation_length: + +- :ref:`float` **length** - The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. + + .. _class_Animation_loop: + +- :ref:`bool` **loop** - A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. + + .. _class_Animation_step: + +- :ref:`float` **step** - The animation step value. + + +Method Descriptions +------------------- .. _class_Animation_add_track: -- :ref:`int` **add_track** **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** +- :ref:`int` **add_track** **(** :ref:`TrackType` type, :ref:`int` at_position=-1 **)** Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration. .. _class_Animation_animation_track_get_key_animation: -- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const .. _class_Animation_animation_track_insert_key: -- :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** +- :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** .. _class_Animation_animation_track_set_key_animation: -- void **animation_track_set_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** +- void **animation_track_set_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`String` animation **)** .. _class_Animation_audio_track_get_key_end_offset: @@ -224,11 +223,11 @@ Add a track to the Animation. The track type must be specified as any of the val .. _class_Animation_audio_track_get_key_stream: -- :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const .. _class_Animation_audio_track_insert_key: -- :ref:`int` **audio_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** +- :ref:`int` **audio_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`Resource` stream, :ref:`float` start_offset=0, :ref:`float` end_offset=0 **)** .. _class_Animation_audio_track_set_key_end_offset: @@ -240,15 +239,15 @@ Add a track to the Animation. The track type must be specified as any of the val .. _class_Animation_audio_track_set_key_stream: -- void **audio_track_set_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** +- void **audio_track_set_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Resource` stream **)** .. _class_Animation_bezier_track_get_key_in_handle: -- :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const .. _class_Animation_bezier_track_get_key_out_handle: -- :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const .. _class_Animation_bezier_track_get_key_value: @@ -256,7 +255,7 @@ Add a track to the Animation. The track type must be specified as any of the val .. _class_Animation_bezier_track_insert_key: -- :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** +- :ref:`int` **bezier_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`float` value, :ref:`Vector2` in_handle=Vector2( 0, 0 ), :ref:`Vector2` out_handle=Vector2( 0, 0 ) **)** .. _class_Animation_bezier_track_interpolate: @@ -264,11 +263,11 @@ Add a track to the Animation. The track type must be specified as any of the val .. _class_Animation_bezier_track_set_key_in_handle: -- void **bezier_track_set_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** +- void **bezier_track_set_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` in_handle **)** .. _class_Animation_bezier_track_set_key_out_handle: -- void **bezier_track_set_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** +- void **bezier_track_set_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`Vector2` out_handle **)** .. _class_Animation_bezier_track_set_key_value: @@ -282,13 +281,13 @@ Clear the animation (clear all tracks and reset all). .. _class_Animation_copy_track: -- void **copy_track** **(** :ref:`int` track, :ref:`Animation` to_animation **)** +- void **copy_track** **(** :ref:`int` track, :ref:`Animation` to_animation **)** Adds a new track that is a copy of the given track from ``to_animation``. .. _class_Animation_find_track: -- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const +- :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const Return the index of the specified track. If the track is not found, return -1. @@ -300,19 +299,19 @@ Return the amount of tracks in the animation. .. _class_Animation_method_track_get_key_indices: -- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **method_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a method track, given a position and delta time. .. _class_Animation_method_track_get_name: -- :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`String` **method_track_get_name** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the method name of a method track. .. _class_Animation_method_track_get_params: -- :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Array` **method_track_get_params** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the arguments values to be called on a method track for a given key in a given track. @@ -336,7 +335,7 @@ Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default v .. _class_Animation_track_get_interpolation_type: -- :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const +- :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. @@ -360,25 +359,25 @@ Return the transition curve (easing) for a specific key (see built-in math funct .. _class_Animation_track_get_key_value: -- :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const +- :ref:`Variant` **track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the value of a given key in a given track. .. _class_Animation_track_get_path: -- :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **track_get_path** **(** :ref:`int` idx **)** const Get the path of a track. for more information on the path format, see :ref:`track_set_path` .. _class_Animation_track_get_type: -- :ref:`TrackType` **track_get_type** **(** :ref:`int` idx **)** const +- :ref:`TrackType` **track_get_type** **(** :ref:`int` idx **)** const Get the type of a track. .. _class_Animation_track_insert_key: -- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** +- void **track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** Insert a generic key in a given track. @@ -438,7 +437,7 @@ If ``true`` the track at ``idx`` wraps the interpolation loop. .. _class_Animation_track_set_interpolation_type: -- void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** +- void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. @@ -450,13 +449,13 @@ Set the transition curve (easing) for a specific key (see built-in math function .. _class_Animation_track_set_key_value: -- void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** +- void **track_set_key_value** **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** Set the value of an existing key. .. _class_Animation_track_set_path: -- void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** +- void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". @@ -468,31 +467,31 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus .. _class_Animation_transform_track_insert_key: -- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** +- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** Insert a transform key for a transform track. .. _class_Animation_transform_track_interpolate: -- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const +- :ref:`Array` **transform_track_interpolate** **(** :ref:`int` idx, :ref:`float` time_sec **)** const -Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). +Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3`), rotation (:ref:`Quat`) and scale (:ref:`Vector3`). .. _class_Animation_value_track_get_key_indices: -- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const +- :ref:`PoolIntArray` **value_track_get_key_indices** **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const Return all the key indices of a value track, given a position and delta time. .. _class_Animation_value_track_get_update_mode: -- :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` idx **)** const +- :ref:`UpdateMode` **value_track_get_update_mode** **(** :ref:`int` idx **)** const Return the update mode of a value track. .. _class_Animation_value_track_set_update_mode: -- void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** +- void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** Set the update mode (UPDATE\_\*) of a value track. diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index e7f0635d6..7887cb046 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -7,10 +7,8 @@ AnimationNode ============= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationRootNode`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition`, :ref:`AnimationNodeOutput` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeTimeScale`, :ref:`AnimationRootNode`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeTimeSeek`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition`, :ref:`AnimationNodeOutput` **Category:** Core Brief Description @@ -18,37 +16,37 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_input` **(** :ref:`String` name **)** | +| void | :ref:`add_input` **(** :ref:`String` name **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | +| void | :ref:`blend_animation` **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +| :ref:`float` | :ref:`blend_input` **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +| :ref:`float` | :ref:`blend_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_caption` **(** **)** virtual | +| :ref:`String` | :ref:`get_caption` **(** **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_input_count` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | +| :ref:`String` | :ref:`get_input_name` **(** :ref:`int` input **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_parameter` **(** :ref:`String` name **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`has_filter` **(** **)** virtual | +| :ref:`String` | :ref:`has_filter` **(** **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`is_path_filtered` **(** :ref:`NodePath` path **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`process` **(** :ref:`float` time, :ref:`bool` seek **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_input` **(** :ref:`int` index **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | +| void | :ref:`set_filter_path` **(** :ref:`NodePath` path, :ref:`bool` enable **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_parameter` **(** :ref:`String` name, :ref:`Variant` value **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -63,16 +61,8 @@ Signals - **tree_changed** **(** **)** -Member Variables ----------------- - - .. _class_AnimationNode_filter_enabled: - -- :ref:`bool` **filter_enabled** - - -Enums ------ +Enumerations +------------ .. _enum_AnimationNode_FilterAction: @@ -84,28 +74,36 @@ enum **FilterAction** - **FILTER_BLEND** = **3** -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AnimationNode_filter_enabled: + +- :ref:`bool` **filter_enabled** + + +Method Descriptions +------------------- .. _class_AnimationNode_add_input: -- void **add_input** **(** :ref:`String` name **)** +- void **add_input** **(** :ref:`String` name **)** .. _class_AnimationNode_blend_animation: -- void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** +- void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** .. _class_AnimationNode_blend_input: -- :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** +- :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** .. _class_AnimationNode_blend_node: -- :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** +- :ref:`float` **blend_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** .. _class_AnimationNode_get_caption: -- :ref:`String` **get_caption** **(** **)** virtual +- :ref:`String` **get_caption** **(** **)** virtual .. _class_AnimationNode_get_input_count: @@ -113,19 +111,19 @@ Member Function Description .. _class_AnimationNode_get_input_name: -- :ref:`String` **get_input_name** **(** :ref:`int` input **)** +- :ref:`String` **get_input_name** **(** :ref:`int` input **)** .. _class_AnimationNode_get_parameter: -- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const .. _class_AnimationNode_has_filter: -- :ref:`String` **has_filter** **(** **)** virtual +- :ref:`String` **has_filter** **(** **)** virtual .. _class_AnimationNode_is_path_filtered: -- :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const .. _class_AnimationNode_process: @@ -137,10 +135,10 @@ Member Function Description .. _class_AnimationNode_set_filter_path: -- void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** +- void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** .. _class_AnimationNode_set_parameter: -- void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 6f5236db9..5c6168a6e 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -7,8 +7,7 @@ AnimationNodeAdd2 ================= -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeAdd2_sync: diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 1c5a7837e..987535670 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -7,8 +7,7 @@ AnimationNodeAdd3 ================= -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeAdd3_sync: diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index a3a62b0d0..abb95c0fa 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -7,8 +7,7 @@ AnimationNodeAnimation ====================== -**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------+--------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_time` **(** **)** const | +----------------------------+--------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeAnimation_animation: -- :ref:`String` **animation** +- :ref:`String` **animation** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeAnimation_get_playback_time: diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 040e890ca..0c12a36d5 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -7,8 +7,7 @@ AnimationNodeBlend2 =================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeBlend2_sync: diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 98b2958b2..c8908f181 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -7,8 +7,7 @@ AnimationNodeBlend3 =================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeBlend3_sync: diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index d400cef2b..190373ad4 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -7,8 +7,7 @@ AnimationNodeBlendSpace1D ========================= -**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,27 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | +| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_blend_point` **(** :ref:`int` point **)** | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`float` pos **)** | +----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeBlendSpace1D_max_space: @@ -52,15 +51,15 @@ Member Variables .. _class_AnimationNodeBlendSpace1D_value_label: -- :ref:`String` **value_label** +- :ref:`String` **value_label** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeBlendSpace1D_add_blend_point: -- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** +- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** .. _class_AnimationNodeBlendSpace1D_get_blend_point_count: @@ -68,7 +67,7 @@ Member Function Description .. _class_AnimationNodeBlendSpace1D_get_blend_point_node: -- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const .. _class_AnimationNodeBlendSpace1D_get_blend_point_position: @@ -80,7 +79,7 @@ Member Function Description .. _class_AnimationNodeBlendSpace1D_set_blend_point_node: -- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** +- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** .. _class_AnimationNodeBlendSpace1D_set_blend_point_position: diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 120c4d0c8..47244b4e9 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -7,8 +7,7 @@ AnimationNodeBlendSpace2D ========================= -**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | +| void | :ref:`add_blend_point` **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_triangle` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_point_count` **(** **)** const | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +| :ref:`AnimationRootNode` | :ref:`get_blend_point_node` **(** :ref:`int` point **)** const | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | +| :ref:`Vector2` | :ref:`get_blend_point_position` **(** :ref:`int` point **)** const | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_triangle_count` **(** **)** const | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,13 +37,13 @@ Member Functions +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_triangle` **(** :ref:`int` triangle **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | +| void | :ref:`set_blend_point_node` **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | +| void | :ref:`set_blend_point_position` **(** :ref:`int` point, :ref:`Vector2` pos **)** | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeBlendSpace2D_auto_triangles: @@ -52,31 +51,31 @@ Member Variables .. _class_AnimationNodeBlendSpace2D_max_space: -- :ref:`Vector2` **max_space** +- :ref:`Vector2` **max_space** .. _class_AnimationNodeBlendSpace2D_min_space: -- :ref:`Vector2` **min_space** +- :ref:`Vector2` **min_space** .. _class_AnimationNodeBlendSpace2D_snap: -- :ref:`Vector2` **snap** +- :ref:`Vector2` **snap** .. _class_AnimationNodeBlendSpace2D_x_label: -- :ref:`String` **x_label** +- :ref:`String` **x_label** .. _class_AnimationNodeBlendSpace2D_y_label: -- :ref:`String` **y_label** +- :ref:`String` **y_label** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeBlendSpace2D_add_blend_point: -- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** +- void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** .. _class_AnimationNodeBlendSpace2D_add_triangle: @@ -88,11 +87,11 @@ Member Function Description .. _class_AnimationNodeBlendSpace2D_get_blend_point_node: -- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const +- :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const .. _class_AnimationNodeBlendSpace2D_get_blend_point_position: -- :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const +- :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const .. _class_AnimationNodeBlendSpace2D_get_triangle_count: @@ -112,10 +111,10 @@ Member Function Description .. _class_AnimationNodeBlendSpace2D_set_blend_point_node: -- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** +- void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** .. _class_AnimationNodeBlendSpace2D_set_blend_point_position: -- void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** +- void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 629ad27fd..2e3b8d970 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -7,8 +7,7 @@ AnimationNodeBlendTree ====================== -**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,39 +15,31 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | +| void | :ref:`connect_node` **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | +| void | :ref:`disconnect_node` **(** :ref:`String` input_node, :ref:`int` input_index **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | +| void | :ref:`remove_node` **(** :ref:`String` name **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_AnimationNodeBlendTree_graph_offset: - -- :ref:`Vector2` **graph_offset** - - -Numeric Constants ------------------ +Constants +--------- - **CONNECTION_OK** = **0** - **CONNECTION_ERROR_NO_INPUT** = **1** @@ -57,43 +48,51 @@ Numeric Constants - **CONNECTION_ERROR_SAME_NODE** = **4** - **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AnimationNodeBlendTree_graph_offset: + +- :ref:`Vector2` **graph_offset** + + +Method Descriptions +------------------- .. _class_AnimationNodeBlendTree_add_node: -- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** .. _class_AnimationNodeBlendTree_connect_node: -- void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** +- void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** .. _class_AnimationNodeBlendTree_disconnect_node: -- void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** +- void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** .. _class_AnimationNodeBlendTree_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const .. _class_AnimationNodeBlendTree_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const .. _class_AnimationNodeBlendTree_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`String` name **)** const .. _class_AnimationNodeBlendTree_remove_node: -- void **remove_node** **(** :ref:`String` name **)** +- void **remove_node** **(** :ref:`String` name **)** .. _class_AnimationNodeBlendTree_rename_node: -- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** .. _class_AnimationNodeBlendTree_set_node_position: -- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index aa2c98589..8dbdfc95c 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -7,8 +7,7 @@ AnimationNodeOneShot ==================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,28 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | +| :ref:`MixMode` | :ref:`get_mix_mode` **(** **)** const | +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | +| void | :ref:`set_mix_mode` **(** :ref:`MixMode` mode **)** | +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_AnimationNodeOneShot_MixMode: + +enum **MixMode** + +- **MIX_MODE_BLEND** = **0** +- **MIX_MODE_ADD** = **1** + + +Property Descriptions +--------------------- .. _class_AnimationNodeOneShot_autorestart: @@ -53,26 +63,15 @@ Member Variables - :ref:`bool` **sync** -Enums ------ - - .. _enum_AnimationNodeOneShot_MixMode: - -enum **MixMode** - -- **MIX_MODE_BLEND** = **0** -- **MIX_MODE_ADD** = **1** - - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeOneShot_get_mix_mode: -- :ref:`MixMode` **get_mix_mode** **(** **)** const +- :ref:`MixMode` **get_mix_mode** **(** **)** const .. _class_AnimationNodeOneShot_set_mix_mode: -- void **set_mix_mode** **(** :ref:`MixMode` mode **)** +- void **set_mix_mode** **(** :ref:`MixMode` mode **)** diff --git a/classes/class_animationnodeoutput.rst b/classes/class_animationnodeoutput.rst index 7d067e481..921918eec 100644 --- a/classes/class_animationnodeoutput.rst +++ b/classes/class_animationnodeoutput.rst @@ -7,8 +7,7 @@ AnimationNodeOutput =================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index cf8810a3b..7f2a3a0f1 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -7,8 +7,7 @@ AnimationNodeStateMachine ========================= -**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationRootNode` **<** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,93 +15,93 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +| void | :ref:`add_node` **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | +| void | :ref:`add_transition` **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_end_node` **(** **)** const | +| :ref:`String` | :ref:`get_end_node` **(** **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | +| :ref:`Vector2` | :ref:`get_graph_offset` **(** **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +| :ref:`AnimationNode` | :ref:`get_node` **(** :ref:`String` name **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | +| :ref:`String` | :ref:`get_node_name` **(** :ref:`AnimationNode` node **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` name **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_start_node` **(** **)** const | +| :ref:`String` | :ref:`get_start_node` **(** **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | +| :ref:`AnimationNodeStateMachineTransition` | :ref:`get_transition` **(** :ref:`int` idx **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_transition_count` **(** **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_transition_from` **(** :ref:`int` idx **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_transition_to` **(** :ref:`int` idx **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` name **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** const | +| :ref:`bool` | :ref:`has_transition` **(** :ref:`String` from, :ref:`String` to **)** const | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` name **)** | +| void | :ref:`remove_node` **(** :ref:`String` name **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | +| void | :ref:`remove_transition` **(** :ref:`String` from, :ref:`String` to **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_transition_by_index` **(** :ref:`int` idx **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | +| void | :ref:`rename_node` **(** :ref:`String` name, :ref:`String` new_name **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_node` **(** :ref:`String` name **)** | +| void | :ref:`set_end_node` **(** :ref:`String` name **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | +| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | +| void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_start_node` **(** :ref:`String` name **)** | +| void | :ref:`set_start_node` **(** :ref:`String` name **)** | +----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeStateMachine_add_node: -- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** .. _class_AnimationNodeStateMachine_add_transition: -- void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** +- void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** .. _class_AnimationNodeStateMachine_get_end_node: -- :ref:`String` **get_end_node** **(** **)** const +- :ref:`String` **get_end_node** **(** **)** const .. _class_AnimationNodeStateMachine_get_graph_offset: -- :ref:`Vector2` **get_graph_offset** **(** **)** const +- :ref:`Vector2` **get_graph_offset** **(** **)** const .. _class_AnimationNodeStateMachine_get_node: -- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const +- :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const .. _class_AnimationNodeStateMachine_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const +- :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const .. _class_AnimationNodeStateMachine_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const .. _class_AnimationNodeStateMachine_get_start_node: -- :ref:`String` **get_start_node** **(** **)** const +- :ref:`String` **get_start_node** **(** **)** const .. _class_AnimationNodeStateMachine_get_transition: -- :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const +- :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const .. _class_AnimationNodeStateMachine_get_transition_count: @@ -110,27 +109,27 @@ Member Function Description .. _class_AnimationNodeStateMachine_get_transition_from: -- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const +- :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const .. _class_AnimationNodeStateMachine_get_transition_to: -- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const +- :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const .. _class_AnimationNodeStateMachine_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` name **)** const +- :ref:`bool` **has_node** **(** :ref:`String` name **)** const .. _class_AnimationNodeStateMachine_has_transition: -- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const +- :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const .. _class_AnimationNodeStateMachine_remove_node: -- void **remove_node** **(** :ref:`String` name **)** +- void **remove_node** **(** :ref:`String` name **)** .. _class_AnimationNodeStateMachine_remove_transition: -- void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** +- void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** .. _class_AnimationNodeStateMachine_remove_transition_by_index: @@ -138,22 +137,22 @@ Member Function Description .. _class_AnimationNodeStateMachine_rename_node: -- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** .. _class_AnimationNodeStateMachine_set_end_node: -- void **set_end_node** **(** :ref:`String` name **)** +- void **set_end_node** **(** :ref:`String` name **)** .. _class_AnimationNodeStateMachine_set_graph_offset: -- void **set_graph_offset** **(** :ref:`Vector2` name **)** +- void **set_graph_offset** **(** :ref:`Vector2` name **)** .. _class_AnimationNodeStateMachine_set_node_position: -- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** .. _class_AnimationNodeStateMachine_set_start_node: -- void **set_start_node** **(** :ref:`String` name **)** +- void **set_start_node** **(** :ref:`String` name **)** diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 97b789dee..b5d1449cd 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -7,8 +7,7 @@ AnimationNodeStateMachinePlayback ================================= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,33 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_node` **(** **)** const | +| :ref:`String` | :ref:`get_current_node` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_travel_path` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start` **(** :ref:`String` node **)** | +| void | :ref:`start` **(** :ref:`String` node **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`travel` **(** :ref:`String` to_node **)** | +| void | :ref:`travel` **(** :ref:`String` to_node **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationNodeStateMachinePlayback_get_current_node: -- :ref:`String` **get_current_node** **(** **)** const +- :ref:`String` **get_current_node** **(** **)** const .. _class_AnimationNodeStateMachinePlayback_get_travel_path: -- :ref:`PoolStringArray` **get_travel_path** **(** **)** const +- :ref:`PoolStringArray` **get_travel_path** **(** **)** const .. _class_AnimationNodeStateMachinePlayback_is_playing: @@ -50,7 +49,7 @@ Member Function Description .. _class_AnimationNodeStateMachinePlayback_start: -- void **start** **(** :ref:`String` node **)** +- void **start** **(** :ref:`String` node **)** .. _class_AnimationNodeStateMachinePlayback_stop: @@ -58,6 +57,6 @@ Member Function Description .. _class_AnimationNodeStateMachinePlayback_travel: -- void **travel** **(** :ref:`String` to_node **)** +- void **travel** **(** :ref:`String` to_node **)** diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 7bdfca8db..4db449f7c 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -7,8 +7,7 @@ AnimationNodeStateMachineTransition =================================== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -24,12 +23,24 @@ Signals - **advance_condition_changed** **(** **)** -Member Variables ----------------- +Enumerations +------------ + + .. _enum_AnimationNodeStateMachineTransition_SwitchMode: + +enum **SwitchMode** + +- **SWITCH_MODE_IMMEDIATE** = **0** +- **SWITCH_MODE_SYNC** = **1** +- **SWITCH_MODE_AT_END** = **2** + + +Property Descriptions +--------------------- .. _class_AnimationNodeStateMachineTransition_advance_condition: -- :ref:`String` **advance_condition** +- :ref:`String` **advance_condition** .. _class_AnimationNodeStateMachineTransition_auto_advance: @@ -45,22 +56,10 @@ Member Variables .. _class_AnimationNodeStateMachineTransition_switch_mode: -- :ref:`SwitchMode` **switch_mode** +- :ref:`SwitchMode` **switch_mode** .. _class_AnimationNodeStateMachineTransition_xfade_time: - :ref:`float` **xfade_time** -Enums ------ - - .. _enum_AnimationNodeStateMachineTransition_SwitchMode: - -enum **SwitchMode** - -- **SWITCH_MODE_IMMEDIATE** = **0** -- **SWITCH_MODE_SYNC** = **1** -- **SWITCH_MODE_AT_END** = **2** - - diff --git a/classes/class_animationnodetimescale.rst b/classes/class_animationnodetimescale.rst index b199199fa..720a657b7 100644 --- a/classes/class_animationnodetimescale.rst +++ b/classes/class_animationnodetimescale.rst @@ -7,8 +7,7 @@ AnimationNodeTimeScale ====================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_animationnodetimeseek.rst b/classes/class_animationnodetimeseek.rst index f0a61ad13..dad6205dd 100644 --- a/classes/class_animationnodetimeseek.rst +++ b/classes/class_animationnodetimeseek.rst @@ -7,8 +7,7 @@ AnimationNodeTimeSeek ===================== -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index 70d0bda54..d15b48bd3 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -7,8 +7,7 @@ AnimationNodeTransition ======================= -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AnimationNodeTransition_input_0/auto_advance: @@ -25,7 +24,7 @@ Member Variables .. _class_AnimationNodeTransition_input_0/name: -- :ref:`String` **input_0/name** +- :ref:`String` **input_0/name** .. _class_AnimationNodeTransition_input_1/auto_advance: @@ -33,7 +32,7 @@ Member Variables .. _class_AnimationNodeTransition_input_1/name: -- :ref:`String` **input_1/name** +- :ref:`String` **input_1/name** .. _class_AnimationNodeTransition_input_10/auto_advance: @@ -41,7 +40,7 @@ Member Variables .. _class_AnimationNodeTransition_input_10/name: -- :ref:`String` **input_10/name** +- :ref:`String` **input_10/name** .. _class_AnimationNodeTransition_input_11/auto_advance: @@ -49,7 +48,7 @@ Member Variables .. _class_AnimationNodeTransition_input_11/name: -- :ref:`String` **input_11/name** +- :ref:`String` **input_11/name** .. _class_AnimationNodeTransition_input_12/auto_advance: @@ -57,7 +56,7 @@ Member Variables .. _class_AnimationNodeTransition_input_12/name: -- :ref:`String` **input_12/name** +- :ref:`String` **input_12/name** .. _class_AnimationNodeTransition_input_13/auto_advance: @@ -65,7 +64,7 @@ Member Variables .. _class_AnimationNodeTransition_input_13/name: -- :ref:`String` **input_13/name** +- :ref:`String` **input_13/name** .. _class_AnimationNodeTransition_input_14/auto_advance: @@ -73,7 +72,7 @@ Member Variables .. _class_AnimationNodeTransition_input_14/name: -- :ref:`String` **input_14/name** +- :ref:`String` **input_14/name** .. _class_AnimationNodeTransition_input_15/auto_advance: @@ -81,7 +80,7 @@ Member Variables .. _class_AnimationNodeTransition_input_15/name: -- :ref:`String` **input_15/name** +- :ref:`String` **input_15/name** .. _class_AnimationNodeTransition_input_16/auto_advance: @@ -89,7 +88,7 @@ Member Variables .. _class_AnimationNodeTransition_input_16/name: -- :ref:`String` **input_16/name** +- :ref:`String` **input_16/name** .. _class_AnimationNodeTransition_input_17/auto_advance: @@ -97,7 +96,7 @@ Member Variables .. _class_AnimationNodeTransition_input_17/name: -- :ref:`String` **input_17/name** +- :ref:`String` **input_17/name** .. _class_AnimationNodeTransition_input_18/auto_advance: @@ -105,7 +104,7 @@ Member Variables .. _class_AnimationNodeTransition_input_18/name: -- :ref:`String` **input_18/name** +- :ref:`String` **input_18/name** .. _class_AnimationNodeTransition_input_19/auto_advance: @@ -113,7 +112,7 @@ Member Variables .. _class_AnimationNodeTransition_input_19/name: -- :ref:`String` **input_19/name** +- :ref:`String` **input_19/name** .. _class_AnimationNodeTransition_input_2/auto_advance: @@ -121,7 +120,7 @@ Member Variables .. _class_AnimationNodeTransition_input_2/name: -- :ref:`String` **input_2/name** +- :ref:`String` **input_2/name** .. _class_AnimationNodeTransition_input_20/auto_advance: @@ -129,7 +128,7 @@ Member Variables .. _class_AnimationNodeTransition_input_20/name: -- :ref:`String` **input_20/name** +- :ref:`String` **input_20/name** .. _class_AnimationNodeTransition_input_21/auto_advance: @@ -137,7 +136,7 @@ Member Variables .. _class_AnimationNodeTransition_input_21/name: -- :ref:`String` **input_21/name** +- :ref:`String` **input_21/name** .. _class_AnimationNodeTransition_input_22/auto_advance: @@ -145,7 +144,7 @@ Member Variables .. _class_AnimationNodeTransition_input_22/name: -- :ref:`String` **input_22/name** +- :ref:`String` **input_22/name** .. _class_AnimationNodeTransition_input_23/auto_advance: @@ -153,7 +152,7 @@ Member Variables .. _class_AnimationNodeTransition_input_23/name: -- :ref:`String` **input_23/name** +- :ref:`String` **input_23/name** .. _class_AnimationNodeTransition_input_24/auto_advance: @@ -161,7 +160,7 @@ Member Variables .. _class_AnimationNodeTransition_input_24/name: -- :ref:`String` **input_24/name** +- :ref:`String` **input_24/name** .. _class_AnimationNodeTransition_input_25/auto_advance: @@ -169,7 +168,7 @@ Member Variables .. _class_AnimationNodeTransition_input_25/name: -- :ref:`String` **input_25/name** +- :ref:`String` **input_25/name** .. _class_AnimationNodeTransition_input_26/auto_advance: @@ -177,7 +176,7 @@ Member Variables .. _class_AnimationNodeTransition_input_26/name: -- :ref:`String` **input_26/name** +- :ref:`String` **input_26/name** .. _class_AnimationNodeTransition_input_27/auto_advance: @@ -185,7 +184,7 @@ Member Variables .. _class_AnimationNodeTransition_input_27/name: -- :ref:`String` **input_27/name** +- :ref:`String` **input_27/name** .. _class_AnimationNodeTransition_input_28/auto_advance: @@ -193,7 +192,7 @@ Member Variables .. _class_AnimationNodeTransition_input_28/name: -- :ref:`String` **input_28/name** +- :ref:`String` **input_28/name** .. _class_AnimationNodeTransition_input_29/auto_advance: @@ -201,7 +200,7 @@ Member Variables .. _class_AnimationNodeTransition_input_29/name: -- :ref:`String` **input_29/name** +- :ref:`String` **input_29/name** .. _class_AnimationNodeTransition_input_3/auto_advance: @@ -209,7 +208,7 @@ Member Variables .. _class_AnimationNodeTransition_input_3/name: -- :ref:`String` **input_3/name** +- :ref:`String` **input_3/name** .. _class_AnimationNodeTransition_input_30/auto_advance: @@ -217,7 +216,7 @@ Member Variables .. _class_AnimationNodeTransition_input_30/name: -- :ref:`String` **input_30/name** +- :ref:`String` **input_30/name** .. _class_AnimationNodeTransition_input_31/auto_advance: @@ -225,7 +224,7 @@ Member Variables .. _class_AnimationNodeTransition_input_31/name: -- :ref:`String` **input_31/name** +- :ref:`String` **input_31/name** .. _class_AnimationNodeTransition_input_4/auto_advance: @@ -233,7 +232,7 @@ Member Variables .. _class_AnimationNodeTransition_input_4/name: -- :ref:`String` **input_4/name** +- :ref:`String` **input_4/name** .. _class_AnimationNodeTransition_input_5/auto_advance: @@ -241,7 +240,7 @@ Member Variables .. _class_AnimationNodeTransition_input_5/name: -- :ref:`String` **input_5/name** +- :ref:`String` **input_5/name** .. _class_AnimationNodeTransition_input_6/auto_advance: @@ -249,7 +248,7 @@ Member Variables .. _class_AnimationNodeTransition_input_6/name: -- :ref:`String` **input_6/name** +- :ref:`String` **input_6/name** .. _class_AnimationNodeTransition_input_7/auto_advance: @@ -257,7 +256,7 @@ Member Variables .. _class_AnimationNodeTransition_input_7/name: -- :ref:`String` **input_7/name** +- :ref:`String` **input_7/name** .. _class_AnimationNodeTransition_input_8/auto_advance: @@ -265,7 +264,7 @@ Member Variables .. _class_AnimationNodeTransition_input_8/name: -- :ref:`String` **input_8/name** +- :ref:`String` **input_8/name** .. _class_AnimationNodeTransition_input_9/auto_advance: @@ -273,7 +272,7 @@ Member Variables .. _class_AnimationNodeTransition_input_9/name: -- :ref:`String` **input_9/name** +- :ref:`String` **input_9/name** .. _class_AnimationNodeTransition_input_count: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 823f54001..707dc518d 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -7,58 +7,57 @@ AnimationPlayer =============== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Container and player of :ref:`Animation` resources. +Container and player of :ref:`Animation` resources. -Member Functions ----------------- +Methods +------- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | +| :ref:`Error` | :ref:`add_animation` **(** :ref:`String` name, :ref:`Animation` animation **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | +| :ref:`String` | :ref:`animation_get_next` **(** :ref:`String` anim_from **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | +| void | :ref:`animation_set_next` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_caches` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_queue` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | +| :ref:`String` | :ref:`find_animation` **(** :ref:`Animation` animation **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | +| :ref:`Animation` | :ref:`get_animation` **(** :ref:`String` name **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_animation_list` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | +| :ref:`float` | :ref:`get_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playing_speed` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` name **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | +| void | :ref:`play` **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | +| void | :ref:`play_backwards` **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue` **(** :ref:`String` name **)** | +| void | :ref:`queue` **(** :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` name **)** | +| void | :ref:`remove_animation` **(** :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | +| void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | +| void | :ref:`set_blend_time` **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** :ref:`bool` reset=true **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,19 +67,19 @@ Signals .. _class_AnimationPlayer_animation_changed: -- **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +- **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** If the currently being played animation changes, this signal will notify of such change. .. _class_AnimationPlayer_animation_finished: -- **animation_finished** **(** :ref:`String` anim_name **)** +- **animation_finished** **(** :ref:`String` anim_name **)** Notifies when an animation finished playing. .. _class_AnimationPlayer_animation_started: -- **animation_started** **(** :ref:`String` anim_name **)** +- **animation_started** **(** :ref:`String` anim_name **)** Notifies when an animation starts playing. @@ -89,20 +88,43 @@ Notifies when an animation starts playing. - **caches_cleared** **(** **)** -Member Variables ----------------- +Enumerations +------------ + + .. _enum_AnimationPlayer_AnimationProcessMode: + +enum **AnimationProcessMode** + +- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. +- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. +- **ANIMATION_PROCESS_MANUAL** = **2** --- Do not process animation. Use the 'advance' method to process the animation manually. + + +Description +----------- + +An animation player is used for general purpose playback of :ref:`Animation` resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. + +Tutorials +--------- + +- :doc:`../getting_started/step_by_step/animations` +- :doc:`../tutorials/animation/index` + +Property Descriptions +--------------------- .. _class_AnimationPlayer_assigned_animation: -- :ref:`String` **assigned_animation** - If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation`. +- :ref:`String` **assigned_animation** - If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation`. .. _class_AnimationPlayer_autoplay: -- :ref:`String` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``. +- :ref:`String` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``. .. _class_AnimationPlayer_current_animation: -- :ref:`String` **current_animation** - The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play`. Default value: ``""``. +- :ref:`String` **current_animation** - The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also :ref:`play`. Default value: ``""``. .. _class_AnimationPlayer_current_animation_length: @@ -122,7 +144,7 @@ Member Variables .. _class_AnimationPlayer_playback_process_mode: -- :ref:`AnimationProcessMode` **playback_process_mode** - The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. +- :ref:`AnimationProcessMode` **playback_process_mode** - The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. .. _class_AnimationPlayer_playback_speed: @@ -130,38 +152,15 @@ Member Variables .. _class_AnimationPlayer_root_node: -- :ref:`NodePath` **root_node** - The node from which node path references will travel. Default value: ``".."``. +- :ref:`NodePath` **root_node** - The node from which node path references will travel. Default value: ``".."``. -Enums ------ - - .. _enum_AnimationPlayer_AnimationProcessMode: - -enum **AnimationProcessMode** - -- **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies. -- **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process. -- **ANIMATION_PROCESS_MANUAL** = **2** --- Do not process animation. Use the 'advance' method to process the animation manually. - - -Description ------------ - -An animation player is used for general purpose playback of :ref:`Animation` resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. - -Tutorials ---------- - -- :doc:`../getting_started/step_by_step/animations` -- :doc:`../tutorials/animation/index` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AnimationPlayer_add_animation: -- :ref:`Error` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** +- :ref:`Error` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** Adds ``animation`` to the player accessible with the key ``name``. @@ -173,13 +172,13 @@ Shifts position in the animation timeline. Delta is the time in seconds to shift .. _class_AnimationPlayer_animation_get_next: -- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const +- :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const Returns the name of the next animation in the queue. .. _class_AnimationPlayer_animation_set_next: -- void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** +- void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. @@ -197,25 +196,25 @@ Clears all queued, unplayed animations. .. _class_AnimationPlayer_find_animation: -- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const +- :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const Returns the name of ``animation`` or empty string if not found. .. _class_AnimationPlayer_get_animation: -- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const +- :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const -Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. +Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. .. _class_AnimationPlayer_get_animation_list: -- :ref:`PoolStringArray` **get_animation_list** **(** **)** const +- :ref:`PoolStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. .. _class_AnimationPlayer_get_blend_time: -- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const +- :ref:`float` **get_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** const Get the blend time (in seconds) between two animations, referenced by their names. @@ -227,9 +226,9 @@ Get the actual playing speed of current animation or 0 if not playing. This spee .. _class_AnimationPlayer_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` name **)** const -Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. +Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. .. _class_AnimationPlayer_is_playing: @@ -239,31 +238,31 @@ Returns ``true`` if playing an animation. .. _class_AnimationPlayer_play: -- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** +- void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. .. _class_AnimationPlayer_play_backwards: -- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** +- void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** Play the animation with key ``name`` in reverse. .. _class_AnimationPlayer_queue: -- void **queue** **(** :ref:`String` name **)** +- void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. .. _class_AnimationPlayer_remove_animation: -- void **remove_animation** **(** :ref:`String` name **)** +- void **remove_animation** **(** :ref:`String` name **)** Remove the animation with key ``name``. .. _class_AnimationPlayer_rename_animation: -- void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** Rename an existing animation with key ``name`` to ``newname``. @@ -275,7 +274,7 @@ Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` .. _class_AnimationPlayer_set_blend_time: -- void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** +- void **set_blend_time** **(** :ref:`String` anim_from, :ref:`String` anim_to, :ref:`float` sec **)** Specify a blend time (in seconds) between two animations, referenced by their names. diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index 88696a525..ac24ca93c 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -7,10 +7,8 @@ AnimationRootNode ================= -**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendTree` - +**Inherits:** :ref:`AnimationNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeStateMachine`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendTree` **Category:** Core Brief Description diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index fa504aef3..ca8c95f12 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -7,8 +7,7 @@ AnimationTrackEditPlugin ======================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 481016077..1a642e0db 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -7,8 +7,7 @@ AnimationTree ============= -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,19 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | +| :ref:`Transform` | :ref:`get_root_motion_transform` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | +| void | :ref:`rename_parameter` **(** :ref:`String` old_name, :ref:`String` new_name **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_AnimationTree_active: - -- :ref:`bool` **active** - - .. _class_AnimationTree_anim_player: - -- :ref:`NodePath` **anim_player** - - .. _class_AnimationTree_process_mode: - -- :ref:`AnimationProcessMode` **process_mode** - - .. _class_AnimationTree_root_motion_track: - -- :ref:`NodePath` **root_motion_track** - - .. _class_AnimationTree_tree_root: - -- :ref:`AnimationNode` **tree_root** - - -Enums ------ +Enumerations +------------ .. _enum_AnimationTree_AnimationProcessMode: @@ -63,8 +38,32 @@ enum **AnimationProcessMode** - **ANIMATION_PROCESS_MANUAL** = **2** -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AnimationTree_active: + +- :ref:`bool` **active** + + .. _class_AnimationTree_anim_player: + +- :ref:`NodePath` **anim_player** + + .. _class_AnimationTree_process_mode: + +- :ref:`AnimationProcessMode` **process_mode** + + .. _class_AnimationTree_root_motion_track: + +- :ref:`NodePath` **root_motion_track** + + .. _class_AnimationTree_tree_root: + +- :ref:`AnimationNode` **tree_root** + + +Method Descriptions +------------------- .. _class_AnimationTree_advance: @@ -72,10 +71,10 @@ Member Function Description .. _class_AnimationTree_get_root_motion_transform: -- :ref:`Transform` **get_root_motion_transform** **(** **)** const +- :ref:`Transform` **get_root_motion_transform** **(** **)** const .. _class_AnimationTree_rename_parameter: -- void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** +- void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 1c7b70580..6e6c32c7d 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -7,8 +7,7 @@ AnimationTreePlayer =================== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,151 +15,127 @@ Brief Description Animation Player that uses a node graph for blending Animations. -Member Functions ----------------- +Methods +------- +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`NodeType` type, :ref:`String` id **)** | +| void | :ref:`add_node` **(** :ref:`NodeType` type, :ref:`String` id **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`advance` **(** :ref:`float` delta **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | +| :ref:`Animation` | :ref:`animation_node_get_animation` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | +| :ref:`String` | :ref:`animation_node_get_master_animation` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`animation_node_get_position` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`animation_node_get_position` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | +| void | :ref:`animation_node_set_animation` **(** :ref:`String` id, :ref:`Animation` animation **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +| void | :ref:`animation_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | +| void | :ref:`animation_node_set_master_animation` **(** :ref:`String` id, :ref:`String` source **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | +| :ref:`bool` | :ref:`are_nodes_connected` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`blend2_node_get_amount` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +| void | :ref:`blend2_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +| void | :ref:`blend2_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`blend3_node_get_amount` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +| void | :ref:`blend3_node_set_amount` **(** :ref:`String` id, :ref:`float` blend **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`Vector2` | :ref:`blend4_node_get_amount` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | +| void | :ref:`blend4_node_set_amount` **(** :ref:`String` id, :ref:`Vector2` blend **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | +| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | +| void | :ref:`disconnect_nodes` **(** :ref:`String` id, :ref:`int` dst_input_idx **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | +| :ref:`PoolStringArray` | :ref:`get_node_list` **(** **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`mix_node_get_amount` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | +| void | :ref:`mix_node_set_amount` **(** :ref:`String` id, :ref:`float` ratio **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | +| :ref:`bool` | :ref:`node_exists` **(** :ref:`String` node **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`node_get_input_count` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | +| :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | +| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodeType` | :ref:`node_get_type` **(** :ref:`String` id **)** const | +| :ref:`NodeType` | :ref:`node_get_type` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | +| :ref:`Error` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | +| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_autorestart_random_delay` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_fadein_time` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`oneshot_node_get_fadeout_time` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | +| :ref:`bool` | :ref:`oneshot_node_has_autorestart` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | +| :ref:`bool` | :ref:`oneshot_node_is_active` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | +| void | :ref:`oneshot_node_set_autorestart` **(** :ref:`String` id, :ref:`bool` enable **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | +| void | :ref:`oneshot_node_set_autorestart_delay` **(** :ref:`String` id, :ref:`float` delay_sec **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | +| void | :ref:`oneshot_node_set_autorestart_random_delay` **(** :ref:`String` id, :ref:`float` rand_sec **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +| void | :ref:`oneshot_node_set_fadein_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +| void | :ref:`oneshot_node_set_fadeout_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +| void | :ref:`oneshot_node_set_filter_path` **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | +| void | :ref:`oneshot_node_start` **(** :ref:`String` id **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | +| void | :ref:`oneshot_node_stop` **(** :ref:`String` id **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`recompute_caches` **(** **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` id **)** | +| void | :ref:`remove_node` **(** :ref:`String` id **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reset` **(** **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`timescale_node_get_scale` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | +| void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | +| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | +| void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`transition_node_get_current` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | +| :ref:`int` | :ref:`transition_node_get_input_count` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | +| :ref:`float` | :ref:`transition_node_get_xfade_time` **(** :ref:`String` id **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | +| :ref:`bool` | :ref:`transition_node_has_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx **)** const | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | +| void | :ref:`transition_node_set_current` **(** :ref:`String` id, :ref:`int` input_idx **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | +| void | :ref:`transition_node_set_input_auto_advance` **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | +| void | :ref:`transition_node_set_input_count` **(** :ref:`String` id, :ref:`int` count **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +| void | :ref:`transition_node_set_xfade_time` **(** :ref:`String` id, :ref:`float` time_sec **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_AnimationTreePlayer_active: - -- :ref:`bool` **active** - If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. - - .. _class_AnimationTreePlayer_base_path: - -- :ref:`NodePath` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``. - -It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. - - .. _class_AnimationTreePlayer_master_player: - -- :ref:`NodePath` **master_player** - The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. - -Once set, Animation nodes can be added to the AnimationTreePlayer. - - .. _class_AnimationTreePlayer_playback_process_mode: - -- :ref:`AnimationProcessMode` **playback_process_mode** - The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. - - -Enums ------ +Enumerations +------------ .. _enum_AnimationTreePlayer_AnimationProcessMode: @@ -188,16 +163,40 @@ enum **NodeType** Description ----------- -A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. +A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose. -It takes :ref:`Animation`\ s from an :ref:`AnimationPlayer` node and mixes them depending on the graph. +It takes :ref:`Animation`\ s from an :ref:`AnimationPlayer` node and mixes them depending on the graph. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AnimationTreePlayer_active: + +- :ref:`bool` **active** - If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. + + .. _class_AnimationTreePlayer_base_path: + +- :ref:`NodePath` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``. + +It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at. + + .. _class_AnimationTreePlayer_master_player: + +- :ref:`NodePath` **master_player** - The path to the :ref:`AnimationPlayer` from which this ``AnimationTreePlayer`` binds animations to animation nodes. + +Once set, Animation nodes can be added to the AnimationTreePlayer. + + .. _class_AnimationTreePlayer_playback_process_mode: + +- :ref:`AnimationProcessMode` **playback_process_mode** - The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. + + +Method Descriptions +------------------- .. _class_AnimationTreePlayer_add_node: -- void **add_node** **(** :ref:`NodeType` type, :ref:`String` id **)** +- void **add_node** **(** :ref:`NodeType` type, :ref:`String` id **)** Adds a ``type`` node to the graph with name ``id``. @@ -209,53 +208,53 @@ Shifts position in the animation timeline. Delta is the time in seconds to shift .. _class_AnimationTreePlayer_animation_node_get_animation: -- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const +- :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const -Returns the :ref:`AnimationPlayer`'s :ref:`Animation` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. +Returns the :ref:`AnimationPlayer`'s :ref:`Animation` bound to the ``AnimationTreePlayer``'s animation node with name ``id``. .. _class_AnimationTreePlayer_animation_node_get_master_animation: -- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const +- :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const -Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. +Returns the name of the :ref:`master_player`'s :ref:`Animation` bound to this animation node. .. _class_AnimationTreePlayer_animation_node_get_position: -- :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const +- :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const .. _class_AnimationTreePlayer_animation_node_set_animation: -- void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** +- void **animation_node_set_animation** **(** :ref:`String` id, :ref:`Animation` animation **)** -Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. +Binds a new :ref:`Animation` from the :ref:`master_player` to the ``AnimationTreePlayer``'s animation node with name ``id``. .. _class_AnimationTreePlayer_animation_node_set_filter_path: -- void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **animation_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. .. _class_AnimationTreePlayer_animation_node_set_master_animation: -- void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** +- void **animation_node_set_master_animation** **(** :ref:`String` id, :ref:`String` source **)** -Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. +Binds the :ref:`Animation` named ``source`` from :ref:`master_player` to the animation node ``id``. Recalculates caches. .. _class_AnimationTreePlayer_are_nodes_connected: -- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const +- :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. .. _class_AnimationTreePlayer_blend2_node_get_amount: -- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend2 node given its name. .. _class_AnimationTreePlayer_blend2_node_set_amount: -- void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +- void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** Sets the blend amount of a Blend2 node given its name and value. @@ -269,19 +268,19 @@ At 1, Output is input b. .. _class_AnimationTreePlayer_blend2_node_set_filter_path: -- void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the blend2 node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. .. _class_AnimationTreePlayer_blend3_node_get_amount: -- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend3 node given its name. .. _class_AnimationTreePlayer_blend3_node_set_amount: -- void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +- void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** Sets the blend amount of a Blend3 node given its name and value. @@ -299,13 +298,13 @@ At 1, Output is input b+. .. _class_AnimationTreePlayer_blend4_node_get_amount: -- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`Vector2` **blend4_node_get_amount** **(** :ref:`String` id **)** const Returns the blend amount of a Blend4 node given its name. .. _class_AnimationTreePlayer_blend4_node_set_amount: -- void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** +- void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** Sets the blend amount of a Blend4 node given its name and value. @@ -315,31 +314,31 @@ The two pairs are blended like blend2 and then added together. .. _class_AnimationTreePlayer_connect_nodes: -- :ref:`Error` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** +- :ref:`Error` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** Connects node ``id`` to ``dst_id`` at the specified input slot. .. _class_AnimationTreePlayer_disconnect_nodes: -- void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** +- void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** Disconnects nodes connected to ``id`` at the specified input slot. .. _class_AnimationTreePlayer_get_node_list: -- :ref:`PoolStringArray` **get_node_list** **(** **)** +- :ref:`PoolStringArray` **get_node_list** **(** **)** -Returns a :ref:`PoolStringArray` containing the name of all nodes. +Returns a :ref:`PoolStringArray` containing the name of all nodes. .. _class_AnimationTreePlayer_mix_node_get_amount: -- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const +- :ref:`float` **mix_node_get_amount** **(** :ref:`String` id **)** const Returns mix amount of a Mix node given its name. .. _class_AnimationTreePlayer_mix_node_set_amount: -- void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** +- void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** Sets mix amount of a Mix node given its name and value. @@ -347,127 +346,127 @@ A Mix node adds input b to input a by a the amount given by ratio. .. _class_AnimationTreePlayer_node_exists: -- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const +- :ref:`bool` **node_exists** **(** :ref:`String` node **)** const Check if a node exists (by name). .. _class_AnimationTreePlayer_node_get_input_count: -- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **node_get_input_count** **(** :ref:`String` id **)** const Return the input count for a given node. Different types of nodes have different amount of inputs. .. _class_AnimationTreePlayer_node_get_input_source: -- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const +- :ref:`String` **node_get_input_source** **(** :ref:`String` id, :ref:`int` idx **)** const Return the input source for a given node input. .. _class_AnimationTreePlayer_node_get_position: -- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const +- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const Returns position of a node in the graph given its name. .. _class_AnimationTreePlayer_node_get_type: -- :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const +- :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const Get the node type, will return from NODE\_\* enum. .. _class_AnimationTreePlayer_node_rename: -- :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** +- :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** Rename a node in the graph. .. _class_AnimationTreePlayer_node_set_position: -- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** +- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** Sets position of a node in the graph given its name and position. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay: -- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const Returns autostart delay of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay: -- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const Returns autostart random delay of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_fadein_time: -- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const Returns fade in time of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time: -- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const +- :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const Returns fade out time of a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_has_autorestart: -- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const Returns whether a OneShot node will auto restart given its name. .. _class_AnimationTreePlayer_oneshot_node_is_active: -- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const +- :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const Returns whether a OneShot node is active given its name. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart: -- void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** +- void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** Sets autorestart property of a OneShot node given its name and value. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay: -- void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** +- void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** Sets autorestart delay of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay: -- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** +- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** Sets autorestart random delay of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_fadein_time: -- void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade in time of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time: -- void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** Sets fade out time of a OneShot node given its name and value in seconds. .. _class_AnimationTreePlayer_oneshot_node_set_filter_path: -- void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** +- void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** If ``enable`` is ``true``, the oneshot node with ID ``id`` turns off the track modifying the property at ``path``. The modified node's children continue to animate. .. _class_AnimationTreePlayer_oneshot_node_start: -- void **oneshot_node_start** **(** :ref:`String` id **)** +- void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. .. _class_AnimationTreePlayer_oneshot_node_stop: -- void **oneshot_node_stop** **(** :ref:`String` id **)** +- void **oneshot_node_stop** **(** :ref:`String` id **)** Stops the OneShot node with name ``id``. @@ -479,7 +478,7 @@ Manually recalculates the cache of track information generated from animation no .. _class_AnimationTreePlayer_remove_node: -- void **remove_node** **(** :ref:`String` id **)** +- void **remove_node** **(** :ref:`String` id **)** Removes the animation node with name ``id``. @@ -491,79 +490,79 @@ Resets this ``AnimationTreePlayer``. .. _class_AnimationTreePlayer_timescale_node_get_scale: -- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const +- :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const Returns time scale value of the TimeScale node with name ``id``. .. _class_AnimationTreePlayer_timescale_node_set_scale: -- void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** +- void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** Sets the time scale of the TimeScale node with name ``id`` to ``scale``. -The timescale node is used to speed :ref:`Animation`\ s up if the scale is above 1 or slow them down if it is below 1. +The timescale node is used to speed :ref:`Animation`\ s up if the scale is above 1 or slow them down if it is below 1. If applied after a blend or mix, affects all input animations to that blend or mix. .. _class_AnimationTreePlayer_timeseek_node_seek: -- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** +- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds`` -This functions as a seek in the :ref:`Animation` or the blend or mix of :ref:`Animation`\ s input in it. +This functions as a seek in the :ref:`Animation` or the blend or mix of :ref:`Animation`\ s input in it. .. _class_AnimationTreePlayer_transition_node_delete_input: -- void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** +- void **transition_node_delete_input** **(** :ref:`String` id, :ref:`int` input_idx **)** Deletes the input at ``input_idx`` for the transition node with name ``id``. .. _class_AnimationTreePlayer_transition_node_get_current: -- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_current** **(** :ref:`String` id **)** const Returns the index of the currently evaluated input for the transition node with name ``id``. .. _class_AnimationTreePlayer_transition_node_get_input_count: -- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const +- :ref:`int` **transition_node_get_input_count** **(** :ref:`String` id **)** const Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node. .. _class_AnimationTreePlayer_transition_node_get_xfade_time: -- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const +- :ref:`float` **transition_node_get_xfade_time** **(** :ref:`String` id **)** const Returns the cross fade time for the transition node with name ``id``. .. _class_AnimationTreePlayer_transition_node_has_input_auto_advance: -- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const +- :ref:`bool` **transition_node_has_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx **)** const Returns ``true`` if the input at ``input_idx`` on transition node with name ``id`` is set to automatically advance to the next input upon completion. .. _class_AnimationTreePlayer_transition_node_set_current: -- void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** +- void **transition_node_set_current** **(** :ref:`String` id, :ref:`int` input_idx **)** The transition node with name ``id`` sets its current input at ``input_idx``. .. _class_AnimationTreePlayer_transition_node_set_input_auto_advance: -- void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** +- void **transition_node_set_input_auto_advance** **(** :ref:`String` id, :ref:`int` input_idx, :ref:`bool` enable **)** The transition node with name ``id`` advances to its next input automatically when the input at ``input_idx`` completes. .. _class_AnimationTreePlayer_transition_node_set_input_count: -- void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** +- void **transition_node_set_input_count** **(** :ref:`String` id, :ref:`int` count **)** Resizes the number of inputs available for the transition node with name ``id``. .. _class_AnimationTreePlayer_transition_node_set_xfade_time: -- void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +- void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** The transition node with name ``id`` sets its cross fade time to ``time_sec``. diff --git a/classes/class_area.rst b/classes/class_area.rst index 3302c840d..a905de094 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -7,8 +7,7 @@ Area ==== -**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description General purpose area node for detection and 3D physics influence. -Member Functions ----------------- +Methods +------- +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,55 +41,74 @@ Signals .. _class_Area_area_entered: -- **area_entered** **(** :ref:`Object` area **)** +- **area_entered** **(** :ref:`Area` area **)** Emitted when another area enters. .. _class_Area_area_exited: -- **area_exited** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Area` area **)** Emitted when another area exits. .. _class_Area_area_shape_entered: -- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which areas overlapped. .. _class_Area_area_shape_exited: -- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which areas were overlapping. .. _class_Area_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody` object enters. +Emitted when a :ref:`PhysicsBody` object enters. .. _class_Area_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Node` body **)** -Emitted when a :ref:`PhysicsBody` object exits. +Emitted when a :ref:`PhysicsBody` object exits. .. _class_Area_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody` object enters, reporting which shapes overlapped. +Emitted when a :ref:`PhysicsBody` object enters, reporting which shapes overlapped. .. _class_Area_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody` object exits, reporting which shapes were overlapping. +Emitted when a :ref:`PhysicsBody` object exits, reporting which shapes were overlapping. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Area_SpaceOverride: + +enum **SpaceOverride** + +- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. +- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order). +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order), ignoring any lower priority areas. +- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. +- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in ``priority`` order), but keeps calculating the rest of the areas. + + +Description +----------- + +3D area that detects :ref:`CollisionObject` nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping). + +Property Descriptions +--------------------- .. _class_Area_angular_damp: @@ -98,7 +116,7 @@ Member Variables .. _class_Area_audio_bus_name: -- :ref:`String` **audio_bus_name** - The name of the area's audio bus. +- :ref:`String` **audio_bus_name** - The name of the area's audio bus. .. _class_Area_audio_bus_override: @@ -126,7 +144,7 @@ Member Variables .. _class_Area_gravity_vec: -- :ref:`Vector3` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. +- :ref:`Vector3` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. .. _class_Area_linear_damp: @@ -154,7 +172,7 @@ Member Variables .. _class_Area_reverb_bus_name: -- :ref:`String` **reverb_bus_name** - The reverb bus name to use for this area's associated audio. +- :ref:`String` **reverb_bus_name** - The reverb bus name to use for this area's associated audio. .. _class_Area_reverb_bus_uniformity: @@ -162,30 +180,11 @@ Member Variables .. _class_Area_space_override: -- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. +- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. -Enums ------ - - .. _enum_Area_SpaceOverride: - -enum **SpaceOverride** - -- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. -- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order). -- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order), ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in ``priority`` order), but keeps calculating the rest of the areas. - - -Description ------------ - -3D area that detects :ref:`CollisionObject` nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping). - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Area_get_collision_layer_bit: @@ -201,25 +200,25 @@ Returns an individual bit on the collision mask. .. _class_Area_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting ``Area``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. .. _class_Area_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** const -Returns a list of intersecting :ref:`PhysicsBody`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting :ref:`PhysicsBody`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. .. _class_Area_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true`` the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true`` the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 0a5a7728b..a139f16f3 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -7,8 +7,7 @@ Area2D ====== -**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description 2D area for detection and 2D physics influence. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Node` area **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Node` body **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,55 +41,74 @@ Signals .. _class_Area2D_area_entered: -- **area_entered** **(** :ref:`Object` area **)** +- **area_entered** **(** :ref:`Area2D` area **)** Emitted when another area enters. .. _class_Area2D_area_exited: -- **area_exited** **(** :ref:`Object` area **)** +- **area_exited** **(** :ref:`Area2D` area **)** Emitted when another area exits. .. _class_Area2D_area_shape_entered: -- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_entered** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area enters, reporting which shapes overlapped. .. _class_Area2D_area_shape_exited: -- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +- **area_shape_exited** **(** :ref:`int` area_id, :ref:`Area2D` area, :ref:`int` area_shape, :ref:`int` self_shape **)** Emitted when another area exits, reporting which shapes were overlapping. .. _class_Area2D_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`PhysicsBody2D` body **)** -Emitted when a :ref:`PhysicsBody2D` object enters. +Emitted when a :ref:`PhysicsBody2D` object enters. .. _class_Area2D_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`PhysicsBody2D` body **)** -Emitted when a :ref:`PhysicsBody2D` object exits. +Emitted when a :ref:`PhysicsBody2D` object exits. .. _class_Area2D_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. +Emitted when a :ref:`PhysicsBody2D` object enters, reporting which shapes overlapped. .. _class_Area2D_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** -Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. +Emitted when a :ref:`PhysicsBody2D` object exits, reporting which shapes were overlapping. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Area2D_SpaceOverride: + +enum **SpaceOverride** + +- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. +- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order). +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order), ignoring any lower priority areas. +- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. +- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in ``priority`` order), but keeps calculating the rest of the areas. + + +Description +----------- + +2D area that detects :ref:`CollisionObject2D` nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping). + +Property Descriptions +--------------------- .. _class_Area2D_angular_damp: @@ -98,7 +116,7 @@ Member Variables .. _class_Area2D_audio_bus_name: -- :ref:`String` **audio_bus_name** - The name of the area's audio bus. +- :ref:`String` **audio_bus_name** - The name of the area's audio bus. .. _class_Area2D_audio_bus_override: @@ -126,7 +144,7 @@ Member Variables .. _class_Area2D_gravity_vec: -- :ref:`Vector2` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. +- :ref:`Vector2` **gravity_vec** - The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_gravity_a_point`), this will be the point of attraction. .. _class_Area2D_linear_damp: @@ -146,30 +164,11 @@ Member Variables .. _class_Area2D_space_override: -- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. +- :ref:`SpaceOverride` **space_override** - Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE\_\* constants for values. -Enums ------ - - .. _enum_Area2D_SpaceOverride: - -enum **SpaceOverride** - -- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damping. -- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order). -- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damping values to whatever has been calculated so far (in ``priority`` order), ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. -- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damping calculated so far (in ``priority`` order), but keeps calculating the rest of the areas. - - -Description ------------ - -2D area that detects :ref:`CollisionObject2D` nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping). - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Area2D_get_collision_layer_bit: @@ -185,25 +184,25 @@ Return an individual bit on the collision mask. Describes whether this area will .. _class_Area2D_get_overlapping_areas: -- :ref:`Array` **get_overlapping_areas** **(** **)** const +- :ref:`Array` **get_overlapping_areas** **(** **)** const Returns a list of intersecting ``Area2D``\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. .. _class_Area2D_get_overlapping_bodies: -- :ref:`Array` **get_overlapping_bodies** **(** **)** const +- :ref:`Array` **get_overlapping_bodies** **(** **)** const -Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. +Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. .. _class_Area2D_overlaps_area: -- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const +- :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const If ``true`` the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area2D_overlaps_body: -- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const +- :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const If ``true`` the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. diff --git a/classes/class_array.rst b/classes/class_array.rst index 457e81ef8..fb8913fb2 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -14,78 +14,82 @@ Brief Description Generic array datatype. -Member Functions ----------------- +Methods +------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`back` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch` **(** var value, :ref:`bool` before=True **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`bsearch_custom` **(** var value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`count` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** var what, :ref:`int` from=0 **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`front` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`hash` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` position, var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`pop_back` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`pop_front` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_front` **(** var value **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` position **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shuffle` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolColorArray` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector3Array` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolVector2Array` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolStringArray` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolRealArray` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolIntArray` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`Array` **(** :ref:`PoolByteArray` from **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`back` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch` **(** :ref:`Variant` value, :ref:`bool` before=True **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`bsearch_custom` **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`count` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`empty` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find` **(** :ref:`Variant` what, :ref:`int` from=0 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_last` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`front` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`hash` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`insert` **(** :ref:`int` position, :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`max` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`min` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`pop_back` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`pop_front` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_front` **(** :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` size **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rfind` **(** :ref:`Variant` what, :ref:`int` from=-1 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shuffle` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sort_custom` **(** :ref:`Object` obj, :ref:`String` func **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -103,72 +107,72 @@ Generic array, contains several elements of any type, accessible by a numerical Arrays are always passed by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** -Construct an array from a :ref:`PoolColorArray`. +Construct an array from a :ref:`PoolColorArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** -Construct an array from a :ref:`PoolVector3Array`. +Construct an array from a :ref:`PoolVector3Array`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** -Construct an array from a :ref:`PoolVector2Array`. +Construct an array from a :ref:`PoolVector2Array`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** -Construct an array from a :ref:`PoolStringArray`. +Construct an array from a :ref:`PoolStringArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** -Construct an array from a :ref:`PoolRealArray`. +Construct an array from a :ref:`PoolRealArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** -Construct an array from a :ref:`PoolIntArray`. +Construct an array from a :ref:`PoolIntArray`. .. _class_Array_Array: -- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** +- :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** -Construct an array from a :ref:`PoolByteArray`. +Construct an array from a :ref:`PoolByteArray`. .. _class_Array_append: -- void **append** **(** var value **)** +- void **append** **(** :ref:`Variant` value **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_Array_back: -- var **back** **(** **)** +- :ref:`Variant` **back** **(** **)** Returns the last element of the array if the array is not empty (size>0). .. _class_Array_bsearch: -- :ref:`int` **bsearch** **(** var value, :ref:`bool` before=True **)** +- :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. .. _class_Array_bsearch_custom: -- :ref:`int` **bsearch_custom** **(** var value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** +- :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. @@ -180,13 +184,13 @@ Clear the array (resize to 0). .. _class_Array_count: -- :ref:`int` **count** **(** var value **)** +- :ref:`int` **count** **(** :ref:`Variant` value **)** Return the amount of times an element is in the array. .. _class_Array_duplicate: -- :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** +- :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** Returns a copy of the array. @@ -200,31 +204,31 @@ Return true if the array is empty (size==0). .. _class_Array_erase: -- void **erase** **(** var value **)** +- void **erase** **(** :ref:`Variant` value **)** Remove the first occurrence of a value from the array. .. _class_Array_find: -- :ref:`int` **find** **(** var what, :ref:`int` from=0 **)** +- :ref:`int` **find** **(** :ref:`Variant` what, :ref:`int` from=0 **)** Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. .. _class_Array_find_last: -- :ref:`int` **find_last** **(** var value **)** +- :ref:`int` **find_last** **(** :ref:`Variant` value **)** Searches the array in reverse order for a value and returns its index or -1 if not found. .. _class_Array_front: -- var **front** **(** **)** +- :ref:`Variant` **front** **(** **)** Returns the first element of the array if the array is not empty (size>0). .. _class_Array_has: -- :ref:`bool` **has** **(** var value **)** +- :ref:`bool` **has** **(** :ref:`Variant` value **)** Return true if the array contains given value. @@ -243,37 +247,49 @@ Return a hashed integer value representing the array contents. .. _class_Array_insert: -- void **insert** **(** :ref:`int` position, var value **)** +- void **insert** **(** :ref:`int` position, :ref:`Variant` value **)** -Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). +Insert a new element at a given position in the array. The position must be valid, or at the end of the array (``pos == size()``). .. _class_Array_invert: - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array. +Reverse the order of the elements in the array. + +.. _class_Array_max: + +- :ref:`Variant` **max** **(** **)** + +Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. + +.. _class_Array_min: + +- :ref:`Variant` **min** **(** **)** + +Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, ``null`` is returned. .. _class_Array_pop_back: -- var **pop_back** **(** **)** +- :ref:`Variant` **pop_back** **(** **)** Remove the last element of the array. .. _class_Array_pop_front: -- var **pop_front** **(** **)** +- :ref:`Variant` **pop_front** **(** **)** Remove the first element of the array. .. _class_Array_push_back: -- void **push_back** **(** var value **)** +- void **push_back** **(** :ref:`Variant` value **)** Append an element at the end of the array. .. _class_Array_push_front: -- void **push_front** **(** var value **)** +- void **push_front** **(** :ref:`Variant` value **)** Add an element at the beginning of the array. @@ -291,7 +307,7 @@ Resize the array to contain a different number of elements. If the array size is .. _class_Array_rfind: -- :ref:`int` **rfind** **(** var what, :ref:`int` from=-1 **)** +- :ref:`int` **rfind** **(** :ref:`Variant` what, :ref:`int` from=-1 **)** Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -315,7 +331,7 @@ Sort the array using natural order. .. _class_Array_sort_custom: -- void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** +- void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 4bf705a7f..5130d8a0e 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -7,8 +7,7 @@ ArrayMesh ========= -**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | +| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_geometry` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,61 +29,35 @@ Member Functions +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | +| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform` transform, :ref:`float` texel_size **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`regen_normalmaps` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | +| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | +| void | :ref:`surface_update_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ArrayMesh_blend_shape_mode: - -- :ref:`BlendShapeMode` **blend_shape_mode** - - .. _class_ArrayMesh_custom_aabb: - -- :ref:`AABB` **custom_aabb** - An overriding bounding box for this mesh. - - -Numeric Constants ------------------ - -- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. -- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). - -Enums ------ +Enumerations +------------ .. _enum_ArrayMesh_ArrayFormat: @@ -104,36 +77,54 @@ enum **ArrayFormat** enum **ArrayType** -- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). -- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3` normals). +- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). +- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3` normals). - **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. -- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color` colors). -- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). -- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). +- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color` colors). +- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). +- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). - **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats. - **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats. -- **ARRAY_INDEX** = **8** --- :ref:`Array` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. +- **ARRAY_INDEX** = **8** --- :ref:`Array` of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the \*i\*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices. For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line. - **ARRAY_MAX** = **9** -Member Function Description ---------------------------- +Constants +--------- + +- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. +- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). + +Property Descriptions +--------------------- + + .. _class_ArrayMesh_blend_shape_mode: + +- :ref:`BlendShapeMode` **blend_shape_mode** + + .. _class_ArrayMesh_custom_aabb: + +- :ref:`AABB` **custom_aabb** - An overriding bounding box for this mesh. + + +Method Descriptions +------------------- .. _class_ArrayMesh_add_blend_shape: -- void **add_blend_shape** **(** :ref:`String` name **)** +- void **add_blend_shape** **(** :ref:`String` name **)** .. _class_ArrayMesh_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** +- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_flags=97280 **)** Creates a new surface. -Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`get_surface_count` will become the surf_idx for this new surface. +Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See :ref:`Mesh` for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). :ref:`get_surface_count` will become the surf_idx for this new surface. -The ``arrays`` argument is an array of arrays. See :ref:`ArrayType` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used. +The ``arrays`` argument is an array of arrays. See :ref:`ArrayType` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for ``ARRAY_INDEX`` if it is used. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices. @@ -159,19 +150,13 @@ Returns the number of blend shapes that the ``ArrayMesh`` holds. .. _class_ArrayMesh_get_blend_shape_name: -- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const +- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const Returns the name of the blend shape at this index. -.. _class_ArrayMesh_get_surface_count: - -- :ref:`int` **get_surface_count** **(** **)** const - -Return the amount of surfaces that the ``ArrayMesh`` holds. - .. _class_ArrayMesh_lightmap_unwrap: -- :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` transform, :ref:`float` texel_size **)** +- :ref:`Error` **lightmap_unwrap** **(** :ref:`Transform` transform, :ref:`float` texel_size **)** Will perform a UV unwrap on the ``ArrayMesh`` to prepare the mesh for lightmapping. @@ -183,7 +168,7 @@ Will regenerate normal maps for the ``ArrayMesh``. .. _class_ArrayMesh_surface_find_by_name: -- :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **surface_find_by_name** **(** :ref:`String` name **)** const Return the index of the first surface with this name held within this ``ArrayMesh``. If none are found -1 is returned. @@ -199,39 +184,21 @@ Return the length in indices of the index array in the requested surface (see :r Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_get_arrays: - -- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const - -Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`add_surface_from_arrays`). - -.. _class_ArrayMesh_surface_get_blend_shape_arrays: - -- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const - -Returns the blend shape arrays for the requested surface. - .. _class_ArrayMesh_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const Return the format mask of the requested surface (see :ref:`add_surface_from_arrays`). -.. _class_ArrayMesh_surface_get_material: - -- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const - -Return a :ref:`Material` in a given surface. Surface is rendered using this material. - .. _class_ArrayMesh_surface_get_name: -- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const +- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const Get the name assigned to this surface. .. _class_ArrayMesh_surface_get_primitive_type: -- :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const +- :ref:`PrimitiveType` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const Return the primitive type of the requested surface (see :ref:`add_surface_from_arrays`). @@ -243,18 +210,18 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl .. _class_ArrayMesh_surface_set_material: -- void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** +- void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** -Set a :ref:`Material` for a given surface. Surface will be rendered using this material. +Set a :ref:`Material` for a given surface. Surface will be rendered using this material. .. _class_ArrayMesh_surface_set_name: -- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** +- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a name for a given surface. .. _class_ArrayMesh_surface_update_region: -- void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** +- void **surface_update_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PoolByteArray` data **)** diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index 5effc344f..925b9d4eb 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -7,8 +7,7 @@ ARVRAnchor ========== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,19 @@ Brief Description Anchor point in AR Space. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | +| :ref:`String` | :ref:`get_anchor_name` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_active` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_plane` **(** **)** const | +| :ref:`Plane` | :ref:`get_plane` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_size` **(** **)** const | +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ARVRAnchor_anchor_id: - -- :ref:`int` **anchor_id** - The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of ``1``, the second an id of ``2``, etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them. - - Description ----------- @@ -46,12 +37,20 @@ This node is mapped to one of the anchors through its unique id. When you receiv Keep in mind that as long as plane detection is enable the size, placing and orientation of an anchor will be updates as the detection logic learns more about the real world out there especially if only part of the surface is in view. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ARVRAnchor_anchor_id: + +- :ref:`int` **anchor_id** - The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of ``1``, the second an id of ``2``, etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them. + + +Method Descriptions +------------------- .. _class_ARVRAnchor_get_anchor_name: -- :ref:`String` **get_anchor_name** **(** **)** const +- :ref:`String` **get_anchor_name** **(** **)** const Returns the name given to this anchor. @@ -63,13 +62,13 @@ Returns true if the anchor is being tracked and false if no anchor with this id .. _class_ARVRAnchor_get_plane: -- :ref:`Plane` **get_plane** **(** **)** const +- :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor, handy for intersection testing .. _class_ARVRAnchor_get_size: -- :ref:`Vector3` **get_size** **(** **)** const +- :ref:`Vector3` **get_size** **(** **)** const Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index 728b18314..eaa4cc1f8 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -7,8 +7,7 @@ ARVRCamera ========== -**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 6b1798458..2d62dbad5 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -7,8 +7,7 @@ ARVRController ============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description A spatial node representing a spatially tracked controller. -Member Functions ----------------- +Methods +------- +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_controller_name` **(** **)** const | +| :ref:`String` | :ref:`get_controller_name` **(** **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | +| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_active` **(** **)** const | +-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ @@ -49,24 +48,6 @@ Emitted when a button on this controller is pressed. Emitted when a button on this controller is released. -Member Variables ----------------- - - .. _class_ARVRController_controller_id: - -- :ref:`int` **controller_id** - The controller's id. - -A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller. - -For any other controller that the :ref:`ARVRServer` detects we continue with controller id 3. - -When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. - - .. _class_ARVRController_rumble: - -- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble` accordingly. - - Description ----------- @@ -76,20 +57,38 @@ Controllers are linked by their id. You can create controller nodes before the c The position of the controller node is automatically updated by the ARVR Server. This makes this node ideal to add child nodes to visualise the controller. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ARVRController_controller_id: + +- :ref:`int` **controller_id** - The controller's id. + +A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller. + +For any other controller that the :ref:`ARVRServer` detects we continue with controller id 3. + +When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. + + .. _class_ARVRController_rumble: + +- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. If changed, updates :ref:`ARVRPositionalTracker.rumble` accordingly. + + +Method Descriptions +------------------- .. _class_ARVRController_get_controller_name: -- :ref:`String` **get_controller_name** **(** **)** const +- :ref:`String` **get_controller_name** **(** **)** const If active, returns the name of the associated controller if provided by the AR/VR SDK used. .. _class_ARVRController_get_hand: -- :ref:`TrackerHand` **get_hand** **(** **)** const +- :ref:`TrackerHand` **get_hand** **(** **)** const -Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker`. +Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker`. .. _class_ARVRController_get_is_active: diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 74e1fbbfc..4073e885d 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -7,10 +7,8 @@ ARVRInterface ============= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`ARVRInterfaceGDNative`, :ref:`MobileVRInterface` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`ARVRInterfaceGDNative`, :ref:`MobileVRInterface` **Category:** Core Brief Description @@ -18,17 +16,17 @@ Brief Description Base class for ARVR interface implementation. -Member Functions ----------------- +Methods +------- +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_capabilities` **(** **)** const | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`String` | :ref:`get_name` **(** **)** const | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | +| :ref:`Vector2` | :ref:`get_render_targetsize` **(** **)** | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`Tracking_status` | :ref:`get_tracking_status` **(** **)** const | +| :ref:`Tracking_status` | :ref:`get_tracking_status` **(** **)** const | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`initialize` **(** **)** | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ @@ -37,24 +35,8 @@ Member Functions | void | :ref:`uninitialize` **(** **)** | +-------------------------------------------------------------+---------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ARVRInterface_ar_is_anchor_detection_enabled: - -- :ref:`bool` **ar_is_anchor_detection_enabled** - On an AR interface, is our anchor detection enabled? - - .. _class_ARVRInterface_interface_is_initialized: - -- :ref:`bool` **interface_is_initialized** - Has this interface been initialized? - - .. _class_ARVRInterface_interface_is_primary: - -- :ref:`bool` **interface_is_primary** - Is this our primary interface? - - -Enums ------ +Enumerations +------------ .. _enum_ARVRInterface_Eyes: @@ -92,8 +74,24 @@ This class needs to be implemented to make an AR or VR platform available to God Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through ARVRServer. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ARVRInterface_ar_is_anchor_detection_enabled: + +- :ref:`bool` **ar_is_anchor_detection_enabled** - On an AR interface, is our anchor detection enabled? + + .. _class_ARVRInterface_interface_is_initialized: + +- :ref:`bool` **interface_is_initialized** - Has this interface been initialized? + + .. _class_ARVRInterface_interface_is_primary: + +- :ref:`bool` **interface_is_primary** - Is this our primary interface? + + +Method Descriptions +------------------- .. _class_ARVRInterface_get_capabilities: @@ -103,19 +101,19 @@ Returns a combination of flags providing information about the capabilities of t .. _class_ARVRInterface_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). .. _class_ARVRInterface_get_render_targetsize: -- :ref:`Vector2` **get_render_targetsize** **(** **)** +- :ref:`Vector2` **get_render_targetsize** **(** **)** Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. .. _class_ARVRInterface_get_tracking_status: -- :ref:`Tracking_status` **get_tracking_status** **(** **)** const +- :ref:`Tracking_status` **get_tracking_status** **(** **)** const If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. diff --git a/classes/class_arvrinterfacegdnative.rst b/classes/class_arvrinterfacegdnative.rst index fab87f4b2..3c1944e6c 100644 --- a/classes/class_arvrinterfacegdnative.rst +++ b/classes/class_arvrinterfacegdnative.rst @@ -7,8 +7,7 @@ ARVRInterfaceGDNative ===================== -**Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index 36ce86cff..d7b46175a 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -7,8 +7,7 @@ ARVROrigin ========== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,6 @@ Brief Description Our origin point in AR/VR. -Member Variables ----------------- - - .. _class_ARVROrigin_world_scale: - -- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. - -Note that this method is a passthrough to the :ref:`ARVRServer` itself. - - Description ----------- @@ -37,3 +26,13 @@ It is the position of this node that you update when you're character needs to m So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc. +Property Descriptions +--------------------- + + .. _class_ARVROrigin_world_scale: + +- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. + +Note that this method is a passthrough to the :ref:`ARVRServer` itself. + + diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 30e6853eb..8e76db00f 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -7,8 +7,7 @@ ARVRPositionalTracker ===================== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,39 +15,31 @@ Brief Description A tracked object -Member Functions ----------------- +Methods +------- +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | +| :ref:`TrackerHand` | :ref:`get_hand` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joy_id` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`String` | :ref:`get_name` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | +| :ref:`Basis` | :ref:`get_orientation` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_position` **(** **)** const | +| :ref:`Vector3` | :ref:`get_position` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_orientation` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tracks_position` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | +| :ref:`Transform` | :ref:`get_transform` **(** :ref:`bool` adjust_by_reference_frame **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TrackerType` | :ref:`get_type` **(** **)** const | +| :ref:`TrackerType` | :ref:`get_type` **(** **)** const | +-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ARVRPositionalTracker_rumble: - -- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. - - -Enums ------ +Enumerations +------------ .. _enum_ARVRPositionalTracker_TrackerHand: @@ -68,12 +59,20 @@ As controllers are turned on and the AR/VR interface detects them instances of t The ARVRController and ARVRAnchor both consume objects of this type and should be the objects you use in game. The positional trackers are just the under the hood objects that make this all work and are mostly exposed so GDNative based interfaces can interact with them. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ARVRPositionalTracker_rumble: + +- :ref:`float` **rumble** - The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with precision ``.01``. + + +Method Descriptions +------------------- .. _class_ARVRPositionalTracker_get_hand: -- :ref:`TrackerHand` **get_hand** **(** **)** const +- :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this tracker, if known. See TRACKER\_\* constants. @@ -85,19 +84,19 @@ If this is a controller that is being tracked the controller will also be repres .. _class_ARVRPositionalTracker_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Returns the controller or anchor point's name if available. .. _class_ARVRPositionalTracker_get_orientation: -- :ref:`Basis` **get_orientation** **(** **)** const +- :ref:`Basis` **get_orientation** **(** **)** const Returns the controller's orientation matrix. .. _class_ARVRPositionalTracker_get_position: -- :ref:`Vector3` **get_position** **(** **)** const +- :ref:`Vector3` **get_position** **(** **)** const Returns the world-space controller position. @@ -115,13 +114,13 @@ Returns ``true`` if this device tracks position. .. _class_ARVRPositionalTracker_get_transform: -- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const +- :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const Returns the transform combining this device's orientation and position. .. _class_ARVRPositionalTracker_get_type: -- :ref:`TrackerType` **get_type** **(** **)** const +- :ref:`TrackerType` **get_type** **(** **)** const Returns the tracker's type. diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 839398821..c5e4bcd50 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -7,8 +7,7 @@ ARVRServer ========== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description This is our AR/VR Server. -Member Functions ----------------- +Methods +------- +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | +| void | :ref:`center_on_hmd` **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | +| :ref:`ARVRInterface` | :ref:`find_interface` **(** :ref:`String` name **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_hmd_transform` **(** **)** | +| :ref:`Transform` | :ref:`get_hmd_transform` **(** **)** | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | +| :ref:`ARVRInterface` | :ref:`get_interface` **(** :ref:`int` idx **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_interface_count` **(** **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | +| :ref:`Array` | :ref:`get_interfaces` **(** **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_commit_usec` **(** **)** | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,9 +37,9 @@ Member Functions +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_process_usec` **(** **)** | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | +| :ref:`Transform` | :ref:`get_reference_frame` **(** **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | +| :ref:`ARVRPositionalTracker` | :ref:`get_tracker` **(** :ref:`int` idx **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tracker_count` **(** **)** const | +------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,43 +49,31 @@ Signals .. _class_ARVRServer_interface_added: -- **interface_added** **(** :ref:`String` interface_name **)** +- **interface_added** **(** :ref:`String` interface_name **)** Signal send when a new interface has been added. .. _class_ARVRServer_interface_removed: -- **interface_removed** **(** :ref:`String` interface_name **)** +- **interface_removed** **(** :ref:`String` interface_name **)** Signal send when an interface is removed. .. _class_ARVRServer_tracker_added: -- **tracker_added** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_added** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker. .. _class_ARVRServer_tracker_removed: -- **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** +- **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). -Member Variables ----------------- - - .. _class_ARVRServer_primary_interface: - -- :ref:`ARVRInterface` **primary_interface** - - .. _class_ARVRServer_world_scale: - -- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. - - -Enums ------ +Enumerations +------------ .. _enum_ARVRServer_RotationMode: @@ -113,12 +100,24 @@ Description The AR/VR Server is the heart of our AR/VR solution and handles all the processing. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ARVRServer_primary_interface: + +- :ref:`ARVRInterface` **primary_interface** + + .. _class_ARVRServer_world_scale: + +- :ref:`float` **world_scale** - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world. + + +Method Descriptions +------------------- .. _class_ARVRServer_center_on_hmd: -- void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** +- void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently. @@ -134,19 +133,19 @@ You should call this method after a few seconds have passed, when the user reque .. _class_ARVRServer_find_interface: -- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const +- :ref:`ARVRInterface` **find_interface** **(** :ref:`String` name **)** const Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it. .. _class_ARVRServer_get_hmd_transform: -- :ref:`Transform` **get_hmd_transform** **(** **)** +- :ref:`Transform` **get_hmd_transform** **(** **)** Returns the primary interface's transformation. .. _class_ARVRServer_get_interface: -- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const +- :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const Get the interface registered at a given index in our list of interfaces. @@ -158,7 +157,7 @@ Get the number of interfaces currently registered with the AR/VR server. If you' .. _class_ARVRServer_get_interfaces: -- :ref:`Array` **get_interfaces** **(** **)** const +- :ref:`Array` **get_interfaces** **(** **)** const Returns a list of available interfaces with both id and name of the interface. @@ -176,13 +175,13 @@ Returns a list of available interfaces with both id and name of the interface. .. _class_ARVRServer_get_reference_frame: -- :ref:`Transform` **get_reference_frame** **(** **)** const +- :ref:`Transform` **get_reference_frame** **(** **)** const Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. .. _class_ARVRServer_get_tracker: -- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const +- :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const Get the positional tracker at the given ID. diff --git a/classes/class_astar.rst b/classes/class_astar.rst index c763bdb34..3d5ec2456 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -7,8 +7,7 @@ AStar ===== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description AStar class representation that uses vectors as edges. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,27 +35,27 @@ Member Functions +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_available_point_id` **(** **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position **)** const | +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | +| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | +| :ref:`PoolIntArray` | :ref:`get_point_connections` **(** :ref:`int` id **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_points` **(** **)** | +| :ref:`Array` | :ref:`get_points` **(** **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` id **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | +| void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,8 +67,8 @@ A\* (A star) is a computer algorithm that is widely used in pathfinding and grap You must add points manually with :ref:`AStar.add_point` and create segments manually with :ref:`AStar.connect_points`. So you can test if there is a path between two points with the :ref:`AStar.are_points_connected` function, get the list of existing ids in the found path with :ref:`AStar.get_id_path`, or the points list with :ref:`AStar.get_point_path`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AStar__compute_cost: @@ -85,7 +84,7 @@ Called when estimating the cost between a point and the path's ending point. .. _class_AStar_add_point: -- void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** Adds a new point at the given position with the given identifier. The algorithm prefers points with lower ``weight_scale`` to form a path. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 1 or larger. @@ -139,13 +138,13 @@ Returns the next available point id with no point associated to it. .. _class_AStar_get_closest_point: -- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const +- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool. .. _class_AStar_get_closest_position_in_segment: -- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const +- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const Returns the closest position to ``to_position`` that resides inside a segment between two connected points. @@ -164,7 +163,7 @@ The result is in the segment that goes from ``y=0`` to ``y=5``. It's the closest .. _class_AStar_get_id_path: -- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. @@ -189,7 +188,7 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` .. _class_AStar_get_point_connections: -- :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** +- :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** Returns an array with the ids of the points that form the connect with the given point. @@ -209,13 +208,13 @@ Returns an array with the ids of the points that form the connect with the given .. _class_AStar_get_point_path: -- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +- :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. .. _class_AStar_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const Returns the position of the point associated with the given id. @@ -227,7 +226,7 @@ Returns the weight scale of the point associated with the given id. .. _class_AStar_get_points: -- :ref:`Array` **get_points** **(** **)** +- :ref:`Array` **get_points** **(** **)** Returns an array of all points. @@ -245,7 +244,7 @@ Removes the point associated with the given id from the points pool. .. _class_AStar_set_point_position: -- void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** +- void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** Sets the position for the point with the given id. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index ed5c6d319..596e5974b 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -7,8 +7,7 @@ AtlasTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,19 @@ Brief Description Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. -Member Variables ----------------- +Description +----------- + +:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, + +and a region that defines the actual area of the AtlasTexture. + +Property Descriptions +--------------------- .. _class_AtlasTexture_atlas: -- :ref:`Texture` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture` subtype. +- :ref:`Texture` **atlas** - The texture that contains the atlas. Can be any :ref:`Texture` subtype. .. _class_AtlasTexture_filter_clip: @@ -29,17 +35,10 @@ Member Variables .. _class_AtlasTexture_margin: -- :ref:`Rect2` **margin** - The margin around the region. The :ref:`Rect2`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. +- :ref:`Rect2` **margin** - The margin around the region. The :ref:`Rect2`'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. .. _class_AtlasTexture_region: -- :ref:`Rect2` **region** - The AtlasTexture's used region. +- :ref:`Rect2` **region** - The AtlasTexture's used region. -Description ------------ - -:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, - -and a region that defines the actual area of the AtlasTexture. - diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 2377e099f..c9ec247ce 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -7,8 +7,7 @@ AudioBusLayout ============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Stores information about the audiobusses. Description ----------- -Stores position, muting, solo, bypass, effects, effect position, volume, and the connections between busses. See :ref:`AudioServer` for usage. +Stores position, muting, solo, bypass, effects, effect position, volume, and the connections between busses. See :ref:`AudioServer` for usage. diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 80801c57d..830085e21 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -7,10 +7,8 @@ AudioEffect =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` **Category:** Core Brief Description diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index 0dc2e1def..7fe22c704 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -7,8 +7,7 @@ AudioEffectAmplify ================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,16 +17,16 @@ Adds a Amplify audio effect to an Audio bus. Increases or decreases the volume of the selected audio bus. -Member Variables ----------------- +Description +----------- + +Increases or decreases the volume being routed through the audio bus. + +Property Descriptions +--------------------- .. _class_AudioEffectAmplify_volume_db: - :ref:`float` **volume_db** - Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: ``0``. -Description ------------ - -Increases or decreases the volume being routed through the audio bus. - diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index be71891a6..9ff8d45d7 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -7,8 +7,7 @@ AudioEffectBandLimitFilter ========================== -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index b775a4f3e..565cb0d8d 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -7,8 +7,7 @@ AudioEffectBandPassFilter ========================= -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 03d4d8684..37abe6b0e 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -7,8 +7,7 @@ AudioEffectChorus ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Adds a chorus audio effect. -Member Variables ----------------- +Description +----------- + +Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. + +Property Descriptions +--------------------- .. _class_AudioEffectChorus_dry: @@ -128,8 +132,3 @@ Member Variables - :ref:`float` **wet** - The effect's processed signal. -Description ------------ - -Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. - diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 81f5987b9..857dd505b 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -7,8 +7,7 @@ AudioEffectCompressor ===================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,8 +17,23 @@ Adds a Compressor audio effect to an Audio bus. Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume. -Member Variables ----------------- +Description +----------- + +Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). + +Compressor has many uses in the mix: + +- In the Master bus to compress the whole output (Although a :ref:`AudioEffectLimiter` is probably better) + +- In voice channels to ensure they sound as balanced as possible. + +- Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard. + +- Accentuates transients by using a wider attack, making effects sound more punchy. + +Property Descriptions +--------------------- .. _class_AudioEffectCompressor_attack_us: @@ -43,25 +57,10 @@ Member Variables .. _class_AudioEffectCompressor_sidechain: -- :ref:`String` **sidechain** - Reduce the sound level using another audio bus for threshold detection. +- :ref:`String` **sidechain** - Reduce the sound level using another audio bus for threshold detection. .. _class_AudioEffectCompressor_threshold: - :ref:`float` **threshold** - The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: ``0``. -Description ------------ - -Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). - -Compressor has many uses in the mix: - -- In the Master bus to compress the whole output (Although a :ref:`AudioEffectLimiter` is probably better) - -- In voice channels to ensure they sound as balanced as possible. - -- Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard. - -- Accentuates transients by using a wider attack, making effects sound more punchy. - diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 696a19e72..b41c66fd2 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -7,8 +7,7 @@ AudioEffectDelay ================ -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,8 +17,13 @@ Adds a Delay audio effect to an Audio bus. Plays input signal back after a perio Two tap delay and feedback options. -Member Variables ----------------- +Description +----------- + +Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds. + +Property Descriptions +--------------------- .. _class_AudioEffectDelay_dry: @@ -74,8 +78,3 @@ Member Variables - :ref:`float` **tap2/pan** - Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``-0.4``. -Description ------------ - -Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds. - diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index e94e691a6..a104a1545 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -7,8 +7,7 @@ AudioEffectDistortion ===================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,32 +17,8 @@ Adds a Distortion audio effect to an Audio bus. Modify the sound to make it dirty. -Member Variables ----------------- - - .. _class_AudioEffectDistortion_drive: - -- :ref:`float` **drive** - Distortion power. Value can range from 0 to 1. Default value: ``0``. - - .. _class_AudioEffectDistortion_keep_hf_hz: - -- :ref:`float` **keep_hf_hz** - High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. - - .. _class_AudioEffectDistortion_mode: - -- :ref:`Mode` **mode** - Distortion type. Default value: ``MODE_CLIP``. - - .. _class_AudioEffectDistortion_post_gain: - -- :ref:`float` **post_gain** - Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. - - .. _class_AudioEffectDistortion_pre_gain: - -- :ref:`float` **pre_gain** - Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``. - - -Enums ------ +Enumerations +------------ .. _enum_AudioEffectDistortion_Mode: @@ -63,3 +38,27 @@ Modify the sound and make it dirty. Different types are available : clip, tan, l By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. +Property Descriptions +--------------------- + + .. _class_AudioEffectDistortion_drive: + +- :ref:`float` **drive** - Distortion power. Value can range from 0 to 1. Default value: ``0``. + + .. _class_AudioEffectDistortion_keep_hf_hz: + +- :ref:`float` **keep_hf_hz** - High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: ``16000``. + + .. _class_AudioEffectDistortion_mode: + +- :ref:`Mode` **mode** - Distortion type. Default value: ``MODE_CLIP``. + + .. _class_AudioEffectDistortion_post_gain: + +- :ref:`float` **post_gain** - Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. + + .. _class_AudioEffectDistortion_pre_gain: + +- :ref:`float` **pre_gain** - Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: ``0``. + + diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 367702af5..049a28f5d 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -7,10 +7,8 @@ AudioEffectEQ ============= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`, :ref:`AudioEffectEQ10` **Category:** Core Brief Description @@ -18,10 +16,10 @@ Brief Description Base class for audio equalizers. Gives you control over frequencies. -Use it to create a custom equalizer if :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10` or :ref:`AudioEffectEQ21` don't fit your needs. +Use it to create a custom equalizer if :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10` or :ref:`AudioEffectEQ21` don't fit your needs. -Member Functions ----------------- +Methods +------- +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_band_count` **(** **)** const | @@ -36,8 +34,8 @@ Description AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged). -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AudioEffectEQ_get_band_count: diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index 786ff5eaf..bb5480f42 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -7,8 +7,7 @@ AudioEffectEQ10 =============== -**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -43,5 +42,5 @@ Band 9 : 8000 Hz Band 10 : 16000 Hz -See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`. +See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ21`. diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index 91acb5558..81ef1b6a3 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -7,8 +7,7 @@ AudioEffectEQ21 =============== -**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -65,5 +64,5 @@ Band 20 : 16000 Hz Band 21 : 22000 Hz -See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10`. +See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ6`, :ref:`AudioEffectEQ10`. diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 54cf19d9b..7807f0040 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -7,8 +7,7 @@ AudioEffectEQ6 ============== -**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectEQ` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -35,5 +34,5 @@ Band 5 : 3200 Hz Band 6 : 10000 Hz -See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ10`, :ref:`AudioEffectEQ21`. +See also :ref:`AudioEffectEQ`, :ref:`AudioEffectEQ10`, :ref:`AudioEffectEQ21`. diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 87b5288ff..4a83e2b4b 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -7,10 +7,8 @@ AudioEffectFilter ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectNotchFilter`, :ref:`AudioEffectLowPassFilter` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AudioEffectHighPassFilter`, :ref:`AudioEffectBandLimitFilter`, :ref:`AudioEffectLowShelfFilter`, :ref:`AudioEffectHighShelfFilter`, :ref:`AudioEffectBandPassFilter`, :ref:`AudioEffectNotchFilter`, :ref:`AudioEffectLowPassFilter` **Category:** Core Brief Description @@ -18,28 +16,8 @@ Brief Description Adds a filter to the Audio Bus. -Member Variables ----------------- - - .. _class_AudioEffectFilter_cutoff_hz: - -- :ref:`float` **cutoff_hz** - Threshold frequency for the filter. - - .. _class_AudioEffectFilter_db: - -- :ref:`FilterDB` **db** - - .. _class_AudioEffectFilter_gain: - -- :ref:`float` **gain** - Gain amount of the frequencies after the filter. - - .. _class_AudioEffectFilter_resonance: - -- :ref:`float` **resonance** - Amount of boost in the overtones near the cutoff frequency. - - -Enums ------ +Enumerations +------------ .. _enum_AudioEffectFilter_FilterDB: @@ -56,3 +34,23 @@ Description Allows frequencies other than the :ref:`cutoff_hz` to pass. +Property Descriptions +--------------------- + + .. _class_AudioEffectFilter_cutoff_hz: + +- :ref:`float` **cutoff_hz** - Threshold frequency for the filter. + + .. _class_AudioEffectFilter_db: + +- :ref:`FilterDB` **db** + + .. _class_AudioEffectFilter_gain: + +- :ref:`float` **gain** - Gain amount of the frequencies after the filter. + + .. _class_AudioEffectFilter_resonance: + +- :ref:`float` **resonance** - Amount of boost in the overtones near the cutoff frequency. + + diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index 93f47ae39..65396c2b8 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -7,8 +7,7 @@ AudioEffectHighPassFilter ========================= -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index 413cb782c..8b2b73102 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -7,8 +7,7 @@ AudioEffectHighShelfFilter ========================== -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 29e9c149f..5e7fd4887 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -7,8 +7,7 @@ AudioEffectLimiter ================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,15 @@ Brief Description Adds a soft clip Limiter audio effect to an Audio bus. -Member Variables ----------------- +Description +----------- + +A limiter is similar to a compressor, but it’s less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping. + +Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded. + +Property Descriptions +--------------------- .. _class_AudioEffectLimiter_ceiling_db: @@ -36,10 +42,3 @@ Member Variables - :ref:`float` **threshold_db** - Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``. -Description ------------ - -A limiter is similar to a compressor, but it’s less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping. - -Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded. - diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index b76c7594b..b38645e18 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -7,8 +7,7 @@ AudioEffectLowPassFilter ======================== -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index e772f2b3e..3e6b41238 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -7,8 +7,7 @@ AudioEffectLowShelfFilter ========================= -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 00f3532d3..187f8786f 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -7,8 +7,7 @@ AudioEffectNotchFilter ====================== -**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffectFilter` **<** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index 62472c6ed..ef055238c 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -7,8 +7,7 @@ AudioEffectPanner ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Adds a Panner audio effect to an Audio bus. Pans sound left or right. -Member Variables ----------------- +Description +----------- + +Determines how much of an audio signal is sent to the left and right buses. + +Property Descriptions +--------------------- .. _class_AudioEffectPanner_pan: - :ref:`float` **pan** - Pan position. Value can range from -1 (fully left) to 1 (fully right). -Description ------------ - -Determines how much of an audio signal is sent to the left and right buses. - diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 6b7e3395f..a8dc16411 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -7,8 +7,7 @@ AudioEffectPhaser ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,8 +17,13 @@ Adds a Phaser audio effect to an Audio bus. Combines the original signal with a copy that is slightly out of phase with the original. -Member Variables ----------------- +Description +----------- + +Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator. + +Property Descriptions +--------------------- .. _class_AudioEffectPhaser_depth: @@ -42,8 +46,3 @@ Member Variables - :ref:`float` **rate_hz** - Adjusts the rate at which the effect sweeps up and down across the frequency range. -Description ------------ - -Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator. - diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 187e6e44d..89276e7a8 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -7,8 +7,7 @@ AudioEffectPitchShift ===================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,16 +17,16 @@ Adds a Pitch shift audio effect to an Audio bus. Raises or lowers the pitch of original sound. -Member Variables ----------------- +Description +----------- + +Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients. + +Property Descriptions +--------------------- .. _class_AudioEffectPitchShift_pitch_scale: - :ref:`float` **pitch_scale** - Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). -Description ------------ - -Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients. - diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index 6e635175a..ecfa63caf 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -7,8 +7,7 @@ AudioEffectRecord ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | +| :ref:`AudioStreamSample` | :ref:`get_recording` **(** **)** const | +----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_recording_active` **(** **)** const | +----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_recording_active` **(** :ref:`bool` record **)** | +----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AudioEffectRecord_format: -- :ref:`Format` **format** +- :ref:`Format` **format** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AudioEffectRecord_get_recording: -- :ref:`AudioStreamSample` **get_recording** **(** **)** const +- :ref:`AudioStreamSample` **get_recording** **(** **)** const .. _class_AudioEffectRecord_is_recording_active: diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index c3b2a6811..a0682c7e4 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -7,8 +7,7 @@ AudioEffectReverb ================= -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,8 +17,13 @@ Adds a Reverb audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. -Member Variables ----------------- +Description +----------- + +Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room. + +Property Descriptions +--------------------- .. _class_AudioEffectReverb_damping: @@ -54,8 +58,3 @@ Member Variables - :ref:`float` **wet** - Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: ``0.5``. -Description ------------ - -Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room. - diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 191fd9e93..79bde4583 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -7,8 +7,7 @@ AudioEffectStereoEnhance ======================== -**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_AudioEffectStereoEnhance_pan_pullout: diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index cc5976cb7..d6b1c7c68 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -7,8 +7,7 @@ AudioServer =========== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,47 +15,47 @@ Brief Description Server interface for low level audio access. -Member Functions ----------------- +Methods +------- +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capture_get_device` **(** **)** | +| :ref:`String` | :ref:`capture_get_device` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | +| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | +| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_count` **(** **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_device` **(** **)** | +| :ref:`String` | :ref:`get_device` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_device_list` **(** **)** | +| :ref:`Array` | :ref:`get_device_list` **(** **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_mix_rate` **(** **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** const | +| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -80,19 +79,19 @@ Member Functions +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`String` device **)** | +| void | :ref:`set_device` **(** :ref:`String` device **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -106,11 +105,11 @@ Signals - **bus_layout_changed** **(** **)** -Emitted when the :ref:`AudioBusLayout` changes. +Emitted when the :ref:`AudioBusLayout` changes. -Enums ------ +Enumerations +------------ .. _enum_AudioServer_SpeakerMode: @@ -131,8 +130,8 @@ Tutorials - :doc:`../tutorials/audio/audio_buses` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AudioServer_add_bus: @@ -142,27 +141,27 @@ Adds a bus at ``at_position``. .. _class_AudioServer_add_bus_effect: -- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** -Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. +Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ``at_position``. .. _class_AudioServer_capture_get_device: -- :ref:`String` **capture_get_device** **(** **)** +- :ref:`String` **capture_get_device** **(** **)** .. _class_AudioServer_capture_get_device_list: -- :ref:`Array` **capture_get_device_list** **(** **)** +- :ref:`Array` **capture_get_device_list** **(** **)** .. _class_AudioServer_capture_set_device: -- void **capture_set_device** **(** :ref:`String` name **)** +- void **capture_set_device** **(** :ref:`String` name **)** .. _class_AudioServer_generate_bus_layout: -- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const +- :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const -Generates an :ref:`AudioBusLayout` using the available busses and effects. +Generates an :ref:`AudioBusLayout` using the available busses and effects. .. _class_AudioServer_get_bus_count: @@ -172,9 +171,9 @@ Returns the number of available busses. .. _class_AudioServer_get_bus_effect: -- :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** +- :ref:`AudioEffect` **get_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** -Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. +Returns the :ref:`AudioEffect` at position ``effect_idx`` in bus ``bus_idx``. .. _class_AudioServer_get_bus_effect_count: @@ -184,13 +183,13 @@ Returns the number of effects on the bus at ``bus_idx``. .. _class_AudioServer_get_bus_index: -- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const +- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const Returns the index of the bus with the name ``bus_name``. .. _class_AudioServer_get_bus_name: -- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const Returns the name of the bus with the index ``bus_idx``. @@ -208,7 +207,7 @@ Returns the peak volume of the right speaker at bus index ``bus_idx`` and channe .. _class_AudioServer_get_bus_send: -- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const +- :ref:`String` **get_bus_send** **(** :ref:`int` bus_idx **)** const Returns the name of the bus that the bus at index ``bus_idx`` sends to. @@ -220,11 +219,11 @@ Returns the volume of the bus at index ``bus_idx`` in dB. .. _class_AudioServer_get_device: -- :ref:`String` **get_device** **(** **)** +- :ref:`String` **get_device** **(** **)** .. _class_AudioServer_get_device_list: -- :ref:`Array` **get_device_list** **(** **)** +- :ref:`Array` **get_device_list** **(** **)** .. _class_AudioServer_get_mix_rate: @@ -234,7 +233,7 @@ Returns the sample rate at the output of the audioserver. .. _class_AudioServer_get_speaker_mode: -- :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const +- :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const Returns the speaker configuration. @@ -306,9 +305,9 @@ If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` i .. _class_AudioServer_set_bus_layout: -- void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** +- void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** -Overwrites the currently used :ref:`AudioBusLayout`. +Overwrites the currently used :ref:`AudioBusLayout`. .. _class_AudioServer_set_bus_mute: @@ -318,13 +317,13 @@ If ``true`` the bus at index ``bus_idx`` is muted. .. _class_AudioServer_set_bus_name: -- void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** +- void **set_bus_name** **(** :ref:`int` bus_idx, :ref:`String` name **)** Sets the name of the bus at index ``bus_idx`` to ``name``. .. _class_AudioServer_set_bus_send: -- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** +- void **set_bus_send** **(** :ref:`int` bus_idx, :ref:`String` send **)** Connects the output of the bus at ``bus_idx`` to the bus named ``send``. @@ -342,7 +341,7 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. .. _class_AudioServer_set_device: -- void **set_device** **(** :ref:`String` device **)** +- void **set_device** **(** :ref:`String` device **)** .. _class_AudioServer_swap_bus_effects: diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 68545ca57..a26a2fbbe 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -7,10 +7,8 @@ AudioStream =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Base class for audio streams. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------+ | :ref:`float` | :ref:`get_length` **(** **)** const | @@ -35,8 +33,8 @@ Tutorials - :doc:`../tutorials/audio/audio_streams` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AudioStream_get_length: diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index 9b0c6788b..b4465391e 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -7,8 +7,7 @@ AudioStreamMicrophone ===================== -**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 8c393a53a..87f6fd676 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -7,8 +7,7 @@ AudioStreamOGGVorbis ==================== -**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,17 @@ Brief Description OGG Vorbis audio stream driver. -Member Variables ----------------- +Description +----------- + +OGG Vorbis audio stream driver. + +Property Descriptions +--------------------- .. _class_AudioStreamOGGVorbis_data: -- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. +- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. .. _class_AudioStreamOGGVorbis_loop: @@ -32,8 +36,3 @@ Member Variables - :ref:`float` **loop_offset** -Description ------------ - -OGG Vorbis audio stream driver. - diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 61809ef7a..65a05c058 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -7,8 +7,7 @@ AudioStreamPlayback =================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Meta class for playing back audio. Description ----------- -Can play, loop, pause a scroll through Audio. See :ref:`AudioStream` and :ref:`AudioStreamOGGVorbis` for usage. +Can play, loop, pause a scroll through Audio. See :ref:`AudioStream` and :ref:`AudioStreamOGGVorbis` for usage. diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 3abc61c77..1dfdec932 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -7,8 +7,7 @@ AudioStreamPlayer ================= -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Plays back audio. -Member Functions ----------------- +Methods +------- +----------------------------+---------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_position` **(** **)** | @@ -39,44 +38,8 @@ Signals Emitted when the audio stops playing. -Member Variables ----------------- - - .. _class_AudioStreamPlayer_autoplay: - -- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. - - .. _class_AudioStreamPlayer_bus: - -- :ref:`String` **bus** - Bus on which this audio is playing. - - .. _class_AudioStreamPlayer_mix_target: - -- :ref:`MixTarget` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. - - .. _class_AudioStreamPlayer_pitch_scale: - -- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. - - .. _class_AudioStreamPlayer_playing: - -- :ref:`bool` **playing** - If ``true`` audio is playing. - - .. _class_AudioStreamPlayer_stream: - -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. - - .. _class_AudioStreamPlayer_stream_paused: - -- :ref:`bool` **stream_paused** - - .. _class_AudioStreamPlayer_volume_db: - -- :ref:`float` **volume_db** - Volume of sound, in dB. - - -Enums ------ +Enumerations +------------ .. _enum_AudioStreamPlayer_MixTarget: @@ -98,14 +61,50 @@ Tutorials - :doc:`../learning/features/audio/index` - :doc:`../tutorials/audio/audio_streams` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AudioStreamPlayer_autoplay: + +- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. + + .. _class_AudioStreamPlayer_bus: + +- :ref:`String` **bus** - Bus on which this audio is playing. + + .. _class_AudioStreamPlayer_mix_target: + +- :ref:`MixTarget` **mix_target** - If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. + + .. _class_AudioStreamPlayer_pitch_scale: + +- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. + + .. _class_AudioStreamPlayer_playing: + +- :ref:`bool` **playing** - If ``true`` audio is playing. + + .. _class_AudioStreamPlayer_stream: + +- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + + .. _class_AudioStreamPlayer_stream_paused: + +- :ref:`bool` **stream_paused** + + .. _class_AudioStreamPlayer_volume_db: + +- :ref:`float` **volume_db** - Volume of sound, in dB. + + +Method Descriptions +------------------- .. _class_AudioStreamPlayer_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** -Returns the position in the :ref:`AudioStream` in seconds. +Returns the position in the :ref:`AudioStream` in seconds. .. _class_AudioStreamPlayer_play: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index c874ef3d7..86812f239 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -7,8 +7,7 @@ AudioStreamPlayer2D =================== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Plays audio in 2D. -Member Functions ----------------- +Methods +------- +----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_position` **(** **)** | @@ -39,8 +38,19 @@ Signals Emitted when the audio stops playing. -Member Variables ----------------- +Description +----------- + +Plays audio that dampens with distance from screen center. + +Tutorials +--------- + +- :doc:`../learning/features/audio/index` +- :doc:`../tutorials/audio/audio_streams` + +Property Descriptions +--------------------- .. _class_AudioStreamPlayer2D_area_mask: @@ -56,7 +66,7 @@ Member Variables .. _class_AudioStreamPlayer2D_bus: -- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`String` **bus** - Bus on which this audio is playing. .. _class_AudioStreamPlayer2D_max_distance: @@ -72,7 +82,7 @@ Member Variables .. _class_AudioStreamPlayer2D_stream: -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. +- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. .. _class_AudioStreamPlayer2D_stream_paused: @@ -83,25 +93,14 @@ Member Variables - :ref:`float` **volume_db** - Base volume without dampening. -Description ------------ - -Plays audio that dampens with distance from screen center. - -Tutorials ---------- - -- :doc:`../learning/features/audio/index` -- :doc:`../tutorials/audio/audio_streams` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_AudioStreamPlayer2D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** -Returns the position in the :ref:`AudioStream`. +Returns the position in the :ref:`AudioStream`. .. _class_AudioStreamPlayer2D_play: diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 9155ec652..efe04ac5d 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -7,8 +7,7 @@ AudioStreamPlayer3D =================== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Plays 3D sound in 3D space. -Member Functions ----------------- +Methods +------- +----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_position` **(** **)** | @@ -39,88 +38,8 @@ Signals Fires when the audio stops playing. -Member Variables ----------------- - - .. _class_AudioStreamPlayer3D_area_mask: - -- :ref:`int` **area_mask** - Areas in which this sound plays. - - .. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: - -- :ref:`float` **attenuation_filter_cutoff_hz** - Dampens audio above this frequency, in Hz. - - .. _class_AudioStreamPlayer3D_attenuation_filter_db: - -- :ref:`float` **attenuation_filter_db** - Amount how much the filter affects the loudness, in dB. - - .. _class_AudioStreamPlayer3D_attenuation_model: - -- :ref:`AttenuationModel` **attenuation_model** - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. - - .. _class_AudioStreamPlayer3D_autoplay: - -- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. - - .. _class_AudioStreamPlayer3D_bus: - -- :ref:`String` **bus** - Bus on which this audio is playing. - - .. _class_AudioStreamPlayer3D_doppler_tracking: - -- :ref:`DopplerTracking` **doppler_tracking** - Decides in which step the Doppler effect should be calculated. - - .. _class_AudioStreamPlayer3D_emission_angle_degrees: - -- :ref:`float` **emission_angle_degrees** - The angle in which the audio reaches cameras undampened. - - .. _class_AudioStreamPlayer3D_emission_angle_enabled: - -- :ref:`bool` **emission_angle_enabled** - If ``true`` the audio should be dampened according to the direction of the sound. - - .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: - -- :ref:`float` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. - - .. _class_AudioStreamPlayer3D_max_db: - -- :ref:`float` **max_db** - Sets the absolute maximum of the soundlevel, in dB. - - .. _class_AudioStreamPlayer3D_max_distance: - -- :ref:`float` **max_distance** - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. - - .. _class_AudioStreamPlayer3D_out_of_range_mode: - -- :ref:`OutOfRangeMode` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. - - .. _class_AudioStreamPlayer3D_pitch_scale: - -- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. - - .. _class_AudioStreamPlayer3D_playing: - -- :ref:`bool` **playing** - If ``true``, audio is playing. - - .. _class_AudioStreamPlayer3D_stream: - -- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. - - .. _class_AudioStreamPlayer3D_stream_paused: - -- :ref:`bool` **stream_paused** - - .. _class_AudioStreamPlayer3D_unit_db: - -- :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. - - .. _class_AudioStreamPlayer3D_unit_size: - -- :ref:`float` **unit_size** - Factor for the attenuation effect. - - -Enums ------ +Enumerations +------------ .. _enum_AudioStreamPlayer3D_DopplerTracking: @@ -157,14 +76,94 @@ Tutorials - :doc:`../learning/features/audio/index` - :doc:`../tutorials/audio/audio_streams` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AudioStreamPlayer3D_area_mask: + +- :ref:`int` **area_mask** - Areas in which this sound plays. + + .. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: + +- :ref:`float` **attenuation_filter_cutoff_hz** - Dampens audio above this frequency, in Hz. + + .. _class_AudioStreamPlayer3D_attenuation_filter_db: + +- :ref:`float` **attenuation_filter_db** - Amount how much the filter affects the loudness, in dB. + + .. _class_AudioStreamPlayer3D_attenuation_model: + +- :ref:`AttenuationModel` **attenuation_model** - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. + + .. _class_AudioStreamPlayer3D_autoplay: + +- :ref:`bool` **autoplay** - If ``true`` audio plays when added to scene tree. Default value: ``false``. + + .. _class_AudioStreamPlayer3D_bus: + +- :ref:`String` **bus** - Bus on which this audio is playing. + + .. _class_AudioStreamPlayer3D_doppler_tracking: + +- :ref:`DopplerTracking` **doppler_tracking** - Decides in which step the Doppler effect should be calculated. + + .. _class_AudioStreamPlayer3D_emission_angle_degrees: + +- :ref:`float` **emission_angle_degrees** - The angle in which the audio reaches cameras undampened. + + .. _class_AudioStreamPlayer3D_emission_angle_enabled: + +- :ref:`bool` **emission_angle_enabled** - If ``true`` the audio should be dampened according to the direction of the sound. + + .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: + +- :ref:`float` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. + + .. _class_AudioStreamPlayer3D_max_db: + +- :ref:`float` **max_db** - Sets the absolute maximum of the soundlevel, in dB. + + .. _class_AudioStreamPlayer3D_max_distance: + +- :ref:`float` **max_distance** - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. + + .. _class_AudioStreamPlayer3D_out_of_range_mode: + +- :ref:`OutOfRangeMode` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. + + .. _class_AudioStreamPlayer3D_pitch_scale: + +- :ref:`float` **pitch_scale** - Changes the pitch and the tempo of the audio. + + .. _class_AudioStreamPlayer3D_playing: + +- :ref:`bool` **playing** - If ``true``, audio is playing. + + .. _class_AudioStreamPlayer3D_stream: + +- :ref:`AudioStream` **stream** - The :ref:`AudioStream` object to be played. + + .. _class_AudioStreamPlayer3D_stream_paused: + +- :ref:`bool` **stream_paused** + + .. _class_AudioStreamPlayer3D_unit_db: + +- :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. + + .. _class_AudioStreamPlayer3D_unit_size: + +- :ref:`float` **unit_size** - Factor for the attenuation effect. + + +Method Descriptions +------------------- .. _class_AudioStreamPlayer3D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** -Returns the position in the :ref:`AudioStream`. +Returns the position in the :ref:`AudioStream`. .. _class_AudioStreamPlayer3D_play: diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 8f167b66f..41481f9c2 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -7,8 +7,7 @@ AudioStreamRandomPitch ====================== -**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description Plays audio with random pitch tweaking. -Member Variables ----------------- +Description +----------- + +Randomly varies pitch on each start. + +Property Descriptions +--------------------- .. _class_AudioStreamRandomPitch_audio_stream: -- :ref:`AudioStream` **audio_stream** - The current :ref:`AudioStream`. +- :ref:`AudioStream` **audio_stream** - The current :ref:`AudioStream`. .. _class_AudioStreamRandomPitch_random_pitch: - :ref:`float` **random_pitch** - The intensity of random pitch variation. -Description ------------ - -Randomly varies pitch on each start. - diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index ccbeba140..718dab7ba 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -7,8 +7,7 @@ AudioStreamSample ================= -**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,47 +15,15 @@ Brief Description Plays audio. -Member Functions ----------------- +Methods +------- +-------+------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_to_wav` **(** :ref:`String` path **)** | +| void | :ref:`save_to_wav` **(** :ref:`String` path **)** | +-------+------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_AudioStreamSample_data: - -- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. - - .. _class_AudioStreamSample_format: - -- :ref:`Format` **format** - Audio format. See FORMAT\_\* constants for values. - - .. _class_AudioStreamSample_loop_begin: - -- :ref:`int` **loop_begin** - Loop start in bytes. - - .. _class_AudioStreamSample_loop_end: - -- :ref:`int` **loop_end** - Loop end in bytes. - - .. _class_AudioStreamSample_loop_mode: - -- :ref:`LoopMode` **loop_mode** - Loop mode. See LOOP\_\* constants for values. - - .. _class_AudioStreamSample_mix_rate: - -- :ref:`int` **mix_rate** - The sample rate for mixing this audio. - - .. _class_AudioStreamSample_stereo: - -- :ref:`bool` **stereo** - If ``true``, audio is stereo. Default value: ``false``. - - -Enums ------ +Enumerations +------------ .. _enum_AudioStreamSample_LoopMode: @@ -80,11 +47,43 @@ Description Plays audio, can loop. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_AudioStreamSample_data: + +- :ref:`PoolByteArray` **data** - Contains the audio data in bytes. + + .. _class_AudioStreamSample_format: + +- :ref:`Format` **format** - Audio format. See FORMAT\_\* constants for values. + + .. _class_AudioStreamSample_loop_begin: + +- :ref:`int` **loop_begin** - Loop start in bytes. + + .. _class_AudioStreamSample_loop_end: + +- :ref:`int` **loop_end** - Loop end in bytes. + + .. _class_AudioStreamSample_loop_mode: + +- :ref:`LoopMode` **loop_mode** - Loop mode. See LOOP\_\* constants for values. + + .. _class_AudioStreamSample_mix_rate: + +- :ref:`int` **mix_rate** - The sample rate for mixing this audio. + + .. _class_AudioStreamSample_stereo: + +- :ref:`bool` **stereo** - If ``true``, audio is stereo. Default value: ``false``. + + +Method Descriptions +------------------- .. _class_AudioStreamSample_save_to_wav: -- void **save_to_wav** **(** :ref:`String` path **)** +- void **save_to_wav** **(** :ref:`String` path **)** diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 6905adfa1..036f6a398 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -7,8 +7,7 @@ BackBufferCopy ============== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with ``SCREEN_TEXTURE`` in the ``texture()`` function. -Member Variables ----------------- - - .. _class_BackBufferCopy_copy_mode: - -- :ref:`CopyMode` **copy_mode** - Buffer mode. See ``COPY_MODE_*`` constants. - - .. _class_BackBufferCopy_rect: - -- :ref:`Rect2` **rect** - The area covered by the BackBufferCopy. Only used if ``copy_mode`` is ``COPY_MODE_RECT``. - - -Enums ------ +Enumerations +------------ .. _enum_BackBufferCopy_CopyMode: @@ -45,3 +32,15 @@ Description Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use ``SCREEN_TEXTURE`` in the ``texture()`` function to access the buffer. +Property Descriptions +--------------------- + + .. _class_BackBufferCopy_copy_mode: + +- :ref:`CopyMode` **copy_mode** - Buffer mode. See ``COPY_MODE_*`` constants. + + .. _class_BackBufferCopy_rect: + +- :ref:`Rect2` **rect** - The area covered by the BackBufferCopy. Only used if ``copy_mode`` is ``COPY_MODE_RECT``. + + diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index c839aac8f..bb33760f1 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -7,8 +7,7 @@ BakedLightmap ============= -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,61 +15,17 @@ Brief Description Prerendered indirect light map for a scene. -Member Functions ----------------- +Methods +------- +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BakeError` | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | +| :ref:`BakeError` | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`debug_bake` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_BakedLightmap_bake_cell_size: - -- :ref:`float` **bake_cell_size** - Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large. - - .. _class_BakedLightmap_bake_energy: - -- :ref:`float` **bake_energy** - - .. _class_BakedLightmap_bake_extents: - -- :ref:`Vector3` **bake_extents** - Size of affected area. - - .. _class_BakedLightmap_bake_hdr: - -- :ref:`bool` **bake_hdr** - If ``true`` lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. - - .. _class_BakedLightmap_bake_mode: - -- :ref:`BakeMode` **bake_mode** - Lightmapping mode. See :ref:`BakeMode`. - - .. _class_BakedLightmap_bake_propagation: - -- :ref:`float` **bake_propagation** - - .. _class_BakedLightmap_bake_quality: - -- :ref:`BakeQuality` **bake_quality** - Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. - - .. _class_BakedLightmap_capture_cell_size: - -- :ref:`float` **capture_cell_size** - Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. - - .. _class_BakedLightmap_image_path: - -- :ref:`String` **image_path** - Location where lightmaps will be saved. - - .. _class_BakedLightmap_light_data: - -- :ref:`BakedLightmapData` **light_data** - The calculated light data. - - -Enums ------ +Enumerations +------------ .. _enum_BakedLightmap_BakeQuality: @@ -101,19 +56,63 @@ enum **BakeMode** Description ----------- -Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. +Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the :ref:`GIProbe` approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. Tutorials --------- - :doc:`../tutorials/3d/baked_lightmaps` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_BakedLightmap_bake_cell_size: + +- :ref:`float` **bake_cell_size** - Grid subdivision size for lightmapper calculation. Default value of ``0.25`` will work for most cases. Increase for better lighting on small details or if your scene is very large. + + .. _class_BakedLightmap_bake_energy: + +- :ref:`float` **bake_energy** + + .. _class_BakedLightmap_bake_extents: + +- :ref:`Vector3` **bake_extents** - Size of affected area. + + .. _class_BakedLightmap_bake_hdr: + +- :ref:`bool` **bake_hdr** - If ``true`` lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. + + .. _class_BakedLightmap_bake_mode: + +- :ref:`BakeMode` **bake_mode** - Lightmapping mode. See :ref:`BakeMode`. + + .. _class_BakedLightmap_bake_propagation: + +- :ref:`float` **bake_propagation** + + .. _class_BakedLightmap_bake_quality: + +- :ref:`BakeQuality` **bake_quality** - Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. + + .. _class_BakedLightmap_capture_cell_size: + +- :ref:`float` **capture_cell_size** - Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. + + .. _class_BakedLightmap_image_path: + +- :ref:`String` **image_path** - Location where lightmaps will be saved. + + .. _class_BakedLightmap_light_data: + +- :ref:`BakedLightmapData` **light_data** - The calculated light data. + + +Method Descriptions +------------------- .. _class_BakedLightmap_bake: -- :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** +- :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** .. _class_BakedLightmap_debug_bake: diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index 57e2a92d9..c8e212bab 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -7,8 +7,7 @@ BakedLightmapData ================= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** | +| void | :ref:`add_user` **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_users` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_user_count` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | +| :ref:`Texture` | :ref:`get_user_lightmap` **(** :ref:`int` user_idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | +| :ref:`NodePath` | :ref:`get_user_path` **(** :ref:`int` user_idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_BakedLightmapData_bounds: -- :ref:`AABB` **bounds** +- :ref:`AABB` **bounds** .. _class_BakedLightmapData_cell_space_transform: -- :ref:`Transform` **cell_space_transform** +- :ref:`Transform` **cell_space_transform** .. _class_BakedLightmapData_cell_subdiv: @@ -52,15 +51,15 @@ Member Variables .. _class_BakedLightmapData_octree: -- :ref:`PoolByteArray` **octree** +- :ref:`PoolByteArray` **octree** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_BakedLightmapData_add_user: -- void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** +- void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** .. _class_BakedLightmapData_clear_users: @@ -72,10 +71,10 @@ Member Function Description .. _class_BakedLightmapData_get_user_lightmap: -- :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const +- :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const .. _class_BakedLightmapData_get_user_path: -- :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const +- :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 99d0bcf37..5c75bb51d 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -7,10 +7,8 @@ BaseButton ========== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`LinkButton`, :ref:`TextureButton`, :ref:`Button` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`LinkButton`, :ref:`TextureButton`, :ref:`Button` **Category:** Core Brief Description @@ -18,15 +16,15 @@ Brief Description Base class for different kinds of buttons. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-------------------------------------------------------------------------------------------------------+ | void | :ref:`_pressed` **(** **)** virtual | +--------------------------------------------+-------------------------------------------------------------------------------------------------------+ | void | :ref:`_toggled` **(** :ref:`bool` button_pressed **)** virtual | +--------------------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** const | +| :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_hovered` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------+ @@ -59,46 +57,8 @@ This signal is emitted every time the button is toggled or pressed (i.e. activat This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument. -Member Variables ----------------- - - .. _class_BaseButton_action_mode: - -- :ref:`ActionMode` **action_mode** - Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. - - .. _class_BaseButton_button_mask: - -- :ref:`int` **button_mask** - Binary mask to choose which mouse buttons this button will respond to. - -To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. - - .. _class_BaseButton_disabled: - -- :ref:`bool` **disabled** - If ``true`` the button is in disabled state and can't be clicked or toggled. - - .. _class_BaseButton_enabled_focus_mode: - -- :ref:`FocusMode` **enabled_focus_mode** - Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). - - .. _class_BaseButton_group: - -- :ref:`ButtonGroup` **group** - :ref:`ButtonGroup` associated to the button. - - .. _class_BaseButton_pressed: - -- :ref:`bool` **pressed** - If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). - - .. _class_BaseButton_shortcut: - -- :ref:`ShortCut` **shortcut** - Shortcut associated to the button. - - .. _class_BaseButton_toggle_mode: - -- :ref:`bool` **toggle_mode** - If ``true`` the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. - - -Enums ------ +Enumerations +------------ .. _enum_BaseButton_ActionMode: @@ -122,8 +82,46 @@ Description BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_BaseButton_action_mode: + +- :ref:`ActionMode` **action_mode** - Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. + + .. _class_BaseButton_button_mask: + +- :ref:`int` **button_mask** - Binary mask to choose which mouse buttons this button will respond to. + +To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. + + .. _class_BaseButton_disabled: + +- :ref:`bool` **disabled** - If ``true`` the button is in disabled state and can't be clicked or toggled. + + .. _class_BaseButton_enabled_focus_mode: + +- :ref:`FocusMode` **enabled_focus_mode** - Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). + + .. _class_BaseButton_group: + +- :ref:`ButtonGroup` **group** - :ref:`ButtonGroup` associated to the button. + + .. _class_BaseButton_pressed: + +- :ref:`bool` **pressed** - If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). + + .. _class_BaseButton_shortcut: + +- :ref:`ShortCut` **shortcut** - Shortcut associated to the button. + + .. _class_BaseButton_toggle_mode: + +- :ref:`bool` **toggle_mode** - If ``true`` the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. + + +Method Descriptions +------------------- .. _class_BaseButton__pressed: @@ -139,7 +137,7 @@ Called when the button is toggled (only if toggle_mode is active). .. _class_BaseButton_get_draw_mode: -- :ref:`DrawMode` **get_draw_mode** **(** **)** const +- :ref:`DrawMode` **get_draw_mode** **(** **)** const Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 0a93fde5b..be5aed3dc 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -14,69 +14,53 @@ Brief Description 3x3 matrix datatype. -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` from **)** | +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`determinant` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** | +| :ref:`Vector3` | :ref:`get_scale` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`inverse` **(** **)** | +| :ref:`Basis` | :ref:`inverse` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | +| :ref:`Basis` | :ref:`orthonormalized` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +| :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +| :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` b, :ref:`float` t **)** | +| :ref:`Basis` | :ref:`slerp` **(** :ref:`Basis` b, :ref:`float` t **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | +| :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | +| :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | +| :ref:`float` | :ref:`tdotz` **(** :ref:`Vector3` with **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`transposed` **(** **)** | +| :ref:`Basis` | :ref:`transposed` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | +| :ref:`Vector3` | :ref:`xform_inv` **(** :ref:`Vector3` v **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Basis_x: - -- :ref:`Vector3` **x** - The basis matrix's x vector. - - .. _class_Basis_y: - -- :ref:`Vector3` **y** - The basis matrix's y vector. - - .. _class_Basis_z: - -- :ref:`Vector3` **z** - The basis matrix's z vector. - - Description ----------- -3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as orthogonal basis for a :ref:`Transform`. +3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized (due to scaling). Almost always used as orthogonal basis for a :ref:`Transform`. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). @@ -86,30 +70,46 @@ Tutorials - :doc:`../tutorials/3d/using_transforms` - :doc:`../tutorials/math/rotations` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Basis_x: + +- :ref:`Vector3` **x** - The basis matrix's x vector. + + .. _class_Basis_y: + +- :ref:`Vector3` **y** - The basis matrix's y vector. + + .. _class_Basis_z: + +- :ref:`Vector3` **z** - The basis matrix's z vector. + + +Method Descriptions +------------------- .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** +- :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** Create a rotation matrix from the given quaternion. .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` from **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` from **)** Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Create a rotation matrix which rotates around the given axis by the specified angle, in radians. The axis must be a normalized vector. .. _class_Basis_Basis: -- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** +- :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. @@ -121,7 +121,7 @@ Return the determinant of the matrix. .. _class_Basis_get_euler: -- :ref:`Vector3` **get_euler** **(** **)** +- :ref:`Vector3` **get_euler** **(** **)** Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). @@ -133,73 +133,73 @@ This function considers a discretization of rotations into 24 points on unit sph .. _class_Basis_get_scale: -- :ref:`Vector3` **get_scale** **(** **)** +- :ref:`Vector3` **get_scale** **(** **)** Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. .. _class_Basis_inverse: -- :ref:`Basis` **inverse** **(** **)** +- :ref:`Basis` **inverse** **(** **)** Return the inverse of the matrix. .. _class_Basis_orthonormalized: -- :ref:`Basis` **orthonormalized** **(** **)** +- :ref:`Basis` **orthonormalized** **(** **)** Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. .. _class_Basis_rotated: -- :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Basis` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. .. _class_Basis_scaled: -- :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** +- :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. .. _class_Basis_slerp: -- :ref:`Basis` **slerp** **(** :ref:`Basis` b, :ref:`float` t **)** +- :ref:`Basis` **slerp** **(** :ref:`Basis` b, :ref:`float` t **)** Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. .. _class_Basis_tdotx: -- :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. .. _class_Basis_tdoty: -- :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. .. _class_Basis_tdotz: -- :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** +- :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. .. _class_Basis_transposed: -- :ref:`Basis` **transposed** **(** **)** +- :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. .. _class_Basis_xform: -- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the matrix. .. _class_Basis_xform_inv: -- :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 7e2b8a57e..d1ba56134 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -7,8 +7,7 @@ BitMap ====== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,27 @@ Brief Description Boolean matrix. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`Vector2` size **)** | +| void | :ref:`create` **(** :ref:`Vector2` size **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | +| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | +| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | +| void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const | +| :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +| void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -44,30 +43,30 @@ Description A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_BitMap_create: -- void **create** **(** :ref:`Vector2` size **)** +- void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with false. .. _class_BitMap_create_from_image_alpha: -- void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** +- void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to ``threshold`` or less, and true in other case. .. _class_BitMap_get_bit: -- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const +- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. .. _class_BitMap_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. @@ -79,21 +78,21 @@ Returns the amount of bitmap elements that are set to true. .. _class_BitMap_grow_mask: -- void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** +- void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** .. _class_BitMap_opaque_to_polygons: -- :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const +- :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const .. _class_BitMap_set_bit: -- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** +- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** Sets the bitmap's element at the specified position, to the specified value. .. _class_BitMap_set_bit_rect: -- void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** +- void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value. diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 1fdd2ba70..096937f75 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -7,8 +7,7 @@ BitmapFont ========== -**Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,36 @@ Brief Description Renders text using ``*.fnt`` fonts. -Member Functions ----------------- +Methods +------- +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | +| void | :ref:`add_char` **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | +| void | :ref:`add_texture` **(** :ref:`Texture` texture **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`create_from_fnt` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | +| :ref:`Vector2` | :ref:`get_char_size` **(** :ref:`int` char, :ref:`int` next=0 **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_kerning_pair` **(** :ref:`int` char_a, :ref:`int` char_b **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_texture` **(** :ref:`int` idx **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_texture_count` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont`. + +Property Descriptions +--------------------- .. _class_BitmapFont_ascent: @@ -52,24 +56,19 @@ Member Variables .. _class_BitmapFont_fallback: -- :ref:`BitmapFont` **fallback** - The fallback font. +- :ref:`BitmapFont` **fallback** - The fallback font. .. _class_BitmapFont_height: - :ref:`float` **height** - Total font height (ascent plus descent) in pixels. -Description ------------ - -Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont`. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_BitmapFont_add_char: -- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** +- void **add_char** **(** :ref:`int` character, :ref:`int` texture, :ref:`Rect2` rect, :ref:`Vector2` align=Vector2( 0, 0 ), :ref:`float` advance=-1 **)** Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance. @@ -81,7 +80,7 @@ Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are spe .. _class_BitmapFont_add_texture: -- void **add_texture** **(** :ref:`Texture` texture **)** +- void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the ``BitmapFont``. @@ -93,13 +92,13 @@ Clears all the font data and settings. .. _class_BitmapFont_create_from_fnt: -- :ref:`Error` **create_from_fnt** **(** :ref:`String` path **)** +- :ref:`Error` **create_from_fnt** **(** :ref:`String` path **)** Creates a BitmapFont from the ``*.fnt`` file at ``path``. .. _class_BitmapFont_get_char_size: -- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const +- :ref:`Vector2` **get_char_size** **(** :ref:`int` char, :ref:`int` next=0 **)** const Returns the size of a character, optionally taking kerning into account if the next character is provided. @@ -111,7 +110,7 @@ Returns a kerning pair as a difference. .. _class_BitmapFont_get_texture: -- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 84660ab86..d58f05558 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -7,8 +7,7 @@ Bone2D ====== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------+------------------------------------------------------------------------------------+ | void | :ref:`apply_rest` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_index_in_skeleton` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_skeleton_rest` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_skeleton_rest` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_Bone2D_default_length: @@ -36,11 +35,11 @@ Member Variables .. _class_Bone2D_rest: -- :ref:`Transform2D` **rest** +- :ref:`Transform2D` **rest** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Bone2D_apply_rest: @@ -52,6 +51,6 @@ Member Function Description .. _class_Bone2D_get_skeleton_rest: -- :ref:`Transform2D` **get_skeleton_rest** **(** **)** const +- :ref:`Transform2D` **get_skeleton_rest** **(** **)** const diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 00083bb97..6eeb85278 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -7,8 +7,7 @@ BoneAttachment ============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description A node that will attach to a bone. -Member Variables ----------------- - - .. _class_BoneAttachment_bone_name: - -- :ref:`String` **bone_name** - The name of the attached bone. - - Description ----------- -This node must be the child of a :ref:`Skeleton` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. +This node must be the child of a :ref:`Skeleton` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. + +Property Descriptions +--------------------- + + .. _class_BoneAttachment_bone_name: + +- :ref:`String` **bone_name** - The name of the attached bone. + diff --git a/classes/class_bool.rst b/classes/class_bool.rst index a5ebb4517..7878f9bd1 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -14,15 +14,15 @@ Brief Description Boolean built-in type -Member Functions ----------------- +Methods +------- +--------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`bool` **(** :ref:`int` from **)** | +--------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`bool` **(** :ref:`float` from **)** | +--------------------------+---------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | +| :ref:`bool` | :ref:`bool` **(** :ref:`String` from **)** | +--------------------------+---------------------------------------------------------------------------+ Description @@ -30,8 +30,8 @@ Description Boolean built-in type. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_bool_bool: @@ -47,8 +47,8 @@ Cast a :ref:`float` value to a boolean value, this method will retu .. _class_bool_bool: -- :ref:`bool` **bool** **(** :ref:`String` from **)** +- :ref:`bool` **bool** **(** :ref:`String` from **)** -Cast a :ref:`String` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false +Cast a :ref:`String` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 0b016d740..da6a3db67 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -7,10 +7,8 @@ BoxContainer ============ -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`VBoxContainer`, :ref:`HBoxContainer`, :ref:`ColorPicker` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`VBoxContainer`, :ref:`HBoxContainer`, :ref:`ColorPicker` **Category:** Core Brief Description @@ -18,23 +16,15 @@ Brief Description Base class for box containers. -Member Functions ----------------- +Methods +------- +-------+--------------------------------------------------------------------------------------------+ | void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | +-------+--------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_BoxContainer_alignment: - -- :ref:`AlignMode` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). - - -Enums ------ +Enumerations +------------ .. _enum_BoxContainer_AlignMode: @@ -50,8 +40,16 @@ Description Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_BoxContainer_alignment: + +- :ref:`AlignMode` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). + + +Method Descriptions +------------------- .. _class_BoxContainer_add_spacer: diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 91e03edff..c35d754df 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -7,8 +7,7 @@ BoxShape ======== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Box shape resource. -Member Variables ----------------- - - .. _class_BoxShape_extents: - -- :ref:`Vector3` **extents** - The shape's half extents. - - Description ----------- -3D box shape that can be a child of a :ref:`PhysicsBody` or :ref:`Area`. +3D box shape that can be a child of a :ref:`PhysicsBody` or :ref:`Area`. + +Property Descriptions +--------------------- + + .. _class_BoxShape_extents: + +- :ref:`Vector3` **extents** - The shape's half extents. + diff --git a/classes/class_bulletphysicsdirectbodystate.rst b/classes/class_bulletphysicsdirectbodystate.rst index 6994e8d6e..200e557aa 100644 --- a/classes/class_bulletphysicsdirectbodystate.rst +++ b/classes/class_bulletphysicsdirectbodystate.rst @@ -7,8 +7,7 @@ BulletPhysicsDirectBodyState ============================ -**Inherits:** :ref:`PhysicsDirectBodyState` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsDirectBodyState` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_bulletphysicsserver.rst b/classes/class_bulletphysicsserver.rst index 8c4ee3bfc..52112c1f0 100644 --- a/classes/class_bulletphysicsserver.rst +++ b/classes/class_bulletphysicsserver.rst @@ -7,8 +7,7 @@ BulletPhysicsServer =================== -**Inherits:** :ref:`PhysicsServer` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsServer` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_button.rst b/classes/class_button.rst index 0a61157fa..d879db459 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -7,10 +7,8 @@ Button ====== -**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`OptionButton`, :ref:`ColorPickerButton`, :ref:`CheckButton`, :ref:`MenuButton`, :ref:`ToolButton`, :ref:`CheckBox` - +**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`OptionButton`, :ref:`ColorPickerButton`, :ref:`CheckButton`, :ref:`MenuButton`, :ref:`ToolButton`, :ref:`CheckBox` **Category:** Core Brief Description @@ -18,32 +16,8 @@ Brief Description Standard themed Button. -Member Variables ----------------- - - .. _class_Button_align: - -- :ref:`TextAlign` **align** - Text alignment policy for the button's text, use one of the ALIGN\_\* constants. - - .. _class_Button_clip_text: - -- :ref:`bool` **clip_text** - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. - - .. _class_Button_flat: - -- :ref:`bool` **flat** - Flat buttons don't display decoration. - - .. _class_Button_icon: - -- :ref:`Texture` **icon** - Button's icon, if text is present the icon will be placed before the text. - - .. _class_Button_text: - -- :ref:`String` **text** - The button's text that will be displayed inside the button's area. - - -Enums ------ +Enumerations +------------ .. _enum_Button_TextAlign: @@ -57,5 +31,29 @@ enum **TextAlign** Description ----------- -Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme`. +Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme`. + +Property Descriptions +--------------------- + + .. _class_Button_align: + +- :ref:`TextAlign` **align** - Text alignment policy for the button's text, use one of the ALIGN\_\* constants. + + .. _class_Button_clip_text: + +- :ref:`bool` **clip_text** - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. + + .. _class_Button_flat: + +- :ref:`bool` **flat** - Flat buttons don't display decoration. + + .. _class_Button_icon: + +- :ref:`Texture` **icon** - Button's icon, if text is present the icon will be placed before the text. + + .. _class_Button_text: + +- :ref:`String` **text** - The button's text that will be displayed inside the button's area. + diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index dc52a64ec..22fb6222c 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -7,8 +7,7 @@ ButtonGroup =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,26 +15,26 @@ Brief Description Group of Buttons. -Member Functions ----------------- +Methods +------- +--------------------------------------+-----------------------------------------------------------------------------+ -| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | +| :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------+ Description ----------- -Group of :ref:`Button`. All direct and indirect children buttons become radios. Only one allows being pressed. +Group of :ref:`Button`. All direct and indirect children buttons become radios. Only one allows being pressed. :ref:`BaseButton.toggle_mode` should be ``true``. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ButtonGroup_get_pressed_button: -- :ref:`BaseButton` **get_pressed_button** **(** **)** +- :ref:`BaseButton` **get_pressed_button** **(** **)** Return the pressed button. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 5a68c31ed..039f97783 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -7,10 +7,8 @@ Camera ====== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`InterpolatedCamera`, :ref:`ARVRCamera` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`InterpolatedCamera`, :ref:`ClippedCamera`, :ref:`ARVRCamera` **Category:** Core Brief Description @@ -18,27 +16,27 @@ Brief Description Camera node, displays from a point of view. -Member Functions ----------------- +Methods +------- +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | +| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,63 +44,11 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | +| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Camera_cull_mask: - -- :ref:`int` **cull_mask** - The culling mask that describes which 3D render layers are rendered by this camera. - - .. _class_Camera_current: - -- :ref:`bool` **current** - If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. - - .. _class_Camera_doppler_tracking: - -- :ref:`DopplerTracking` **doppler_tracking** - If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: ``DOPPLER_TRACKING_DISABLED``. - - .. _class_Camera_environment: - -- :ref:`Environment` **environment** - The :ref:`Environment` to use for this Camera. - - .. _class_Camera_far: - -- :ref:`float` **far** - The distance to the far culling boundary for this Camera relative to its local z-axis. - - .. _class_Camera_fov: - -- :ref:`float` **fov** - The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. - - .. _class_Camera_h_offset: - -- :ref:`float` **h_offset** - The horizontal (X) offset of the Camera viewport. - - .. _class_Camera_keep_aspect: - -- :ref:`KeepAspect` **keep_aspect** - The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. - - .. _class_Camera_near: - -- :ref:`float` **near** - The distance to the near culling boundary for this Camera relative to its local z-axis. - - .. _class_Camera_projection: - -- :ref:`Projection` **projection** - The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-distance from the camera's local space scales their perceived size. - - .. _class_Camera_size: - -- :ref:`float` **size** - The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect` locks on axis, ``size`` sets the other axis' size length. - - .. _class_Camera_v_offset: - -- :ref:`float` **v_offset** - The vertical (Y) offset of the Camera viewport. - - -Enums ------ +Enumerations +------------ .. _enum_Camera_DopplerTracking: @@ -130,10 +76,62 @@ enum **KeepAspect** Description ----------- -Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest :ref:`Viewport` node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides *3D* display capabilities to a :ref:`Viewport`, and, without one, a scene registered in that :ref:`Viewport` (or higher viewports) can't be displayed. +Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest :ref:`Viewport` node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides *3D* display capabilities to a :ref:`Viewport`, and, without one, a scene registered in that :ref:`Viewport` (or higher viewports) can't be displayed. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Camera_cull_mask: + +- :ref:`int` **cull_mask** - The culling mask that describes which 3D render layers are rendered by this camera. + + .. _class_Camera_current: + +- :ref:`bool` **current** - If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. + + .. _class_Camera_doppler_tracking: + +- :ref:`DopplerTracking` **doppler_tracking** - If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effect for objects changed in particular ``_process`` methods. Default value: ``DOPPLER_TRACKING_DISABLED``. + + .. _class_Camera_environment: + +- :ref:`Environment` **environment** - The :ref:`Environment` to use for this Camera. + + .. _class_Camera_far: + +- :ref:`float` **far** - The distance to the far culling boundary for this Camera relative to its local z-axis. + + .. _class_Camera_fov: + +- :ref:`float` **fov** - The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. + + .. _class_Camera_h_offset: + +- :ref:`float` **h_offset** - The horizontal (X) offset of the Camera viewport. + + .. _class_Camera_keep_aspect: + +- :ref:`KeepAspect` **keep_aspect** - The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. + + .. _class_Camera_near: + +- :ref:`float` **near** - The distance to the near culling boundary for this Camera relative to its local z-axis. + + .. _class_Camera_projection: + +- :ref:`Projection` **projection** - The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-distance from the camera's local space scales their perceived size. + + .. _class_Camera_size: + +- :ref:`float` **size** - The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since :ref:`keep_aspect` locks on axis, ``size`` sets the other axis' size length. + + .. _class_Camera_v_offset: + +- :ref:`float` **v_offset** - The vertical (Y) offset of the Camera viewport. + + +Method Descriptions +------------------- .. _class_Camera_clear_current: @@ -143,9 +141,9 @@ If this is the current Camera, remove it from being current. If ``enable_next`` .. _class_Camera_get_camera_transform: -- :ref:`Transform` **get_camera_transform** **(** **)** const +- :ref:`Transform` **get_camera_transform** **(** **)** const -Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. +Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. .. _class_Camera_get_cull_mask_bit: @@ -153,7 +151,7 @@ Gets the camera transform. Subclassed cameras (such as CharacterCamera) may prov .. _class_Camera_is_position_behind: -- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const +- :ref:`bool` **is_position_behind** **(** :ref:`Vector3` world_point **)** const Returns ``true`` if the given position is behind the Camera. Note that a position which returns ``false`` may still be outside the Camera's field of view. @@ -161,31 +159,31 @@ Returns ``true`` if the given position is behind the Camera. Note that a positio - void **make_current** **(** **)** -Makes this camera the current Camera for the :ref:`Viewport` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. +Makes this camera the current Camera for the :ref:`Viewport` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. .. _class_Camera_project_local_ray_normal: -- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_local_ray_normal** **(** :ref:`Vector2` screen_point **)** const Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. .. _class_Camera_project_position: -- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_position** **(** :ref:`Vector2` screen_point **)** const -Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport` rectangle. +Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport` rectangle. .. _class_Camera_project_ray_normal: -- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_normal** **(** :ref:`Vector2` screen_point **)** const -Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. +Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. .. _class_Camera_project_ray_origin: -- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector3` **project_ray_origin** **(** :ref:`Vector2` screen_point **)** const -Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. +Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. .. _class_Camera_set_cull_mask_bit: @@ -205,8 +203,8 @@ Sets the camera projection to perspective mode, by specifying a *FOV* Y angle in .. _class_Camera_unproject_position: -- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const +- :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const -Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in worldspace. +Returns the 2D coordinate in the :ref:`Viewport` rectangle that maps to the given 3D point in worldspace. diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 9c2b6cf2c..89122d5c8 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -7,8 +7,7 @@ Camera2D ======== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Camera node for 2D scenes. -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`align` **(** **)** | @@ -26,21 +25,39 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`force_update_scroll` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | +| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------+ | void | :ref:`reset_smoothing` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Camera2D_AnchorMode: + +enum **AnchorMode** + +- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin. +- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. + + +Description +----------- + +Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of :ref:`CanvasItem` based nodes. + +This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from :ref:`Node2D` and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in :ref:`Viewport`. + +Property Descriptions +--------------------- .. _class_Camera2D_anchor_mode: -- :ref:`AnchorMode` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. +- :ref:`AnchorMode` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. .. _class_Camera2D_current: @@ -48,7 +65,7 @@ Member Variables .. _class_Camera2D_custom_viewport: -- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node attached to the ``Camera2D``. If null or not a :ref:`Viewport`, uses the default viewport instead. +- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node attached to the ``Camera2D``. If null or not a :ref:`Viewport`, uses the default viewport instead. .. _class_Camera2D_drag_margin_bottom: @@ -108,7 +125,7 @@ Member Variables .. _class_Camera2D_offset: -- :ref:`Vector2` **offset** - The camera's offset, useful for looking around or camera shake animations. +- :ref:`Vector2` **offset** - The camera's offset, useful for looking around or camera shake animations. .. _class_Camera2D_offset_h: @@ -132,29 +149,11 @@ Member Variables .. _class_Camera2D_zoom: -- :ref:`Vector2` **zoom** - The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out. +- :ref:`Vector2` **zoom** - The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out. -Enums ------ - - .. _enum_Camera2D_AnchorMode: - -enum **AnchorMode** - -- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin. -- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size. - - -Description ------------ - -Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of :ref:`CanvasItem` based nodes. - -This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from :ref:`Node2D` and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in :ref:`Viewport`. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Camera2D_align: @@ -166,7 +165,7 @@ Align the camera to the tracked node - void **clear_current** **(** **)** -Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. +Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. .. _class_Camera2D_force_update_scroll: @@ -176,13 +175,13 @@ Force the camera to update scroll immediately. .. _class_Camera2D_get_camera_position: -- :ref:`Vector2` **get_camera_position** **(** **)** const +- :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. .. _class_Camera2D_get_camera_screen_center: -- :ref:`Vector2` **get_camera_screen_center** **(** **)** const +- :ref:`Vector2` **get_camera_screen_center** **(** **)** const Returns the location of the ``Camera2D``'s screen-center, relative to the origin. diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index ea1f2f7a2..1e2abd8c5 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -7,10 +7,8 @@ CanvasItem ========== -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`Node2D`, :ref:`Control` - +**Inherits:** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`Node2D`, :ref:`Control` **Category:** Core Brief Description @@ -18,73 +16,75 @@ Brief Description Base class of anything 2D. -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_draw` **(** **)** virtual | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | +| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multimesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_multimesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | +| void | :ref:`force_update_transform` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World2D` | :ref:`get_world_2d` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,9 +96,9 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | +| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -139,24 +139,67 @@ Emitted when the item rect has changed. Emitted when the visibility (hidden/visible) changes. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_CanvasItem_BlendMode: + +enum **BlendMode** + +- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. +- **BLEND_MODE_ADD** = **1** --- Additive blending mode. +- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode. +- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode. +- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. +- **BLEND_MODE_DISABLED** = **5** --- Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied. + + +Constants +--------- + +- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Only received if requested. +- **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw. +- **NOTIFICATION_VISIBILITY_CHANGED** = **31** --- Canvas item visibility has changed. +- **NOTIFICATION_ENTER_CANVAS** = **32** --- Canvas item has entered the canvas. +- **NOTIFICATION_EXIT_CANVAS** = **33** --- Canvas item has exited the canvas. + +Description +----------- + +Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by :ref:`Control`, for anything GUI related, and by :ref:`Node2D` for anything 2D engine related. + +Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw\_\* functions). They can only be used inside the notification, signal or _draw() overrides function, though. + +Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). + +Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. + +Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. + +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/2d/custom_drawing_in_2d` + +Property Descriptions +--------------------- .. _class_CanvasItem_light_mask: -- :ref:`int` **light_mask** - The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. +- :ref:`int` **light_mask** - The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. .. _class_CanvasItem_material: -- :ref:`Material` **material** - The material applied to textures on this ``CanvasItem``. Default value: ``null``. +- :ref:`Material` **material** - The material applied to textures on this ``CanvasItem``. Default value: ``null``. .. _class_CanvasItem_modulate: -- :ref:`Color` **modulate** - The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). +- :ref:`Color` **modulate** - The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). .. _class_CanvasItem_self_modulate: -- :ref:`Color` **self_modulate** - The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. +- :ref:`Color` **self_modulate** - The color applied to textures on this ``CanvasItem``. This is not inherited by children ``CanvasItem``\ s. Default value: ``Color(1, 1, 1, 1)`` (opaque "white").. .. _class_CanvasItem_show_behind_parent: @@ -175,51 +218,8 @@ Member Variables - :ref:`bool` **visible** - If ``true`` this ``CanvasItem`` is drawn. Default value: ``true``. -Numeric Constants ------------------ - -- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Only received if requested. -- **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw. -- **NOTIFICATION_VISIBILITY_CHANGED** = **31** --- Canvas item visibility has changed. -- **NOTIFICATION_ENTER_CANVAS** = **32** --- Canvas item has entered the canvas. -- **NOTIFICATION_EXIT_CANVAS** = **33** --- Canvas item has exited the canvas. - -Enums ------ - - .. _enum_CanvasItem_BlendMode: - -enum **BlendMode** - -- **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. -- **BLEND_MODE_ADD** = **1** --- Additive blending mode. -- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode. -- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode. -- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. -- **BLEND_MODE_DISABLED** = **5** --- Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied. - - -Description ------------ - -Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by :ref:`Control`, for anything GUI related, and by :ref:`Node2D` for anything 2D engine related. - -Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw\_\* functions). They can only be used inside the notification, signal or _draw() overrides function, though. - -Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). - -Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. - -Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. - -Tutorials ---------- - -- :doc:`../tutorials/2d/2d_transforms` -- :doc:`../tutorials/2d/custom_drawing_in_2d` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CanvasItem__draw: @@ -229,185 +229,189 @@ Called (if exists) to draw the canvas item. .. _class_CanvasItem_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. .. _class_CanvasItem_draw_circle: -- void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** +- void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draws a colored circle. .. _class_CanvasItem_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draws a colored polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_line: -- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_line** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. .. _class_CanvasItem_draw_mesh: -- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** .. _class_CanvasItem_draw_multiline: -- void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_multiline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``color`` and ``width`` and optional antialiasing. .. _class_CanvasItem_draw_multiline_colors: -- void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_multiline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws multiple, parallel lines with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. .. _class_CanvasItem_draw_multimesh: -- void **draw_multimesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +- void **draw_multimesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** .. _class_CanvasItem_draw_polygon: -- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** Draws a polygon of any amount of points, convex or concave. .. _class_CanvasItem_draw_polyline: -- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing. .. _class_CanvasItem_draw_polyline_colors: -- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** Draws interconnected line segments with a uniform ``width``, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between ``points`` and ``colors``. .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=null, :ref:`float` width=1.0, :ref:`Texture` normal_map=null **)** Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. .. _class_CanvasItem_draw_rect: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draws a colored rectangle. .. _class_CanvasItem_draw_set_transform: -- void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** +- void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. .. _class_CanvasItem_draw_set_transform_matrix: -- void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** +- void **draw_set_transform_matrix** **(** :ref:`Transform2D` xform **)** Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. .. _class_CanvasItem_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** Draws a string using a custom font. .. _class_CanvasItem_draw_style_box: -- void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** +- void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draws a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draws a texture at a given position. .. _class_CanvasItem_draw_texture_rect: -- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** +- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. .. _class_CanvasItem_draw_texture_rect_region: -- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** +- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. +.. _class_CanvasItem_force_update_transform: + +- void **force_update_transform** **(** **)** + .. _class_CanvasItem_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** const +- :ref:`RID` **get_canvas** **(** **)** const -Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. +Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. .. _class_CanvasItem_get_canvas_item: -- :ref:`RID` **get_canvas_item** **(** **)** const +- :ref:`RID` **get_canvas_item** **(** **)** const -Return the canvas item RID used by :ref:`VisualServer` for this item. +Return the canvas item RID used by :ref:`VisualServer` for this item. .. _class_CanvasItem_get_canvas_transform: -- :ref:`Transform2D` **get_canvas_transform** **(** **)** const +- :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the transform matrix of this item's canvas. .. _class_CanvasItem_get_global_mouse_position: -- :ref:`Vector2` **get_global_mouse_position** **(** **)** const +- :ref:`Vector2` **get_global_mouse_position** **(** **)** const Get the global position of the mouse. .. _class_CanvasItem_get_global_transform: -- :ref:`Transform2D` **get_global_transform** **(** **)** const +- :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. .. _class_CanvasItem_get_global_transform_with_canvas: -- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const +- :ref:`Transform2D` **get_global_transform_with_canvas** **(** **)** const Get the global transform matrix of this item in relation to the canvas. .. _class_CanvasItem_get_local_mouse_position: -- :ref:`Vector2` **get_local_mouse_position** **(** **)** const +- :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. .. _class_CanvasItem_get_transform: -- :ref:`Transform2D` **get_transform** **(** **)** const +- :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. .. _class_CanvasItem_get_viewport_rect: -- :ref:`Rect2` **get_viewport_rect** **(** **)** const +- :ref:`Rect2` **get_viewport_rect** **(** **)** const -Get the viewport's boundaries as a :ref:`Rect2`. +Get the viewport's boundaries as a :ref:`Rect2`. .. _class_CanvasItem_get_viewport_transform: -- :ref:`Transform2D` **get_viewport_transform** **(** **)** const +- :ref:`Transform2D` **get_viewport_transform** **(** **)** const Get this item's transform in relation to the viewport. .. _class_CanvasItem_get_world_2d: -- :ref:`World2D` **get_world_2d** **(** **)** const +- :ref:`World2D` **get_world_2d** **(** **)** const -Get the :ref:`World2D` where this item is in. +Get the :ref:`World2D` where this item is in. .. _class_CanvasItem_hide: @@ -437,17 +441,17 @@ Returns ``true`` if global transform notifications are communicated to children. - :ref:`bool` **is_visible_in_tree** **(** **)** const -Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and its inherited visibility is also ``true``. +Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and its inherited visibility is also ``true``. .. _class_CanvasItem_make_canvas_position_local: -- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const Assigns ``screen_point`` as this node's new local transform. .. _class_CanvasItem_make_input_local: -- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const +- :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const Transformations issued by ``event``'s inputs are applied in local space instead of global space. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index abb8b8ce0..26fe5811d 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -7,29 +7,16 @@ CanvasItemMaterial ================== -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A material for :ref:`CanvasItem`\ s. +A material for :ref:`CanvasItem`\ s. -Member Variables ----------------- - - .. _class_CanvasItemMaterial_blend_mode: - -- :ref:`BlendMode` **blend_mode** - The manner in which a material's rendering is applied to underlying textures. - - .. _class_CanvasItemMaterial_light_mode: - -- :ref:`LightMode` **light_mode** - The manner in which material reacts to lighting. - - -Enums ------ +Enumerations +------------ .. _enum_CanvasItemMaterial_LightMode: @@ -53,5 +40,17 @@ enum **BlendMode** Description ----------- -``CanvasItemMaterial``\ s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a :ref:`ShaderMaterial` to more fully customize a material's interactions with a :ref:`CanvasItem`. +``CanvasItemMaterial``\ s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a :ref:`ShaderMaterial` to more fully customize a material's interactions with a :ref:`CanvasItem`. + +Property Descriptions +--------------------- + + .. _class_CanvasItemMaterial_blend_mode: + +- :ref:`BlendMode` **blend_mode** - The manner in which a material's rendering is applied to underlying textures. + + .. _class_CanvasItemMaterial_light_mode: + +- :ref:`LightMode` **light_mode** - The manner in which material reacts to lighting. + diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index b44909cb6..8467d922f 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -7,10 +7,8 @@ CanvasLayer =========== -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`ParallaxBackground` - +**Inherits:** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ParallaxBackground` **Category:** Core Brief Description @@ -18,19 +16,30 @@ Brief Description Canvas drawing layer. -Member Functions ----------------- +Methods +------- +------------------------+-------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | +------------------------+-------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Canvas drawing layer. :ref:`CanvasItem` nodes that are direct or indirect children of a ``CanvasLayer`` will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a ``CanvasLayer`` with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). + +Tutorials +--------- + +- :doc:`../tutorials/2d/2d_transforms` +- :doc:`../tutorials/2d/canvas_layers` + +Property Descriptions +--------------------- .. _class_CanvasLayer_custom_viewport: -- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. +- :ref:`Node` **custom_viewport** - The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. .. _class_CanvasLayer_layer: @@ -38,7 +47,7 @@ Member Variables .. _class_CanvasLayer_offset: -- :ref:`Vector2` **offset** - The layer's base offset. +- :ref:`Vector2` **offset** - The layer's base offset. .. _class_CanvasLayer_rotation: @@ -50,30 +59,19 @@ Member Variables .. _class_CanvasLayer_scale: -- :ref:`Vector2` **scale** - The layer's scale. +- :ref:`Vector2` **scale** - The layer's scale. .. _class_CanvasLayer_transform: -- :ref:`Transform2D` **transform** - The layer's transform. +- :ref:`Transform2D` **transform** - The layer's transform. -Description ------------ - -Canvas drawing layer. :ref:`CanvasItem` nodes that are direct or indirect children of a ``CanvasLayer`` will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a ``CanvasLayer`` with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). - -Tutorials ---------- - -- :doc:`../tutorials/2d/2d_transforms` -- :doc:`../tutorials/2d/canvas_layers` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CanvasLayer_get_canvas: -- :ref:`RID` **get_canvas** **(** **)** const +- :ref:`RID` **get_canvas** **(** **)** const Returns the RID of the canvas used by this layer. diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index ad1820f49..f39f9bb25 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -7,8 +7,7 @@ CanvasModulate ============== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Tint the entire canvas. -Member Variables ----------------- - - .. _class_CanvasModulate_color: - -- :ref:`Color` **color** - The tint color to apply. - - Description ----------- ``CanvasModulate`` tints the canvas elements using its assigned ``color``. +Property Descriptions +--------------------- + + .. _class_CanvasModulate_color: + +- :ref:`Color` **color** - The tint color to apply. + + diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index a4fe74073..00938278e 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -7,17 +7,21 @@ CapsuleMesh =========== -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Class representing a capsule-shaped :ref:`PrimitiveMesh`. +Class representing a capsule-shaped :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Class representing a capsule-shaped :ref:`PrimitiveMesh`. + +Property Descriptions +--------------------- .. _class_CapsuleMesh_mid_height: @@ -36,8 +40,3 @@ Member Variables - :ref:`int` **rings** - Number of rings along the height of the capsule. Defaults to 8. -Description ------------ - -Class representing a capsule-shaped :ref:`PrimitiveMesh`. - diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 63c0a55e4..7b28ec88c 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -7,8 +7,7 @@ CapsuleShape ============ -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Capsule shape for collisions. -Member Variables ----------------- +Description +----------- + +Capsule shape for collisions. + +Property Descriptions +--------------------- .. _class_CapsuleShape_height: @@ -28,8 +32,3 @@ Member Variables - :ref:`float` **radius** - The capsule's radius. -Description ------------ - -Capsule shape for collisions. - diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index 98f507688..4072b6441 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -7,8 +7,7 @@ CapsuleShape2D ============== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Capsule shape for 2D collisions. -Member Variables ----------------- +Description +----------- + +Capsule shape for 2D collisions. + +Property Descriptions +--------------------- .. _class_CapsuleShape2D_height: @@ -28,8 +32,3 @@ Member Variables - :ref:`float` **radius** - The capsule's radius. -Description ------------ - -Capsule shape for 2D collisions. - diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 172c4931c..413f0e919 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -7,8 +7,7 @@ CenterContainer =============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Keeps children controls centered. -Member Variables ----------------- +Description +----------- + +CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. + +Property Descriptions +--------------------- .. _class_CenterContainer_use_top_left: - :ref:`bool` **use_top_left** - If ``true`` centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. -Description ------------ - -CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. - diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 35dd79240..917301b23 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -7,8 +7,7 @@ CheckBox ======== -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 2213daecf..d1a3b8ae6 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -7,8 +7,7 @@ CheckButton =========== -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index 995f24959..65f0b5f97 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -7,8 +7,7 @@ CircleShape2D ============= -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Circular shape for 2D collisions. -Member Variables ----------------- +Description +----------- + +Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. + +Property Descriptions +--------------------- .. _class_CircleShape2D_radius: - :ref:`float` **radius** - The circle's radius. -Description ------------ - -Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. - diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index 01d914228..1cb555864 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -7,8 +7,7 @@ ClassDB ======= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,49 +15,49 @@ Brief Description Class information repository. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | +| :ref:`bool` | :ref:`can_instance` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | +| :ref:`bool` | :ref:`class_exists` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | +| :ref:`String` | :ref:`class_get_category` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | +| :ref:`int` | :ref:`class_get_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +| :ref:`PoolStringArray` | :ref:`class_get_integer_constant_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +| :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +| :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | +| :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +| :ref:`Array` | :ref:`class_get_signal_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | +| :ref:`bool` | :ref:`class_has_integer_constant` **(** :ref:`String` class, :ref:`String` name **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | +| :ref:`bool` | :ref:`class_has_method` **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | +| :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | +| :ref:`Error` | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | +| :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | +| :ref:`String` | :ref:`get_parent_class` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | +| :ref:`Variant` | :ref:`instance` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | +| :ref:`bool` | :ref:`is_class_enabled` **(** :ref:`String` class **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | +| :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -66,126 +65,126 @@ Description Provides access to metadata stored for every available class. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ClassDB_can_instance: -- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const +- :ref:`bool` **can_instance** **(** :ref:`String` class **)** const Returns true if you can instance objects from the specified 'class', false in other case. .. _class_ClassDB_class_exists: -- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const +- :ref:`bool` **class_exists** **(** :ref:`String` class **)** const Returns whether the specified 'class' is available or not. .. _class_ClassDB_class_get_category: -- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const +- :ref:`String` **class_get_category** **(** :ref:`String` class **)** const Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. .. _class_ClassDB_class_get_integer_constant: -- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. .. _class_ClassDB_class_get_integer_constant_list: -- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with the names all the integer constants of 'class' or its ancestry. .. _class_ClassDB_class_get_method_list: -- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const -Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). +Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). .. _class_ClassDB_class_get_property: -- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const +- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const Returns the value of 'property' of 'class' or its ancestry. .. _class_ClassDB_class_get_property_list: -- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. .. _class_ClassDB_class_get_signal: -- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const -Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). +Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). .. _class_ClassDB_class_get_signal_list: -- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +- :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const -Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. +Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. .. _class_ClassDB_class_has_integer_constant: -- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +- :ref:`bool` **class_has_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const Return whether 'class' or its ancestry has an integer constant called 'name' or not. .. _class_ClassDB_class_has_method: -- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +- :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. .. _class_ClassDB_class_has_signal: -- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +- :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const Return whether 'class' or its ancestry has a signal called 'signal' or not. .. _class_ClassDB_class_set_property: -- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +- :ref:`Error` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const Sets 'property' value of 'class' to 'value'. .. _class_ClassDB_get_class_list: -- :ref:`PoolStringArray` **get_class_list** **(** **)** const +- :ref:`PoolStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. .. _class_ClassDB_get_inheriters_from_class: -- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const +- :ref:`PoolStringArray` **get_inheriters_from_class** **(** :ref:`String` class **)** const Returns the names of all the classes that directly or indirectly inherit from 'class'. .. _class_ClassDB_get_parent_class: -- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const +- :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. .. _class_ClassDB_instance: -- :ref:`Variant` **instance** **(** :ref:`String` class **)** const +- :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. .. _class_ClassDB_is_class_enabled: -- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const +- :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const Returns whether this class is enabled or not. .. _class_ClassDB_is_parent_class: -- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const +- :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const Returns whether 'inherits' is an ancestor of 'class' or not. diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst new file mode 100644 index 000000000..f5e5887b0 --- /dev/null +++ b/classes/class_clippedcamera.rst @@ -0,0 +1,103 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ClippedCamera.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ClippedCamera: + +ClippedCamera +============= + +**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_exceptions` **(** **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + + .. _enum_ClippedCamera_ProcessMode: + +enum **ProcessMode** + +- **CLIP_PROCESS_PHYSICS** = **0** +- **CLIP_PROCESS_IDLE** = **1** + + +Property Descriptions +--------------------- + + .. _class_ClippedCamera_clip_to_areas: + +- :ref:`bool` **clip_to_areas** + + .. _class_ClippedCamera_clip_to_bodies: + +- :ref:`bool` **clip_to_bodies** + + .. _class_ClippedCamera_collision_mask: + +- :ref:`int` **collision_mask** + + .. _class_ClippedCamera_margin: + +- :ref:`float` **margin** + + .. _class_ClippedCamera_process_mode: + +- :ref:`ProcessMode` **process_mode** + + +Method Descriptions +------------------- + +.. _class_ClippedCamera_add_exception: + +- void **add_exception** **(** :ref:`Object` node **)** + +.. _class_ClippedCamera_add_exception_rid: + +- void **add_exception_rid** **(** :ref:`RID` rid **)** + +.. _class_ClippedCamera_clear_exceptions: + +- void **clear_exceptions** **(** **)** + +.. _class_ClippedCamera_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + +.. _class_ClippedCamera_remove_exception: + +- void **remove_exception** **(** :ref:`Object` node **)** + +.. _class_ClippedCamera_remove_exception_rid: + +- void **remove_exception_rid** **(** :ref:`RID` rid **)** + +.. _class_ClippedCamera_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + + diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 95a663475..7f6620a3b 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -7,10 +7,8 @@ CollisionObject =============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`PhysicsBody`, :ref:`Area` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`PhysicsBody`, :ref:`Area` **Category:** Core Brief Description @@ -18,17 +16,17 @@ Brief Description Base node for collision objects. -Member Functions ----------------- +Methods +------- +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | +| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_rid` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,25 +34,25 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -62,7 +60,7 @@ Signals .. _class_CollisionObject_input_event: -- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Node` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** Emitted when :ref:`_input_event` receives an event. See its description for details. @@ -79,8 +77,13 @@ Emitted when the mouse pointer enters any of this object's shapes. Emitted when the mouse pointer exits all this object's shapes. -Member Variables ----------------- +Description +----------- + +CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape`\ s. Each shape must be assigned to a *shape owner*. 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 ``shape_owner_*`` methods. + +Property Descriptions +--------------------- .. _class_CollisionObject_input_capture_on_drag: @@ -88,40 +91,35 @@ Member Variables .. _class_CollisionObject_input_ray_pickable: -- :ref:`bool` **input_ray_pickable** - If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. +- :ref:`bool` **input_ray_pickable** - If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. -Description ------------ - -CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape`\ s. Each shape must be assigned to a *shape owner*. 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 ``shape_owner_*`` methods. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CollisionObject__input_event: -- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual -Accepts unhandled :ref:`InputEvent`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. +Accepts unhandled :ref:`InputEvent`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events. .. _class_CollisionObject_create_shape_owner: -- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. .. _class_CollisionObject_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const -Returns the object's :ref:`RID`. +Returns the object's :ref:`RID`. .. _class_CollisionObject_get_shape_owners: -- :ref:`Array` **get_shape_owners** **(** **)** +- :ref:`Array` **get_shape_owners** **(** **)** -Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. +Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. .. _class_CollisionObject_is_shape_owner_disabled: @@ -143,9 +141,9 @@ Returns the ``owner_id`` of the given shape. .. _class_CollisionObject_shape_owner_add_shape: -- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** -Adds a :ref:`Shape` to the shape owner. +Adds a :ref:`Shape` to the shape owner. .. _class_CollisionObject_shape_owner_clear_shapes: @@ -155,15 +153,15 @@ Removes all shapes from the shape owner. .. _class_CollisionObject_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. .. _class_CollisionObject_shape_owner_get_shape: -- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const -Returns the :ref:`Shape` with the given id from the given shape owner. +Returns the :ref:`Shape` with the given id from the given shape owner. .. _class_CollisionObject_shape_owner_get_shape_count: @@ -175,13 +173,13 @@ Returns the number of shapes the given shape owner contains. - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const -Returns the child index of the :ref:`Shape` with the given id from the given shape owner. +Returns the child index of the :ref:`Shape` with the given id from the given shape owner. .. _class_CollisionObject_shape_owner_get_transform: -- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const -Returns the shape owner's :ref:`Transform`. +Returns the shape owner's :ref:`Transform`. .. _class_CollisionObject_shape_owner_remove_shape: @@ -197,8 +195,8 @@ If ``true`` disables the given shape owner. .. _class_CollisionObject_shape_owner_set_transform: -- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** -Sets the :ref:`Transform` of the given shape owner. +Sets the :ref:`Transform` of the given shape owner. diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 4887b2f99..6b3309887 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -7,10 +7,8 @@ CollisionObject2D ================= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` **Category:** Core Brief Description @@ -18,17 +16,17 @@ Brief Description Base node for 2D collision objects. -Member Functions ----------------- +Methods +------- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | +| void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_rid` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,19 +36,19 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | +| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,7 +56,7 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -66,7 +64,7 @@ Signals .. _class_CollisionObject2D_input_event: -- **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Node` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** Emitted when an input event occurs and ``input_pickable`` is ``true``. See :ref:`_input_event` for details. @@ -83,45 +81,45 @@ Emitted when the mouse pointer enters any of this object's shapes. Emitted when the mouse pointer exits all this object's shapes. -Member Variables ----------------- +Description +----------- + +CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision :ref:`Shape2D`\ s. Each shape must be assigned to a *shape owner*. 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 ``shape_owner_*`` methods. + +Property Descriptions +--------------------- .. _class_CollisionObject2D_input_pickable: - :ref:`bool` **input_pickable** - If ``true`` this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. -Description ------------ - -CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision :ref:`Shape2D`\ s. Each shape must be assigned to a *shape owner*. 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 ``shape_owner_*`` methods. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CollisionObject2D__input_event: -- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual -Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. +Accepts unhandled :ref:`InputEvent`\ s. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. .. _class_CollisionObject2D_create_shape_owner: -- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. .. _class_CollisionObject2D_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const -Returns the object's :ref:`RID`. +Returns the object's :ref:`RID`. .. _class_CollisionObject2D_get_shape_owners: -- :ref:`Array` **get_shape_owners** **(** **)** +- :ref:`Array` **get_shape_owners** **(** **)** -Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. +Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. .. _class_CollisionObject2D_is_shape_owner_disabled: @@ -149,9 +147,9 @@ Returns the ``owner_id`` of the given shape. .. _class_CollisionObject2D_shape_owner_add_shape: -- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** +- void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** -Adds a :ref:`Shape2D` to the shape owner. +Adds a :ref:`Shape2D` to the shape owner. .. _class_CollisionObject2D_shape_owner_clear_shapes: @@ -161,15 +159,15 @@ Removes all shapes from the shape owner. .. _class_CollisionObject2D_shape_owner_get_owner: -- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const +- :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const Returns the parent object of the given shape owner. .. _class_CollisionObject2D_shape_owner_get_shape: -- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const -Returns the :ref:`Shape2D` with the given id from the given shape owner. +Returns the :ref:`Shape2D` with the given id from the given shape owner. .. _class_CollisionObject2D_shape_owner_get_shape_count: @@ -181,13 +179,13 @@ Returns the number of shapes the given shape owner contains. - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const -Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. +Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. .. _class_CollisionObject2D_shape_owner_get_transform: -- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const +- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const -Returns the shape owner's :ref:`Transform2D`. +Returns the shape owner's :ref:`Transform2D`. .. _class_CollisionObject2D_shape_owner_remove_shape: @@ -209,8 +207,8 @@ If ``enable`` is ``true``, collisions for the shape owner originating from this .. _class_CollisionObject2D_shape_owner_set_transform: -- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** +- void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** -Sets the :ref:`Transform2D` of the given shape owner. +Sets the :ref:`Transform2D` of the given shape owner. diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index bcdc05f76..d2364bebe 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -7,8 +7,7 @@ CollisionPolygon ================ -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Editor-only class for defining a collision polygon in 3D space. -Member Variables ----------------- +Description +----------- + +Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape` for gameplay. Properties modified during gameplay will have no effect. + +Property Descriptions +--------------------- .. _class_CollisionPolygon_depth: @@ -29,11 +33,6 @@ Member Variables .. _class_CollisionPolygon_polygon: -- :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. +- :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. -Description ------------ - -Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape` for gameplay. Properties modified during gameplay will have no effect. - diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 1475a2470..f1ed0b420 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -7,8 +7,7 @@ CollisionPolygon2D ================== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,28 +15,8 @@ Brief Description Defines a 2D collision polygon. -Member Variables ----------------- - - .. _class_CollisionPolygon2D_build_mode: - -- :ref:`BuildMode` **build_mode** - Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. - - .. _class_CollisionPolygon2D_disabled: - -- :ref:`bool` **disabled** - If ``true`` no collisions will be detected. - - .. _class_CollisionPolygon2D_one_way_collision: - -- :ref:`bool` **one_way_collision** - If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. - - .. _class_CollisionPolygon2D_polygon: - -- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. - - -Enums ------ +Enumerations +------------ .. _enum_CollisionPolygon2D_BuildMode: @@ -50,5 +29,25 @@ enum **BuildMode** Description ----------- -Provides a 2D collision polygon to a :ref:`CollisionObject2D` parent. Polygon can be drawn in the editor or specified by a list of vertices. +Provides a 2D collision polygon to a :ref:`CollisionObject2D` parent. Polygon can be drawn in the editor or specified by a list of vertices. + +Property Descriptions +--------------------- + + .. _class_CollisionPolygon2D_build_mode: + +- :ref:`BuildMode` **build_mode** - Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. + + .. _class_CollisionPolygon2D_disabled: + +- :ref:`bool` **disabled** - If ``true`` no collisions will be detected. + + .. _class_CollisionPolygon2D_one_way_collision: + +- :ref:`bool` **one_way_collision** - If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. + + .. _class_CollisionPolygon2D_polygon: + +- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. + diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index b8ea832b6..b52bffab8 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -7,8 +7,7 @@ CollisionShape ============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,27 @@ Brief Description Node that represents collision shape data in 3D space. -Member Functions ----------------- +Methods +------- +-------+---------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_convex_from_brothers` **(** **)** | +-------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +-------+---------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. + +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + +Property Descriptions +--------------------- .. _class_CollisionShape_disabled: @@ -34,31 +43,21 @@ Member Variables .. _class_CollisionShape_shape: -- :ref:`Shape` **shape** - The actual shape owned by this collision shape. +- :ref:`Shape` **shape** - The actual shape owned by this collision shape. -Description ------------ - -Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. - -Tutorials ---------- - -- :doc:`../tutorials/physics/physics_introduction` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CollisionShape_make_convex_from_brothers: - void **make_convex_from_brothers** **(** **)** -Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance` siblings geometry. +Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance` siblings geometry. .. _class_CollisionShape_resource_changed: -- void **resource_changed** **(** :ref:`Resource` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** If this method exists within a script it will be called whenever the shape resource has been modified. diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 0b8a28f61..714e8b0cc 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -7,8 +7,7 @@ CollisionShape2D ================ -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,18 @@ Brief Description Node that represents collision shape data in 2D space. -Member Variables ----------------- +Description +----------- + +Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. + +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + +Property Descriptions +--------------------- .. _class_CollisionShape2D_disabled: @@ -29,16 +38,6 @@ Member Variables .. _class_CollisionShape2D_shape: -- :ref:`Shape2D` **shape** - The actual shape owned by this collision shape. +- :ref:`Shape2D` **shape** - The actual shape owned by this collision shape. -Description ------------ - -Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to create a solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. - -Tutorials ---------- - -- :doc:`../tutorials/physics/physics_introduction` - diff --git a/classes/class_color.rst b/classes/class_color.rst index 3785181e5..434a92c35 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -14,33 +14,33 @@ Brief Description Color in RGBA format with some support for ARGB format. -Member Functions ----------------- +Methods +------- +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`String` from **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`int` from **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | +| :ref:`Color` | :ref:`Color` **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | +| :ref:`Color` | :ref:`blend` **(** :ref:`Color` over **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`contrasted` **(** **)** | +| :ref:`Color` | :ref:`contrasted` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | +| :ref:`Color` | :ref:`darkened` **(** :ref:`float` amount **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** | +| :ref:`Color` | :ref:`from_hsv` **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`gray` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`inverted` **(** **)** | +| :ref:`Color` | :ref:`inverted` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | +| :ref:`Color` | :ref:`lightened` **(** :ref:`float` amount **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | +| :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_abgr32` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,63 +50,15 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_argb64` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | +| :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_rgba32` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_rgba64` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Color_a: - -- :ref:`float` **a** - Alpha (0 to 1) - - .. _class_Color_a8: - -- :ref:`int` **a8** - Alpha (0 to 255) - - .. _class_Color_b: - -- :ref:`float` **b** - Blue (0 to 1) - - .. _class_Color_b8: - -- :ref:`int` **b8** - Blue (0 to 255) - - .. _class_Color_g: - -- :ref:`float` **g** - Green (0 to 1) - - .. _class_Color_g8: - -- :ref:`int` **g8** - Green (0 to 255) - - .. _class_Color_h: - -- :ref:`float` **h** - Hue (0 to 1) - - .. _class_Color_r: - -- :ref:`float` **r** - Red (0 to 1) - - .. _class_Color_r8: - -- :ref:`int` **r8** - Red (0 to 255) - - .. _class_Color_s: - -- :ref:`float` **s** - Saturation (0 to 1) - - .. _class_Color_v: - -- :ref:`float` **v** - Value (0 to 1) - - -Numeric Constants ------------------ +Constants +--------- - **gray** = **Color( 0.75, 0.75, 0.75, 1 )** - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** @@ -261,12 +213,60 @@ A color is represented as red, green and blue (r,g,b) components. Additionally, You can also create a color from standardised color names with Color.ColorN (e.g. Color.green) or :ref:`@GDScript.ColorN`. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Color_a: + +- :ref:`float` **a** - Alpha (0 to 1) + + .. _class_Color_a8: + +- :ref:`int` **a8** - Alpha (0 to 255) + + .. _class_Color_b: + +- :ref:`float` **b** - Blue (0 to 1) + + .. _class_Color_b8: + +- :ref:`int` **b8** - Blue (0 to 255) + + .. _class_Color_g: + +- :ref:`float` **g** - Green (0 to 1) + + .. _class_Color_g8: + +- :ref:`int` **g8** - Green (0 to 255) + + .. _class_Color_h: + +- :ref:`float` **h** - Hue (0 to 1) + + .. _class_Color_r: + +- :ref:`float` **r** - Red (0 to 1) + + .. _class_Color_r8: + +- :ref:`int` **r8** - Red (0 to 255) + + .. _class_Color_s: + +- :ref:`float` **s** - Saturation (0 to 1) + + .. _class_Color_v: + +- :ref:`float` **v** - Value (0 to 1) + + +Method Descriptions +------------------- .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`String` from **)** +- :ref:`Color` **Color** **(** :ref:`String` from **)** Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN`. @@ -290,7 +290,7 @@ The following string formats are supported: .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`int` from **)** +- :ref:`Color` **Color** **(** :ref:`int` from **)** Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). @@ -300,7 +300,7 @@ Constructs a color from a 32-bit integer (each byte represents a component of th .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. @@ -310,7 +310,7 @@ Constructs a color from an RGB profile using values between 0 and 1 (float). Alp .. _class_Color_Color: -- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** +- :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** Constructs a color from an RGBA profile using values between 0 and 1 (float). @@ -320,7 +320,7 @@ Constructs a color from an RGBA profile using values between 0 and 1 (float). .. _class_Color_blend: -- :ref:`Color` **blend** **(** :ref:`Color` over **)** +- :ref:`Color` **blend** **(** :ref:`Color` over **)** Returns a new color resulting from blending this color over another color. If the color is opaque, the result would also be opaque. The other color could then take a range of values with different alpha values. @@ -332,7 +332,7 @@ Returns a new color resulting from blending this color over another color. If th .. _class_Color_contrasted: -- :ref:`Color` **contrasted** **(** **)** +- :ref:`Color` **contrasted** **(** **)** Returns the most contrasting color. @@ -343,7 +343,7 @@ Returns the most contrasting color. .. _class_Color_darkened: -- :ref:`Color` **darkened** **(** :ref:`float` amount **)** +- :ref:`Color` **darkened** **(** :ref:`float` amount **)** Returns a new color resulting from making this color darker by the specified percentage (0-1). @@ -354,7 +354,7 @@ Returns a new color resulting from making this color darker by the specified per .. _class_Color_from_hsv: -- :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** +- :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1. @@ -377,7 +377,7 @@ The gray is calculated by (r + g + b) / 3. .. _class_Color_inverted: -- :ref:`Color` **inverted** **(** **)** +- :ref:`Color` **inverted** **(** **)** Returns the inverted color (1-r, 1-g, 1-b, 1-a). @@ -388,7 +388,7 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a). .. _class_Color_lightened: -- :ref:`Color` **lightened** **(** :ref:`float` amount **)** +- :ref:`Color` **lightened** **(** :ref:`float` amount **)** Returns a new color resulting from making this color lighter by the specified percentage (0-1). @@ -399,7 +399,7 @@ Returns a new color resulting from making this color lighter by the specified pe .. _class_Color_linear_interpolate: -- :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** +- :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float). @@ -455,7 +455,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon .. _class_Color_to_html: -- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** +- :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``). diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index bded321bf..962b4df89 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -7,8 +7,7 @@ ColorPicker =========== -**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description Color picker control. -Member Functions ----------------- +Methods +------- +-------+---------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` color **)** | +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | +-------+---------------------------------------------------------------------------------------------+ Signals @@ -28,17 +27,22 @@ Signals .. _class_ColorPicker_color_changed: -- **color_changed** **(** :ref:`Color` color **)** +- **color_changed** **(** :ref:`Color` color **)** Emitted when the color is changed. -Member Variables ----------------- +Description +----------- + +:ref:`Control` node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. + +Property Descriptions +--------------------- .. _class_ColorPicker_color: -- :ref:`Color` **color** - The currently selected color. +- :ref:`Color` **color** - The currently selected color. .. _class_ColorPicker_deferred_mode: @@ -53,17 +57,12 @@ Member Variables - :ref:`bool` **raw_mode** - If ``true`` allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). -Description ------------ - -:ref:`Control` node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ColorPicker_add_preset: -- void **add_preset** **(** :ref:`Color` color **)** +- void **add_preset** **(** :ref:`Color` color **)** Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index c50dd68aa..611657274 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -7,22 +7,21 @@ ColorPickerButton ================= -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Button that pops out a :ref:`ColorPicker`. +Button that pops out a :ref:`ColorPicker`. -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------+ -| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | +| :ref:`ColorPicker` | :ref:`get_picker` **(** **)** | +----------------------------------------+-------------------------------------------------------------------+ -| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | +| :ref:`PopupPanel` | :ref:`get_popup` **(** **)** | +----------------------------------------+-------------------------------------------------------------------+ Signals @@ -30,7 +29,7 @@ Signals .. _class_ColorPickerButton_color_changed: -- **color_changed** **(** :ref:`Color` color **)** +- **color_changed** **(** :ref:`Color` color **)** Emitted when the color changes. @@ -39,36 +38,36 @@ Emitted when the color changes. - **popup_closed** **(** **)** -Member Variables ----------------- - - .. _class_ColorPickerButton_color: - -- :ref:`Color` **color** - The currently selected color. - - .. _class_ColorPickerButton_edit_alpha: - -- :ref:`bool` **edit_alpha** - If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. - - Description ----------- -Encapsulates a :ref:`ColorPicker` making it accesible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker` visibility. +Encapsulates a :ref:`ColorPicker` making it accesible by pressing a button. Pressing the button will toggle the :ref:`ColorPicker` visibility. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ColorPickerButton_color: + +- :ref:`Color` **color** - The currently selected color. + + .. _class_ColorPickerButton_edit_alpha: + +- :ref:`bool` **edit_alpha** - If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. + + +Method Descriptions +------------------- .. _class_ColorPickerButton_get_picker: -- :ref:`ColorPicker` **get_picker** **(** **)** +- :ref:`ColorPicker` **get_picker** **(** **)** -Returns the :ref:`ColorPicker` that this node toggles. +Returns the :ref:`ColorPicker` that this node toggles. .. _class_ColorPickerButton_get_popup: -- :ref:`PopupPanel` **get_popup** **(** **)** +- :ref:`PopupPanel` **get_popup** **(** **)** -Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. +Returns the control's :ref:`PopupPanel` which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index a03e3abe8..040650662 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -7,8 +7,7 @@ ColorRect ========= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description Colored rectangle. -Member Variables ----------------- +Description +----------- + +Displays a colored rectangle. + +Property Descriptions +--------------------- .. _class_ColorRect_color: -- :ref:`Color` **color** - The fill color. +- :ref:`Color` **color** - The fill color. :: $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. -Description ------------ - -Displays a colored rectangle. - diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index e7285c778..746939276 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -7,8 +7,7 @@ ConcavePolygonShape =================== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,32 +15,32 @@ Brief Description Concave polygon shape. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | +| void | :ref:`set_faces` **(** :ref:`PoolVector3Array` faces **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Concave polygon shape resource, which can be set into a :ref:`PhysicsBody` or area. This shape is created by feeding a list of triangles. +Concave polygon shape resource, which can be set into a :ref:`PhysicsBody` or area. This shape is created by feeding a list of triangles. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ConcavePolygonShape_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** const Return the faces (an array of triangles). .. _class_ConcavePolygonShape_set_faces: -- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** +- void **set_faces** **(** :ref:`PoolVector3Array` faces **)** Set the faces (an array of triangles). diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 85ed5098a..0af05ca9d 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -7,8 +7,7 @@ ConcavePolygonShape2D ===================== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,18 @@ Brief Description Concave polygon 2D shape resource for physics. -Member Variables ----------------- - - .. _class_ConcavePolygonShape2D_segments: - -- :ref:`PoolVector2Array` **segments** - The array of points that make up the ``ConcavePolygonShape2D``'s line segments. - - Description ----------- -Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for :ref:`RigidBody2D` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. +Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for :ref:`RigidBody2D` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. + +The main difference between a :ref:`ConvexPolygonShape2D` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. + +Property Descriptions +--------------------- + + .. _class_ConcavePolygonShape2D_segments: + +- :ref:`PoolVector2Array` **segments** - The array of points that make up the ``ConcavePolygonShape2D``'s line segments. -The main difference between a :ref:`ConvexPolygonShape2D` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index aff0aac17..6e007b68e 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -7,8 +7,7 @@ ConeTwistJoint ============== -**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,42 @@ Brief Description A twist joint between two 3D bodies. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_ConeTwistJoint_Param: + +enum **Param** + +- **PARAM_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. + +The swing span defines, how much rotation will not get corrected allong the swing axis. + +Could be defined as looseness in the ``ConeTwistJoint``. + +If below 0.05, this behaviour is locked. Default value: ``PI/4``. +- **PARAM_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist. + +Twist is locked if below 0.05. +- **PARAM_BIAS** = **2** --- The speed with which the swing or twist will take place. + +The higher, the faster. +- **PARAM_SOFTNESS** = **3** --- The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. +- **PARAM_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. +- **PARAM_MAX** = **5** --- End flag of PARAM\_\* constants, used internally. + + +Description +----------- + +The joint can rotate the bodies across an axis defined by the local x-axes of the :ref:`Joint`. + +The twist axis is initiated as the x-axis of the :ref:`Joint`. + +Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. + +Property Descriptions +--------------------- .. _class_ConeTwistJoint_bias: @@ -50,37 +83,3 @@ If below 0.05, this behaviour is locked. Default value: ``PI/4``. Twist is locked if below 0.05. -Enums ------ - - .. _enum_ConeTwistJoint_Param: - -enum **Param** - -- **PARAM_SWING_SPAN** = **0** --- Swing is rotation from side to side, around the axis perpendicular to the twist axis. - -The swing span defines, how much rotation will not get corrected allong the swing axis. - -Could be defined as looseness in the ``ConeTwistJoint``. - -If below 0.05, this behaviour is locked. Default value: ``PI/4``. -- **PARAM_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist. - -Twist is locked if below 0.05. -- **PARAM_BIAS** = **2** --- The speed with which the swing or twist will take place. - -The higher, the faster. -- **PARAM_SOFTNESS** = **3** --- The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. -- **PARAM_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. -- **PARAM_MAX** = **5** --- End flag of PARAM\_\* constants, used internally. - - -Description ------------ - -The joint can rotate the bodies across an axis defined by the local x-axes of the :ref:`Joint`. - -The twist axis is initiated as the x-axis of the :ref:`Joint`. - -Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. - diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index dd229a4eb..4d2a2fe34 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -7,8 +7,7 @@ ConfigFile ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,33 @@ Brief Description Helper class to handle INI-style files. -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_section` **(** :ref:`String` section **)** | +| void | :ref:`erase_section` **(** :ref:`String` section **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | +| :ref:`PoolStringArray` | :ref:`get_section_keys` **(** :ref:`String` section **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_sections` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +| :ref:`Variant` | :ref:`get_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | +| :ref:`bool` | :ref:`has_section` **(** :ref:`String` section **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | +| :ref:`bool` | :ref:`has_section_key` **(** :ref:`String` section, :ref:`String` key **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`save` **(** :ref:`String` path **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | +| void | :ref:`set_value` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -This helper class can be used to store :ref:`Variant` values on the filesystem using INI-style formatting. The stored values are identified by a section and a key: +This helper class can be used to store :ref:`Variant` values on the filesystem using INI-style formatting. The stored values are identified by a section and a key: :: @@ -68,60 +67,60 @@ The following example shows how to parse an INI-style file from the system, read # Save the changes by overwriting the previous file config.save("user://settings.cfg") -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ConfigFile_erase_section: -- void **erase_section** **(** :ref:`String` section **)** +- void **erase_section** **(** :ref:`String` section **)** Deletes the specified section along with all the key-value pairs inside. .. _class_ConfigFile_get_section_keys: -- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const +- :ref:`PoolStringArray` **get_section_keys** **(** :ref:`String` section **)** const Returns an array of all defined key identifiers in the specified section. .. _class_ConfigFile_get_sections: -- :ref:`PoolStringArray` **get_sections** **(** **)** const +- :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. .. _class_ConfigFile_get_value: -- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +- :ref:`Variant` **get_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional ``default`` argument, or ``null`` if it is omitted. .. _class_ConfigFile_has_section: -- :ref:`bool` **has_section** **(** :ref:`String` section **)** const +- :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. .. _class_ConfigFile_has_section_key: -- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const +- :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const Returns ``true`` if the specified section-key pair exists. .. _class_ConfigFile_load: -- :ref:`Error` **load** **(** :ref:`String` path **)** +- :ref:`Error` **load** **(** :ref:`String` path **)** -Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. +Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_save: -- :ref:`Error` **save** **(** :ref:`String` path **)** +- :ref:`Error` **save** **(** :ref:`String` path **)** -Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. +Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR_*`` constants listed in :ref:`@GlobalScope`. If the load was successful, the return value is ``OK``. .. _class_ConfigFile_set_value: -- void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** +- void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index f311bccfe..8d39a1939 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -7,10 +7,8 @@ ConfirmationDialog ================== -**Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`ScriptCreateDialog`, :ref:`EditorFileDialog`, :ref:`FileDialog` - +**Inherits:** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ScriptCreateDialog`, :ref:`EditorFileDialog`, :ref:`FileDialog` **Category:** Core Brief Description @@ -18,24 +16,24 @@ Brief Description Dialog for confirmation of actions. -Member Functions ----------------- +Methods +------- +------------------------------+--------------------------------------------------------------------+ -| :ref:`Button` | :ref:`get_cancel` **(** **)** | +| :ref:`Button` | :ref:`get_cancel` **(** **)** | +------------------------------+--------------------------------------------------------------------+ Description ----------- -Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog`, but has by default an OK and Cancel button (in host OS order). +Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog`, but has by default an OK and Cancel button (in host OS order). -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ConfirmationDialog_get_cancel: -- :ref:`Button` **get_cancel** **(** **)** +- :ref:`Button` **get_cancel** **(** **)** Return the cancel button. diff --git a/classes/class_container.rst b/classes/class_container.rst index 98a2c4c72..1608e6466 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -7,10 +7,8 @@ Container ========= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`TabContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`TabContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description Base node for containers. -Member Functions ----------------- +Methods +------- +-------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | +| void | :ref:`fit_child_in_rect` **(** :ref:`Control` child, :ref:`Rect2` rect **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_sort` **(** **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,8 +35,8 @@ Signals Emitted when sorting the children is needed. -Numeric Constants ------------------ +Constants +--------- - **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately. @@ -49,12 +47,12 @@ Base node for containers. A ``Container`` contains other controls and automatica A Control can inherit this to create custom container classes. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Container_fit_child_in_rect: -- void **fit_child_in_rect** **(** :ref:`Control` child, :ref:`Rect2` rect **)** +- void **fit_child_in_rect** **(** :ref:`Control` child, :ref:`Rect2` rect **)** Fit a child control in a given rect. This is mainly a helper for creating custom container classes. diff --git a/classes/class_control.rst b/classes/class_control.rst index 57ac04f5d..4c79b1a9f 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -7,10 +7,8 @@ Control ======= -**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` - +**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core Brief Description @@ -18,131 +16,131 @@ Brief Description All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. -Member Functions ----------------- +Methods +------- +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_clips_input` **(** **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | +| :ref:`Vector2` | :ref:`_get_minimum_size` **(** **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_gui_input` **(** :ref:`InputEvent` event **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | +| :ref:`Object` | :ref:`_make_custom_tooltip` **(** :ref:`String` for_text **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`accept_event` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | +| void | :ref:`add_color_override` **(** :ref:`String` name, :ref:`Color` color **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | +| void | :ref:`add_constant_override` **(** :ref:`String` name, :ref:`int` constant **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | +| void | :ref:`add_font_override` **(** :ref:`String` name, :ref:`Font` font **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | +| void | :ref:`add_icon_override` **(** :ref:`String` name, :ref:`Texture` texture **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | +| void | :ref:`add_shader_override` **(** :ref:`String` name, :ref:`Shader` shader **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | +| void | :ref:`add_stylebox_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +| void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | +| :ref:`Vector2` | :ref:`get_begin` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_combined_minimum_size` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +| :ref:`CursorShape` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | +| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_end` **(** **)** const | +| :ref:`Vector2` | :ref:`get_end` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | +| :ref:`Control` | :ref:`get_focus_owner` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_parent_area_size` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +| :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_click_focus` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_focus` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_color_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_constant_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_focus` **(** **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_font_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_icon_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** virtual | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_shader_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type="" **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_stylebox_override` **(** :ref:`String` name **)** const | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`minimum_size_changed` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`release_focus` **(** **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | +| void | :ref:`set_anchor` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchor_and_margin` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | +| void | :ref:`set_anchor_and_margin` **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | +| void | :ref:`set_anchors_and_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_anchors_preset` **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** | +| void | :ref:`set_anchors_preset` **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | +| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | +| void | :ref:`set_drag_forwarding` **(** :ref:`Control` target **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | +| void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | +| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | +| void | :ref:`set_margins_preset` **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -162,9 +160,9 @@ Emitted when the node loses keyboard focus. .. _class_Control_gui_input: -- **gui_input** **(** :ref:`Object` ev **)** +- **gui_input** **(** :ref:`InputEvent` event **)** -Emitted when the node receives an :ref:`InputEvent`. +Emitted when the node receives an :ref:`InputEvent`. .. _class_Control_minimum_size_changed: @@ -203,169 +201,18 @@ Emitted when the control changes size. Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. -Member Variables ----------------- - - .. _class_Control_anchor_bottom: - -- :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. - - .. _class_Control_anchor_left: - -- :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. - - .. _class_Control_anchor_right: - -- :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. - - .. _class_Control_anchor_top: - -- :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. - - .. _class_Control_focus_mode: - -- :ref:`FocusMode` **focus_mode** - The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. - - .. _class_Control_focus_neighbour_bottom: - -- :ref:`NodePath` **focus_neighbour_bottom** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. - -If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it. - - .. _class_Control_focus_neighbour_left: - -- :ref:`NodePath` **focus_neighbour_left** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the left arrow on the keyboard or left on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. - - .. _class_Control_focus_neighbour_right: - -- :ref:`NodePath` **focus_neighbour_right** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the right arrow on the keyboard or right on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. - - .. _class_Control_focus_neighbour_top: - -- :ref:`NodePath` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. - - .. _class_Control_focus_next: - -- :ref:`NodePath` **focus_next** - - .. _class_Control_focus_previous: - -- :ref:`NodePath` **focus_previous** - - .. _class_Control_grow_horizontal: - -- :ref:`GrowDirection` **grow_horizontal** - - .. _class_Control_grow_vertical: - -- :ref:`GrowDirection` **grow_vertical** - - .. _class_Control_hint_tooltip: - -- :ref:`String` **hint_tooltip** - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. - - .. _class_Control_margin_bottom: - -- :ref:`float` **margin_bottom** - Distance between the node's bottom edge and its parent container, based on :ref:`anchor_bottom`. - -Margins are often controlled by one or multiple parent :ref:`Container` nodes. Margins update automatically when you move or resize the node. - - .. _class_Control_margin_left: - -- :ref:`float` **margin_left** - Distance between the node's left edge and its parent container, based on :ref:`anchor_left`. - - .. _class_Control_margin_right: - -- :ref:`float` **margin_right** - Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. - - .. _class_Control_margin_top: - -- :ref:`float` **margin_top** - Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. - - .. _class_Control_mouse_default_cursor_shape: - -- :ref:`CursorShape` **mouse_default_cursor_shape** - The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. - -**Note:** On Linux, shapes may vary depending on the cursor theme of the system. - - .. _class_Control_mouse_filter: - -- :ref:`MouseFilter` **mouse_filter** - Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. - - .. _class_Control_rect_clip_content: - -- :ref:`bool` **rect_clip_content** - - .. _class_Control_rect_global_position: - -- :ref:`Vector2` **rect_global_position** - The node's global position, relative to the world (usually to the top-left corner of the window). - - .. _class_Control_rect_min_size: - -- :ref:`Vector2` **rect_min_size** - The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. - - .. _class_Control_rect_pivot_offset: - -- :ref:`Vector2` **rect_pivot_offset** - By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. - - .. _class_Control_rect_position: - -- :ref:`Vector2` **rect_position** - The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. - - .. _class_Control_rect_rotation: - -- :ref:`float` **rect_rotation** - The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. - - .. _class_Control_rect_scale: - -- :ref:`Vector2` **rect_scale** - The node's scale, relative to its :ref:`rect_size`. Change this property to scale the node around its :ref:`rect_pivot_offset`. - - .. _class_Control_rect_size: - -- :ref:`Vector2` **rect_size** - The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. - - .. _class_Control_size_flags_horizontal: - -- :ref:`int` **size_flags_horizontal** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. - - .. _class_Control_size_flags_stretch_ratio: - -- :ref:`float` **size_flags_stretch_ratio** - If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. - - .. _class_Control_size_flags_vertical: - -- :ref:`int` **size_flags_vertical** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. - - .. _class_Control_theme: - -- :ref:`Theme` **theme** - Changing this property replaces the current :ref:`Theme` resource this node and all its ``Control`` children use. - - -Numeric Constants ------------------ - -- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. -- **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node. -- **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node. -- **NOTIFICATION_FOCUS_ENTER** = **43** --- Sent when the node grabs focus. -- **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. -- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` -- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. -- **NOTIFICATION_SCROLL_BEGIN** = **47** -- **NOTIFICATION_SCROLL_END** = **48** - -Enums ------ +Enumerations +------------ .. _enum_Control_SizeFlags: enum **SizeFlags** -- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. -- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_FILL** = **1** --- Tells the parent :ref:`Container` to expand the bounds of this node to fill all the available space without pushing any other node. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_EXPAND** = **2** --- Tells the parent :ref:`Container` to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See :ref:`size_flags_stretch_ratio`. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. - **SIZE_EXPAND_FILL** = **3** --- Sets the node's size flags to both fill and expand. See the 2 constants above for more information. -- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. -- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_CENTER** = **4** --- Tells the parent :ref:`Container` to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. +- **SIZE_SHRINK_END** = **8** --- Tells the parent :ref:`Container` to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with :ref:`size_flags_horizontal` and :ref:`size_flags_vertical`. .. _enum_Control_CursorShape: @@ -451,12 +298,25 @@ enum **Anchor** - **ANCHOR_END** = **1** --- Snaps one of the 4 anchor's sides to the end of the node's ``Rect``, in the bottom right. Use it with one of the ``anchor_*`` member variables, like :ref:`anchor_left`. To change all 4 anchors at once, use :ref:`set_anchors_preset`. +Constants +--------- + +- **NOTIFICATION_RESIZED** = **40** --- Sent when the node changes size. Use :ref:`rect_size` to get the new size. +- **NOTIFICATION_MOUSE_ENTER** = **41** --- Sent when the mouse pointer enters the node. +- **NOTIFICATION_MOUSE_EXIT** = **42** --- Sent when the mouse pointer exits the node. +- **NOTIFICATION_FOCUS_ENTER** = **43** --- Sent when the node grabs focus. +- **NOTIFICATION_FOCUS_EXIT** = **44** --- Sent when the node loses focus. +- **NOTIFICATION_THEME_CHANGED** = **45** --- Sent when the node's :ref:`theme` changes, right before Godot redraws the control. Happens when you call one of the ``add_*_override`` +- **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. +- **NOTIFICATION_SCROLL_BEGIN** = **47** +- **NOTIFICATION_SCROLL_END** = **48** + Description ----------- Base class for all User Interface or *UI* related nodes. ``Control`` features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. -For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from ``Control`` and :ref:`Container` nodes. +For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from ``Control`` and :ref:`Container` nodes. **User Interface nodes and input** @@ -466,7 +326,7 @@ Only one ``Control`` node can be in keyboard focus. Only the node in focus will Set :ref:`mouse_filter` to MOUSE_FILTER_IGNORE to tell a ``Control`` node to ignore mouse or touch events. You'll need it if you place an icon on top of a button. -:ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add_*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. +:ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a ``Control`` node, it affects all of its children. To override some of the theme's parameters, call one of the ``add_*_override`` methods, like :ref:`add_font_override`. You can override the theme with the inspector. Tutorials --------- @@ -474,8 +334,146 @@ Tutorials - :doc:`../tutorials/gui/index` - :doc:`../tutorials/2d/custom_drawing_in_2d` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Control_anchor_bottom: + +- :ref:`float` **anchor_bottom** - Anchors the bottom edge of the node to the origin, the center, or the end of its parent container. It changes how the bottom margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_left: + +- :ref:`float` **anchor_left** - Anchors the left edge of the node to the origin, the center or the end of its parent container. It changes how the left margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_right: + +- :ref:`float` **anchor_right** - Anchors the right edge of the node to the origin, the center or the end of its parent container. It changes how the right margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_anchor_top: + +- :ref:`float` **anchor_top** - Anchors the top edge of the node to the origin, the center or the end of its parent container. It changes how the top margin updates when the node moves or changes size. Use one of the ``ANCHOR_*`` constants. Default value: ``ANCHOR_BEGIN``. + + .. _class_Control_focus_mode: + +- :ref:`FocusMode` **focus_mode** - The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals. + + .. _class_Control_focus_neighbour_bottom: + +- :ref:`NodePath` **focus_neighbour_bottom** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the down arrow on the keyboard, or down on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + +If the user presses Tab, Godot will give focus to the closest node to the right first, then to the bottom. If the user presses Shift+Tab, Godot will look to the left of the node, then above it. + + .. _class_Control_focus_neighbour_left: + +- :ref:`NodePath` **focus_neighbour_left** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the left arrow on the keyboard or left on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the left of this one. + + .. _class_Control_focus_neighbour_right: + +- :ref:`NodePath` **focus_neighbour_right** - Tells Godot which node it should give keyboard focus to if the user presses Tab, the right arrow on the keyboard or right on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + + .. _class_Control_focus_neighbour_top: + +- :ref:`NodePath` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one. + + .. _class_Control_focus_next: + +- :ref:`NodePath` **focus_next** + + .. _class_Control_focus_previous: + +- :ref:`NodePath` **focus_previous** + + .. _class_Control_grow_horizontal: + +- :ref:`GrowDirection` **grow_horizontal** + + .. _class_Control_grow_vertical: + +- :ref:`GrowDirection` **grow_vertical** + + .. _class_Control_hint_tooltip: + +- :ref:`String` **hint_tooltip** - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. + + .. _class_Control_margin_bottom: + +- :ref:`float` **margin_bottom** - Distance between the node's bottom edge and its parent container, based on :ref:`anchor_bottom`. + +Margins are often controlled by one or multiple parent :ref:`Container` nodes. Margins update automatically when you move or resize the node. + + .. _class_Control_margin_left: + +- :ref:`float` **margin_left** - Distance between the node's left edge and its parent container, based on :ref:`anchor_left`. + + .. _class_Control_margin_right: + +- :ref:`float` **margin_right** - Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. + + .. _class_Control_margin_top: + +- :ref:`float` **margin_top** - Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. + + .. _class_Control_mouse_default_cursor_shape: + +- :ref:`CursorShape` **mouse_default_cursor_shape** - The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. + +**Note:** On Linux, shapes may vary depending on the cursor theme of the system. + + .. _class_Control_mouse_filter: + +- :ref:`MouseFilter` **mouse_filter** - Controls whether the control will be able to receive mouse button input events through :ref:`_gui_input` and how these events should be handled. Use one of the ``MOUSE_FILTER_*`` constants. See the constants to learn what each does. + + .. _class_Control_rect_clip_content: + +- :ref:`bool` **rect_clip_content** + + .. _class_Control_rect_global_position: + +- :ref:`Vector2` **rect_global_position** - The node's global position, relative to the world (usually to the top-left corner of the window). + + .. _class_Control_rect_min_size: + +- :ref:`Vector2` **rect_min_size** - The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes. + + .. _class_Control_rect_pivot_offset: + +- :ref:`Vector2` **rect_pivot_offset** - By default, the node's pivot is its top-left corner. When you change its :ref:`rect_scale`, it will scale around this pivot. Set this property to :ref:`rect_size` / 2 to center the pivot in the node's rectangle. + + .. _class_Control_rect_position: + +- :ref:`Vector2` **rect_position** - The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by :ref:`rect_pivot_offset`. + + .. _class_Control_rect_rotation: + +- :ref:`float` **rect_rotation** - The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. + + .. _class_Control_rect_scale: + +- :ref:`Vector2` **rect_scale** - The node's scale, relative to its :ref:`rect_size`. Change this property to scale the node around its :ref:`rect_pivot_offset`. + + .. _class_Control_rect_size: + +- :ref:`Vector2` **rect_size** - The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. + + .. _class_Control_size_flags_horizontal: + +- :ref:`int` **size_flags_horizontal** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the X axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. + + .. _class_Control_size_flags_stretch_ratio: + +- :ref:`float` **size_flags_stretch_ratio** - If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size flag, the parent :ref:`Container` will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space. + + .. _class_Control_size_flags_vertical: + +- :ref:`int` **size_flags_vertical** - Tells the parent :ref:`Container` nodes how they should resize and place the node on the Y axis. Use one of the ``SIZE_*`` constants to change the flags. See the constants to learn what each does. + + .. _class_Control_theme: + +- :ref:`Theme` **theme** - Changing this property replaces the current :ref:`Theme` resource this node and all its ``Control`` children use. + + +Method Descriptions +------------------- .. _class_Control__clips_input: @@ -483,21 +481,21 @@ Member Function Description .. _class_Control__get_minimum_size: -- :ref:`Vector2` **_get_minimum_size** **(** **)** virtual +- :ref:`Vector2` **_get_minimum_size** **(** **)** virtual Returns the minimum size for this control. See :ref:`rect_min_size`. .. _class_Control__gui_input: -- void **_gui_input** **(** :ref:`InputEvent` event **)** virtual +- void **_gui_input** **(** :ref:`InputEvent` event **)** virtual -The node's parent forwards input events to this method. Use it to process and accept inputs on UI elements. See :ref:`accept_event`. +Use this method to process and accept inputs on UI elements. See :ref:`accept_event`. Replaces Godot 2's ``_input_event``. .. _class_Control__make_custom_tooltip: -- :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual +- :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual .. _class_Control_accept_event: @@ -507,43 +505,43 @@ Marks an input event as handled. Once you accept an input event, it stops propag .. _class_Control_add_color_override: -- void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** +- void **add_color_override** **(** :ref:`String` name, :ref:`Color` color **)** Overrides the color in the :ref:`theme` resource the node uses. .. _class_Control_add_constant_override: -- void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** +- void **add_constant_override** **(** :ref:`String` name, :ref:`int` constant **)** Overrides an integer constant in the :ref:`theme` resource the node uses. If the ``constant`` is invalid, Godot clears the override. See :ref:`Theme.INVALID_CONSTANT` for more information. .. _class_Control_add_font_override: -- void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** +- void **add_font_override** **(** :ref:`String` name, :ref:`Font` font **)** Overrides the ``name`` font in the :ref:`theme` resource the node uses. If ``font`` is empty, Godot clears the override. .. _class_Control_add_icon_override: -- void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** +- void **add_icon_override** **(** :ref:`String` name, :ref:`Texture` texture **)** Overrides the ``name`` icon in the :ref:`theme` resource the node uses. If ``icon`` is empty, Godot clears the override. .. _class_Control_add_shader_override: -- void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** +- void **add_shader_override** **(** :ref:`String` name, :ref:`Shader` shader **)** Overrides the ``name`` shader in the :ref:`theme` resource the node uses. If ``shader`` is empty, Godot clears the override. .. _class_Control_add_stylebox_override: -- void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** +- void **add_stylebox_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** Overrides the ``name`` Stylebox in the :ref:`theme` resource the node uses. If ``stylebox`` is empty, Godot clears the override. .. _class_Control_can_drop_data: -- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual Godot calls this method to test if ``data`` from a control's :ref:`get_drag_data` can be dropped at ``position``. ``position`` is local to this control. @@ -560,7 +558,7 @@ This method should only be used to test the data. Process the data in :ref:`drop .. _class_Control_drop_data: -- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual +- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag_data` result. Godot first calls :ref:`can_drop_data` to test if ``data`` is allowed to drop at ``position`` where ``position`` is local to this control. @@ -576,7 +574,7 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag .. _class_Control_force_drag: -- void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** +- void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** Forces drag and bypasses :ref:`get_drag_data` and :ref:`set_drag_preview` by passing ``data`` and ``preview``. Drag will start even if the mouse is neither over nor pressed on this control. @@ -584,31 +582,31 @@ The methods :ref:`can_drop_data` and :ref:`drop_dat .. _class_Control_get_begin: -- :ref:`Vector2` **get_begin** **(** **)** const +- :ref:`Vector2` **get_begin** **(** **)** const Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. .. _class_Control_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_combined_minimum_size: -- :ref:`Vector2` **get_combined_minimum_size** **(** **)** const +- :ref:`Vector2` **get_combined_minimum_size** **(** **)** const .. _class_Control_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_cursor_shape: -- :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const +- :ref:`CursorShape` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const -Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. +Returns the mouse cursor shape the control displays on mouse hover. See :ref:`CursorShape`. .. _class_Control_get_drag_data: -- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual +- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement :ref:`can_drop_data` and :ref:`drop_data`. ``position`` is local to this control. Drag may be forced with :ref:`force_drag`. @@ -625,51 +623,51 @@ A preview that will follow the mouse that should represent the data can be set w .. _class_Control_get_end: -- :ref:`Vector2` **get_end** **(** **)** const +- :ref:`Vector2` **get_end** **(** **)** const Returns :ref:`margin_right` and :ref:`margin_bottom`. .. _class_Control_get_focus_owner: -- :ref:`Control` **get_focus_owner** **(** **)** const +- :ref:`Control` **get_focus_owner** **(** **)** const Returns the control that has the keyboard focus or ``null`` if none. .. _class_Control_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_global_rect: -- :ref:`Rect2` **get_global_rect** **(** **)** const +- :ref:`Rect2` **get_global_rect** **(** **)** const Returns the position and size of the control relative to the top-left corner of the screen. See :ref:`rect_position` and :ref:`rect_size`. .. _class_Control_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_minimum_size: -- :ref:`Vector2` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** const Returns the minimum size for this control. See :ref:`rect_min_size`. .. _class_Control_get_parent_area_size: -- :ref:`Vector2` **get_parent_area_size** **(** **)** const +- :ref:`Vector2` **get_parent_area_size** **(** **)** const Returns the width/height occupied in the parent control. .. _class_Control_get_parent_control: -- :ref:`Control` **get_parent_control** **(** **)** const +- :ref:`Control` **get_parent_control** **(** **)** const Returns the parent control node. .. _class_Control_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** const Returns the position and size of the control relative to the top-left corner of the parent Control. See :ref:`rect_position` and :ref:`rect_size`. @@ -681,11 +679,11 @@ Returns the rotation (in radians). .. _class_Control_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const Returns the tooltip, which will appear when the cursor is resting over this control. @@ -701,19 +699,19 @@ Steal the focus from another control and become the focused control (see :ref:`s .. _class_Control_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_color_override: -- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const .. _class_Control_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_constant_override: -- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const .. _class_Control_has_focus: @@ -723,35 +721,35 @@ Returns ``true`` if this is the current focused control. See :ref:`focus_mode` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_font_override: -- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const .. _class_Control_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_icon_override: -- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const .. _class_Control_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual .. _class_Control_has_shader_override: -- :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const .. _class_Control_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const .. _class_Control_has_stylebox_override: -- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const +- :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const .. _class_Control_minimum_size_changed: @@ -765,29 +763,29 @@ Give up the focus. No other control will be able to receive keyboard input. .. _class_Control_set_anchor: -- void **set_anchor** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** +- void **set_anchor** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`bool` keep_margin=false, :ref:`bool` push_opposite_anchor=true **)** .. _class_Control_set_anchor_and_margin: -- void **set_anchor_and_margin** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** +- void **set_anchor_and_margin** **(** :ref:`Margin` margin, :ref:`float` anchor, :ref:`float` offset, :ref:`bool` push_opposite_anchor=false **)** .. _class_Control_set_anchors_and_margins_preset: -- void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +- void **set_anchors_and_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** .. _class_Control_set_anchors_preset: -- void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** +- void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** .. _class_Control_set_begin: -- void **set_begin** **(** :ref:`Vector2` position **)** +- void **set_begin** **(** :ref:`Vector2` position **)** Sets :ref:`margin_left` and :ref:`margin_top` at the same time. .. _class_Control_set_drag_forwarding: -- void **set_drag_forwarding** **(** :ref:`Control` target **)** +- void **set_drag_forwarding** **(** :ref:`Control` target **)** Forwards the handling of this control's drag and drop to ``target`` control. @@ -818,19 +816,19 @@ Forwarding can be implemented in the target control similar to the methods :ref: .. _class_Control_set_drag_preview: -- void **set_drag_preview** **(** :ref:`Control` control **)** +- void **set_drag_preview** **(** :ref:`Control` control **)** Shows the given control at the mouse pointer. A good time to call this method is in :ref:`get_drag_data`. .. _class_Control_set_end: -- void **set_end** **(** :ref:`Vector2` position **)** +- void **set_end** **(** :ref:`Vector2` position **)** Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. .. _class_Control_set_margins_preset: -- void **set_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** +- void **set_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** .. _class_Control_set_rotation: @@ -846,6 +844,6 @@ Displays a control as modal. Control must be a subwindow. Modal controls capture .. _class_Control_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_position **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index cffac7c3f..a659e2fdb 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -7,8 +7,7 @@ ConvexPolygonShape ================== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Convex polygon shape for 3D physics. -Member Variables ----------------- - - .. _class_ConvexPolygonShape_points: - -- :ref:`PoolVector3Array` **points** - The list of 3D points forming the convex polygon shape. - - Description ----------- -Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` or area. +Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` or area. + +Property Descriptions +--------------------- + + .. _class_ConvexPolygonShape_points: + +- :ref:`PoolVector3Array` **points** - The list of 3D points forming the convex polygon shape. + diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index fb9736971..42463c4c1 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -7,8 +7,7 @@ ConvexPolygonShape2D ==================== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,34 +15,34 @@ Brief Description Convex Polygon Shape for 2D physics. -Member Functions ----------------- +Methods +------- +-------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | +| void | :ref:`set_point_cloud` **(** :ref:`PoolVector2Array` point_cloud **)** | +-------+--------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ConvexPolygonShape2D_points: - -- :ref:`PoolVector2Array` **points** - The polygon's list of vertices. Can be in either clockwise or counterclockwise order. - - Description ----------- Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). -The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygonShape2D` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. +The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygonShape2D` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ConvexPolygonShape2D_points: + +- :ref:`PoolVector2Array` **points** - The polygon's list of vertices. Can be in either clockwise or counterclockwise order. + + +Method Descriptions +------------------- .. _class_ConvexPolygonShape2D_set_point_cloud: -- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** +- void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** Currently, this method does nothing. diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index 0f9d7915c..fe49fbfc9 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -7,8 +7,7 @@ CPUParticles ============ -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,261 +15,17 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | +| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | +-------+------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +-------+------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_CPUParticles_amount: - -- :ref:`int` **amount** - - .. _class_CPUParticles_angle: - -- :ref:`float` **angle** - - .. _class_CPUParticles_angle_curve: - -- :ref:`Curve` **angle_curve** - - .. _class_CPUParticles_angle_random: - -- :ref:`float` **angle_random** - - .. _class_CPUParticles_angular_velocity: - -- :ref:`float` **angular_velocity** - - .. _class_CPUParticles_angular_velocity_curve: - -- :ref:`Curve` **angular_velocity_curve** - - .. _class_CPUParticles_angular_velocity_random: - -- :ref:`float` **angular_velocity_random** - - .. _class_CPUParticles_anim_loop: - -- :ref:`bool` **anim_loop** - - .. _class_CPUParticles_anim_offset: - -- :ref:`float` **anim_offset** - - .. _class_CPUParticles_anim_offset_curve: - -- :ref:`Curve` **anim_offset_curve** - - .. _class_CPUParticles_anim_offset_random: - -- :ref:`float` **anim_offset_random** - - .. _class_CPUParticles_anim_speed: - -- :ref:`float` **anim_speed** - - .. _class_CPUParticles_anim_speed_curve: - -- :ref:`Curve` **anim_speed_curve** - - .. _class_CPUParticles_anim_speed_random: - -- :ref:`float` **anim_speed_random** - - .. _class_CPUParticles_color: - -- :ref:`Color` **color** - - .. _class_CPUParticles_color_ramp: - -- :ref:`Gradient` **color_ramp** - - .. _class_CPUParticles_damping: - -- :ref:`float` **damping** - - .. _class_CPUParticles_damping_curve: - -- :ref:`Curve` **damping_curve** - - .. _class_CPUParticles_damping_random: - -- :ref:`float` **damping_random** - - .. _class_CPUParticles_draw_order: - -- :ref:`DrawOrder` **draw_order** - - .. _class_CPUParticles_emission_box_extents: - -- :ref:`Vector3` **emission_box_extents** - - .. _class_CPUParticles_emission_colors: - -- :ref:`PoolColorArray` **emission_colors** - - .. _class_CPUParticles_emission_normals: - -- :ref:`PoolVector3Array` **emission_normals** - - .. _class_CPUParticles_emission_points: - -- :ref:`PoolVector3Array` **emission_points** - - .. _class_CPUParticles_emission_shape: - -- :ref:`EmissionShape` **emission_shape** - - .. _class_CPUParticles_emission_sphere_radius: - -- :ref:`float` **emission_sphere_radius** - - .. _class_CPUParticles_emitting: - -- :ref:`bool` **emitting** - - .. _class_CPUParticles_explosiveness: - -- :ref:`float` **explosiveness** - - .. _class_CPUParticles_fixed_fps: - -- :ref:`int` **fixed_fps** - - .. _class_CPUParticles_flag_align_y: - -- :ref:`bool` **flag_align_y** - - .. _class_CPUParticles_flag_disable_z: - -- :ref:`bool` **flag_disable_z** - - .. _class_CPUParticles_flag_rotate_y: - -- :ref:`bool` **flag_rotate_y** - - .. _class_CPUParticles_flatness: - -- :ref:`float` **flatness** - - .. _class_CPUParticles_fract_delta: - -- :ref:`bool` **fract_delta** - - .. _class_CPUParticles_gravity: - -- :ref:`Vector3` **gravity** - - .. _class_CPUParticles_hue_variation: - -- :ref:`float` **hue_variation** - - .. _class_CPUParticles_hue_variation_curve: - -- :ref:`Curve` **hue_variation_curve** - - .. _class_CPUParticles_hue_variation_random: - -- :ref:`float` **hue_variation_random** - - .. _class_CPUParticles_initial_velocity: - -- :ref:`float` **initial_velocity** - - .. _class_CPUParticles_initial_velocity_random: - -- :ref:`float` **initial_velocity_random** - - .. _class_CPUParticles_lifetime: - -- :ref:`float` **lifetime** - - .. _class_CPUParticles_linear_accel: - -- :ref:`float` **linear_accel** - - .. _class_CPUParticles_linear_accel_curve: - -- :ref:`Curve` **linear_accel_curve** - - .. _class_CPUParticles_linear_accel_random: - -- :ref:`float` **linear_accel_random** - - .. _class_CPUParticles_local_coords: - -- :ref:`bool` **local_coords** - - .. _class_CPUParticles_mesh: - -- :ref:`Mesh` **mesh** - - .. _class_CPUParticles_one_shot: - -- :ref:`bool` **one_shot** - - .. _class_CPUParticles_preprocess: - -- :ref:`float` **preprocess** - - .. _class_CPUParticles_radial_accel: - -- :ref:`float` **radial_accel** - - .. _class_CPUParticles_radial_accel_curve: - -- :ref:`Curve` **radial_accel_curve** - - .. _class_CPUParticles_radial_accel_random: - -- :ref:`float` **radial_accel_random** - - .. _class_CPUParticles_randomness: - -- :ref:`float` **randomness** - - .. _class_CPUParticles_scale: - -- :ref:`float` **scale** - - .. _class_CPUParticles_scale_curve: - -- :ref:`Curve` **scale_curve** - - .. _class_CPUParticles_scale_random: - -- :ref:`float` **scale_random** - - .. _class_CPUParticles_speed_scale: - -- :ref:`float` **speed_scale** - - .. _class_CPUParticles_spread: - -- :ref:`float` **spread** - - .. _class_CPUParticles_tangential_accel: - -- :ref:`float` **tangential_accel** - - .. _class_CPUParticles_tangential_accel_curve: - -- :ref:`Curve` **tangential_accel_curve** - - .. _class_CPUParticles_tangential_accel_random: - -- :ref:`float` **tangential_accel_random** - - -Enums ------ +Enumerations +------------ .. _enum_CPUParticles_Flags: @@ -316,12 +71,256 @@ enum **DrawOrder** - **DRAW_ORDER_VIEW_DEPTH** = **2** -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_CPUParticles_amount: + +- :ref:`int` **amount** + + .. _class_CPUParticles_angle: + +- :ref:`float` **angle** + + .. _class_CPUParticles_angle_curve: + +- :ref:`Curve` **angle_curve** + + .. _class_CPUParticles_angle_random: + +- :ref:`float` **angle_random** + + .. _class_CPUParticles_angular_velocity: + +- :ref:`float` **angular_velocity** + + .. _class_CPUParticles_angular_velocity_curve: + +- :ref:`Curve` **angular_velocity_curve** + + .. _class_CPUParticles_angular_velocity_random: + +- :ref:`float` **angular_velocity_random** + + .. _class_CPUParticles_anim_loop: + +- :ref:`bool` **anim_loop** + + .. _class_CPUParticles_anim_offset: + +- :ref:`float` **anim_offset** + + .. _class_CPUParticles_anim_offset_curve: + +- :ref:`Curve` **anim_offset_curve** + + .. _class_CPUParticles_anim_offset_random: + +- :ref:`float` **anim_offset_random** + + .. _class_CPUParticles_anim_speed: + +- :ref:`float` **anim_speed** + + .. _class_CPUParticles_anim_speed_curve: + +- :ref:`Curve` **anim_speed_curve** + + .. _class_CPUParticles_anim_speed_random: + +- :ref:`float` **anim_speed_random** + + .. _class_CPUParticles_color: + +- :ref:`Color` **color** + + .. _class_CPUParticles_color_ramp: + +- :ref:`Gradient` **color_ramp** + + .. _class_CPUParticles_damping: + +- :ref:`float` **damping** + + .. _class_CPUParticles_damping_curve: + +- :ref:`Curve` **damping_curve** + + .. _class_CPUParticles_damping_random: + +- :ref:`float` **damping_random** + + .. _class_CPUParticles_draw_order: + +- :ref:`DrawOrder` **draw_order** + + .. _class_CPUParticles_emission_box_extents: + +- :ref:`Vector3` **emission_box_extents** + + .. _class_CPUParticles_emission_colors: + +- :ref:`PoolColorArray` **emission_colors** + + .. _class_CPUParticles_emission_normals: + +- :ref:`PoolVector3Array` **emission_normals** + + .. _class_CPUParticles_emission_points: + +- :ref:`PoolVector3Array` **emission_points** + + .. _class_CPUParticles_emission_shape: + +- :ref:`EmissionShape` **emission_shape** + + .. _class_CPUParticles_emission_sphere_radius: + +- :ref:`float` **emission_sphere_radius** + + .. _class_CPUParticles_emitting: + +- :ref:`bool` **emitting** + + .. _class_CPUParticles_explosiveness: + +- :ref:`float` **explosiveness** + + .. _class_CPUParticles_fixed_fps: + +- :ref:`int` **fixed_fps** + + .. _class_CPUParticles_flag_align_y: + +- :ref:`bool` **flag_align_y** + + .. _class_CPUParticles_flag_disable_z: + +- :ref:`bool` **flag_disable_z** + + .. _class_CPUParticles_flag_rotate_y: + +- :ref:`bool` **flag_rotate_y** + + .. _class_CPUParticles_flatness: + +- :ref:`float` **flatness** + + .. _class_CPUParticles_fract_delta: + +- :ref:`bool` **fract_delta** + + .. _class_CPUParticles_gravity: + +- :ref:`Vector3` **gravity** + + .. _class_CPUParticles_hue_variation: + +- :ref:`float` **hue_variation** + + .. _class_CPUParticles_hue_variation_curve: + +- :ref:`Curve` **hue_variation_curve** + + .. _class_CPUParticles_hue_variation_random: + +- :ref:`float` **hue_variation_random** + + .. _class_CPUParticles_initial_velocity: + +- :ref:`float` **initial_velocity** + + .. _class_CPUParticles_initial_velocity_random: + +- :ref:`float` **initial_velocity_random** + + .. _class_CPUParticles_lifetime: + +- :ref:`float` **lifetime** + + .. _class_CPUParticles_linear_accel: + +- :ref:`float` **linear_accel** + + .. _class_CPUParticles_linear_accel_curve: + +- :ref:`Curve` **linear_accel_curve** + + .. _class_CPUParticles_linear_accel_random: + +- :ref:`float` **linear_accel_random** + + .. _class_CPUParticles_local_coords: + +- :ref:`bool` **local_coords** + + .. _class_CPUParticles_mesh: + +- :ref:`Mesh` **mesh** + + .. _class_CPUParticles_one_shot: + +- :ref:`bool` **one_shot** + + .. _class_CPUParticles_preprocess: + +- :ref:`float` **preprocess** + + .. _class_CPUParticles_radial_accel: + +- :ref:`float` **radial_accel** + + .. _class_CPUParticles_radial_accel_curve: + +- :ref:`Curve` **radial_accel_curve** + + .. _class_CPUParticles_radial_accel_random: + +- :ref:`float` **radial_accel_random** + + .. _class_CPUParticles_randomness: + +- :ref:`float` **randomness** + + .. _class_CPUParticles_scale: + +- :ref:`float` **scale** + + .. _class_CPUParticles_scale_curve: + +- :ref:`Curve` **scale_curve** + + .. _class_CPUParticles_scale_random: + +- :ref:`float` **scale_random** + + .. _class_CPUParticles_speed_scale: + +- :ref:`float` **speed_scale** + + .. _class_CPUParticles_spread: + +- :ref:`float` **spread** + + .. _class_CPUParticles_tangential_accel: + +- :ref:`float` **tangential_accel** + + .. _class_CPUParticles_tangential_accel_curve: + +- :ref:`Curve` **tangential_accel_curve** + + .. _class_CPUParticles_tangential_accel_random: + +- :ref:`float` **tangential_accel_random** + + +Method Descriptions +------------------- .. _class_CPUParticles_convert_from_particles: -- void **convert_from_particles** **(** :ref:`Node` particles **)** +- void **convert_from_particles** **(** :ref:`Node` particles **)** .. _class_CPUParticles_restart: diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst new file mode 100644 index 000000000..2be52e008 --- /dev/null +++ b/classes/class_cpuparticles2d.rst @@ -0,0 +1,324 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the CPUParticles2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_CPUParticles2D: + +CPUParticles2D +============== + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert_from_particles` **(** :ref:`Node` particles **)** | ++-------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++-------+--------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + + .. _enum_CPUParticles2D_Flags: + +enum **Flags** + +- **FLAG_ALIGN_Y_TO_VELOCITY** = **0** +- **FLAG_MAX** = **2** + + .. _enum_CPUParticles2D_Parameter: + +enum **Parameter** + +- **PARAM_INITIAL_LINEAR_VELOCITY** = **0** +- **PARAM_ANGULAR_VELOCITY** = **1** +- **PARAM_ORBIT_VELOCITY** = **2** +- **PARAM_LINEAR_ACCEL** = **3** +- **PARAM_RADIAL_ACCEL** = **4** +- **PARAM_TANGENTIAL_ACCEL** = **5** +- **PARAM_DAMPING** = **6** +- **PARAM_ANGLE** = **7** +- **PARAM_SCALE** = **8** +- **PARAM_HUE_VARIATION** = **9** +- **PARAM_ANIM_SPEED** = **10** +- **PARAM_ANIM_OFFSET** = **11** +- **PARAM_MAX** = **12** + + .. _enum_CPUParticles2D_EmissionShape: + +enum **EmissionShape** + +- **EMISSION_SHAPE_POINT** = **0** +- **EMISSION_SHAPE_CIRCLE** = **1** +- **EMISSION_SHAPE_RECTANGLE** = **2** +- **EMISSION_SHAPE_POINTS** = **3** +- **EMISSION_SHAPE_DIRECTED_POINTS** = **4** + + .. _enum_CPUParticles2D_DrawOrder: + +enum **DrawOrder** + +- **DRAW_ORDER_INDEX** = **0** +- **DRAW_ORDER_LIFETIME** = **1** + + +Property Descriptions +--------------------- + + .. _class_CPUParticles2D_amount: + +- :ref:`int` **amount** + + .. _class_CPUParticles2D_angle: + +- :ref:`float` **angle** + + .. _class_CPUParticles2D_angle_curve: + +- :ref:`Curve` **angle_curve** + + .. _class_CPUParticles2D_angle_random: + +- :ref:`float` **angle_random** + + .. _class_CPUParticles2D_angular_velocity: + +- :ref:`float` **angular_velocity** + + .. _class_CPUParticles2D_angular_velocity_curve: + +- :ref:`Curve` **angular_velocity_curve** + + .. _class_CPUParticles2D_angular_velocity_random: + +- :ref:`float` **angular_velocity_random** + + .. _class_CPUParticles2D_anim_loop: + +- :ref:`bool` **anim_loop** + + .. _class_CPUParticles2D_anim_offset: + +- :ref:`float` **anim_offset** + + .. _class_CPUParticles2D_anim_offset_curve: + +- :ref:`Curve` **anim_offset_curve** + + .. _class_CPUParticles2D_anim_offset_random: + +- :ref:`float` **anim_offset_random** + + .. _class_CPUParticles2D_anim_speed: + +- :ref:`float` **anim_speed** + + .. _class_CPUParticles2D_anim_speed_curve: + +- :ref:`Curve` **anim_speed_curve** + + .. _class_CPUParticles2D_anim_speed_random: + +- :ref:`float` **anim_speed_random** + + .. _class_CPUParticles2D_color: + +- :ref:`Color` **color** + + .. _class_CPUParticles2D_color_ramp: + +- :ref:`Gradient` **color_ramp** + + .. _class_CPUParticles2D_damping: + +- :ref:`float` **damping** + + .. _class_CPUParticles2D_damping_curve: + +- :ref:`Curve` **damping_curve** + + .. _class_CPUParticles2D_damping_random: + +- :ref:`float` **damping_random** + + .. _class_CPUParticles2D_draw_order: + +- :ref:`DrawOrder` **draw_order** + + .. _class_CPUParticles2D_emission_colors: + +- :ref:`PoolColorArray` **emission_colors** + + .. _class_CPUParticles2D_emission_normals: + +- :ref:`PoolVector2Array` **emission_normals** + + .. _class_CPUParticles2D_emission_points: + +- :ref:`PoolVector2Array` **emission_points** + + .. _class_CPUParticles2D_emission_rect_extents: + +- :ref:`Vector2` **emission_rect_extents** + + .. _class_CPUParticles2D_emission_shape: + +- :ref:`EmissionShape` **emission_shape** + + .. _class_CPUParticles2D_emission_sphere_radius: + +- :ref:`float` **emission_sphere_radius** + + .. _class_CPUParticles2D_emitting: + +- :ref:`bool` **emitting** + + .. _class_CPUParticles2D_explosiveness: + +- :ref:`float` **explosiveness** + + .. _class_CPUParticles2D_fixed_fps: + +- :ref:`int` **fixed_fps** + + .. _class_CPUParticles2D_flag_align_y: + +- :ref:`bool` **flag_align_y** + + .. _class_CPUParticles2D_flatness: + +- :ref:`float` **flatness** + + .. _class_CPUParticles2D_fract_delta: + +- :ref:`bool` **fract_delta** + + .. _class_CPUParticles2D_gravity: + +- :ref:`Vector2` **gravity** + + .. _class_CPUParticles2D_hue_variation: + +- :ref:`float` **hue_variation** + + .. _class_CPUParticles2D_hue_variation_curve: + +- :ref:`Curve` **hue_variation_curve** + + .. _class_CPUParticles2D_hue_variation_random: + +- :ref:`float` **hue_variation_random** + + .. _class_CPUParticles2D_initial_velocity: + +- :ref:`float` **initial_velocity** + + .. _class_CPUParticles2D_initial_velocity_random: + +- :ref:`float` **initial_velocity_random** + + .. _class_CPUParticles2D_lifetime: + +- :ref:`float` **lifetime** + + .. _class_CPUParticles2D_linear_accel: + +- :ref:`float` **linear_accel** + + .. _class_CPUParticles2D_linear_accel_curve: + +- :ref:`Curve` **linear_accel_curve** + + .. _class_CPUParticles2D_linear_accel_random: + +- :ref:`float` **linear_accel_random** + + .. _class_CPUParticles2D_local_coords: + +- :ref:`bool` **local_coords** + + .. _class_CPUParticles2D_normalmap: + +- :ref:`Texture` **normalmap** + + .. _class_CPUParticles2D_one_shot: + +- :ref:`bool` **one_shot** + + .. _class_CPUParticles2D_preprocess: + +- :ref:`float` **preprocess** + + .. _class_CPUParticles2D_radial_accel: + +- :ref:`float` **radial_accel** + + .. _class_CPUParticles2D_radial_accel_curve: + +- :ref:`Curve` **radial_accel_curve** + + .. _class_CPUParticles2D_radial_accel_random: + +- :ref:`float` **radial_accel_random** + + .. _class_CPUParticles2D_randomness: + +- :ref:`float` **randomness** + + .. _class_CPUParticles2D_scale: + +- :ref:`float` **scale** + + .. _class_CPUParticles2D_scale_curve: + +- :ref:`Curve` **scale_curve** + + .. _class_CPUParticles2D_scale_random: + +- :ref:`float` **scale_random** + + .. _class_CPUParticles2D_speed_scale: + +- :ref:`float` **speed_scale** + + .. _class_CPUParticles2D_spread: + +- :ref:`float` **spread** + + .. _class_CPUParticles2D_tangential_accel: + +- :ref:`float` **tangential_accel** + + .. _class_CPUParticles2D_tangential_accel_curve: + +- :ref:`Curve` **tangential_accel_curve** + + .. _class_CPUParticles2D_tangential_accel_random: + +- :ref:`float` **tangential_accel_random** + + .. _class_CPUParticles2D_texture: + +- :ref:`Texture` **texture** + + +Method Descriptions +------------------- + +.. _class_CPUParticles2D_convert_from_particles: + +- void **convert_from_particles** **(** :ref:`Node` particles **)** + +.. _class_CPUParticles2D_restart: + +- void **restart** **(** **)** + + diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 739c533d7..96e695192 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -7,8 +7,7 @@ CSGBox ====== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description A CSG Box shape. -Member Variables ----------------- +Description +----------- + +This node allows you to create a box for use with the CSG system. + +Property Descriptions +--------------------- .. _class_CSGBox_depth: @@ -29,15 +33,10 @@ Member Variables .. _class_CSGBox_material: -- :ref:`Material` **material** - The material used to render the box. +- :ref:`Material` **material** - The material used to render the box. .. _class_CSGBox_width: - :ref:`float` **width** - Width of the box measured from the center of the box. -Description ------------ - -This node allows you to create a box for use with the CSG system. - diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index 18008db3b..48db2547b 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -7,8 +7,7 @@ CSGCombiner =========== -**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index f00c90fb8..94cdfa7b6 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -7,8 +7,7 @@ CSGCylinder =========== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description A CSG Cylinder shape. -Member Variables ----------------- +Description +----------- + +This node allows you to create a cylinder (or cone) for use with the CSG system. + +Property Descriptions +--------------------- .. _class_CSGCylinder_cone: @@ -29,7 +33,7 @@ Member Variables .. _class_CSGCylinder_material: -- :ref:`Material` **material** - The material used to render the cylinder. +- :ref:`Material` **material** - The material used to render the cylinder. .. _class_CSGCylinder_radius: @@ -44,8 +48,3 @@ Member Variables - :ref:`bool` **smooth_faces** - If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look. -Description ------------ - -This node allows you to create a cylinder (or cone) for use with the CSG system. - diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index ea3c7c50f..4808aafec 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -7,8 +7,7 @@ CSGMesh ======= -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description A CSG Mesh shape that uses a mesh resource. -Member Variables ----------------- - - .. _class_CSGMesh_mesh: - -- :ref:`Mesh` **mesh** - The mesh resource to use as a CSG shape. - - Description ----------- This CSG node allows you to use any mesh resource as a CSG shape provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces. +Property Descriptions +--------------------- + + .. _class_CSGMesh_mesh: + +- :ref:`Mesh` **mesh** - The mesh resource to use as a CSG shape. + + diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 4d9fc17c2..54d7fccc6 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -7,8 +7,7 @@ CSGPolygon ========== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,33 @@ Brief Description Extrudes a 2D polygon shape to create a 3D mesh. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_CSGPolygon_Mode: + +enum **Mode** + +- **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. +- **MODE_SPIN** = **1** --- Shape is extruded by rotating it around an axis. +- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. + + .. _enum_CSGPolygon_PathRotation: + +enum **PathRotation** + +- **PATH_ROTATION_POLYGON** = **0** --- Slice is not rotated. +- **PATH_ROTATION_PATH** = **1** --- Slice is rotated around the up vector of the path. +- **PATH_ROTATION_PATH_FOLLOW** = **2** --- Slice is rotate to match the path exactly. + + +Description +----------- + +This node takes a 2D polygon shape and extrudes it to create a 3D mesh. + +Property Descriptions +--------------------- .. _class_CSGPolygon_depth: @@ -25,11 +49,11 @@ Member Variables .. _class_CSGPolygon_material: -- :ref:`Material` **material** - Material to use for the resulting mesh. +- :ref:`Material` **material** - Material to use for the resulting mesh. .. _class_CSGPolygon_mode: -- :ref:`Mode` **mode** - Extrusion mode. +- :ref:`Mode` **mode** - Extrusion mode. .. _class_CSGPolygon_path_continuous_u: @@ -49,15 +73,15 @@ Member Variables .. _class_CSGPolygon_path_node: -- :ref:`NodePath` **path_node** - The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. +- :ref:`NodePath` **path_node** - The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_path_rotation: -- :ref:`PathRotation` **path_rotation** - The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. +- :ref:`PathRotation` **path_rotation** - The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. .. _class_CSGPolygon_polygon: -- :ref:`PoolVector2Array` **polygon** - Point array that defines the shape that we'll extrude. +- :ref:`PoolVector2Array` **polygon** - Point array that defines the shape that we'll extrude. .. _class_CSGPolygon_smooth_faces: @@ -72,28 +96,3 @@ Member Variables - :ref:`int` **spin_sides** - Number of extrusion when :ref:`mode` is constant MODE_SPIN. -Enums ------ - - .. _enum_CSGPolygon_Mode: - -enum **Mode** - -- **MODE_DEPTH** = **0** --- Shape is extruded to :ref:`depth`. -- **MODE_SPIN** = **1** --- Shape is extruded by rotating it around an axis. -- **MODE_PATH** = **2** --- Shape is extruded along a path set by a :ref:`Shape` set in :ref:`path_node`. - - .. _enum_CSGPolygon_PathRotation: - -enum **PathRotation** - -- **PATH_ROTATION_POLYGON** = **0** --- Slice is not rotated. -- **PATH_ROTATION_PATH** = **1** --- Slice is rotated around the up vector of the path. -- **PATH_ROTATION_PATH_FOLLOW** = **2** --- Slice is rotate to match the path exactly. - - -Description ------------ - -This node takes a 2D polygon shape and extrudes it to create a 3D mesh. - diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index c187fe011..295046efd 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -7,10 +7,8 @@ CSGPrimitive ============ -**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`CSGSphere`, :ref:`CSGPolygon`, :ref:`CSGCylinder`, :ref:`CSGBox`, :ref:`CSGTorus`, :ref:`CSGMesh` - +**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`CSGSphere`, :ref:`CSGPolygon`, :ref:`CSGCylinder`, :ref:`CSGBox`, :ref:`CSGTorus`, :ref:`CSGMesh` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Base class for CSG primitives. -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_CSGPrimitive_invert_faces: diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 333c1473d..9b7d52dfa 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -7,10 +7,8 @@ CSGShape ======== -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`CSGCombiner`, :ref:`CSGPrimitive` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`CSGCombiner`, :ref:`CSGPrimitive` **Category:** Core Brief Description @@ -18,31 +16,15 @@ Brief Description The CSG base class. -Member Functions ----------------- +Methods +------- +--------------------------+----------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_root_shape` **(** **)** const | +--------------------------+----------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_CSGShape_operation: - -- :ref:`Operation` **operation** - The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. - - .. _class_CSGShape_snap: - -- :ref:`float` **snap** - - .. _class_CSGShape_use_collision: - -- :ref:`bool` **use_collision** - Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. - - -Enums ------ +Enumerations +------------ .. _enum_CSGShape_Operation: @@ -58,8 +40,24 @@ Description This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_CSGShape_operation: + +- :ref:`Operation` **operation** - The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent. + + .. _class_CSGShape_snap: + +- :ref:`float` **snap** + + .. _class_CSGShape_use_collision: + +- :ref:`bool` **use_collision** - Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden. + + +Method Descriptions +------------------- .. _class_CSGShape_is_root_shape: diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index b65d84023..fa8ddb083 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -7,8 +7,7 @@ CSGSphere ========= -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,17 @@ Brief Description A CSG Sphere shape. -Member Variables ----------------- +Description +----------- + +This node allows you to create a sphere for use with the CSG system. + +Property Descriptions +--------------------- .. _class_CSGSphere_material: -- :ref:`Material` **material** - The material used to render the sphere. +- :ref:`Material` **material** - The material used to render the sphere. .. _class_CSGSphere_radial_segments: @@ -40,8 +44,3 @@ Member Variables - :ref:`bool` **smooth_faces** - If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look. -Description ------------ - -This node allows you to create a sphere for use with the CSG system. - diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index 4d76537ca..b1b8839bb 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -7,8 +7,7 @@ CSGTorus ======== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description A CSG Torus shape. -Member Variables ----------------- +Description +----------- + +This node allows you to create a torus for use with the CSG system. + +Property Descriptions +--------------------- .. _class_CSGTorus_inner_radius: @@ -25,7 +29,7 @@ Member Variables .. _class_CSGTorus_material: -- :ref:`Material` **material** - The material used to render the torus. +- :ref:`Material` **material** - The material used to render the torus. .. _class_CSGTorus_outer_radius: @@ -44,8 +48,3 @@ Member Variables - :ref:`bool` **smooth_faces** - If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look. -Description ------------ - -This node allows you to create a torus for use with the CSG system. - diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 95eac5576..60d7bd1f2 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -7,8 +7,7 @@ CSharpScript ============ -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,18 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+-------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | +| :ref:`Object` | :ref:`new` **(** **)** vararg | +------------------------------+-------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_CSharpScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index 35480ef6a..868f3e304 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -7,8 +7,7 @@ CubeMap ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,37 +15,21 @@ Brief Description A CubeMap is a 6 sided 3D texture. -Member Functions ----------------- +Methods +------- +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height` **(** **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | +| :ref:`Image` | :ref:`get_side` **(** :ref:`Side` side **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | +| void | :ref:`set_side` **(** :ref:`Side` side, :ref:`Image` image **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_CubeMap_flags: - -- :ref:`int` **flags** - The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. - - .. _class_CubeMap_lossy_storage_quality: - -- :ref:`float` **lossy_storage_quality** - The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. - - .. _class_CubeMap_storage_mode: - -- :ref:`Storage` **storage_mode** - The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. - - -Enums ------ +Enumerations +------------ .. _enum_CubeMap_Flags: @@ -82,8 +65,24 @@ Description A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_CubeMap_flags: + +- :ref:`int` **flags** - The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. + + .. _class_CubeMap_lossy_storage_quality: + +- :ref:`float` **lossy_storage_quality** - The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. + + .. _class_CubeMap_storage_mode: + +- :ref:`Storage` **storage_mode** - The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. + + +Method Descriptions +------------------- .. _class_CubeMap_get_height: @@ -93,9 +92,9 @@ Returns the ``CubeMap``'s height. .. _class_CubeMap_get_side: -- :ref:`Image` **get_side** **(** :ref:`Side` side **)** const +- :ref:`Image` **get_side** **(** :ref:`Side` side **)** const -Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. +Returns an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. .. _class_CubeMap_get_width: @@ -105,8 +104,8 @@ Returns the ``CubeMap``'s width. .. _class_CubeMap_set_side: -- void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** +- void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** -Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. +Sets an :ref:`Image` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5. diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 08af56831..a0089910a 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -7,21 +7,25 @@ CubeMesh ======== -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. +Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. + +Property Descriptions +--------------------- .. _class_CubeMesh_size: -- :ref:`Vector3` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2). +- :ref:`Vector3` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2). .. _class_CubeMesh_subdivide_depth: @@ -36,8 +40,3 @@ Member Variables - :ref:`int` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0. -Description ------------ - -Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. - diff --git a/classes/class_curve.rst b/classes/class_curve.rst index c3b3ef6a8..d19e3137e 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -7,8 +7,7 @@ Curve ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description A mathematic curve. -Member Functions ----------------- +Methods +------- +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** | +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bake` **(** **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,13 +27,15 @@ Member Functions +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TangentMode` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TangentMode` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | +| :ref:`TangentMode` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,13 +45,13 @@ Member Functions +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` index **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`TangentMode` mode **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | +---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,24 +68,8 @@ Signals Emitted when :ref:`max_value` or :ref:`min_value` is changed. -Member Variables ----------------- - - .. _class_Curve_bake_resolution: - -- :ref:`int` **bake_resolution** - The number of points to include in the baked (i.e. cached) curve data. - - .. _class_Curve_max_value: - -- :ref:`float` **max_value** - The maximum value the curve can reach. Default value: ``1``. - - .. _class_Curve_min_value: - -- :ref:`float` **min_value** - The minimum value the curve can reach. Default value: ``0``. - - -Enums ------ +Enumerations +------------ .. _enum_Curve_TangentMode: @@ -100,12 +85,28 @@ Description A curve that can be saved and re-used for other objects. By default it ranges between ``0`` and ``1`` on the y-axis and positions points relative to the ``0.5`` y-position. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Curve_bake_resolution: + +- :ref:`int` **bake_resolution** - The number of points to include in the baked (i.e. cached) curve data. + + .. _class_Curve_max_value: + +- :ref:`float` **max_value** - The maximum value the curve can reach. Default value: ``1``. + + .. _class_Curve_min_value: + +- :ref:`float` **min_value** - The minimum value the curve can reach. Default value: ``0``. + + +Method Descriptions +------------------- .. _class_Curve_add_point: -- :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** +- :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`TangentMode` left_mode=0, :ref:`TangentMode` right_mode=0 **)** Adds a point to the curve. For each side, if the ``*_mode`` is ``TANGENT_LINEAR``, the ``*_tangent`` angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the ``*_tangent`` angle if ``*_mode`` is set to ``TANGENT_FREE``. @@ -127,9 +128,15 @@ Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their nei Removes all points from the curve. +.. _class_Curve_get_point_count: + +- :ref:`int` **get_point_count** **(** **)** const + +Returns the number of points describing the curve. + .. _class_Curve_get_point_left_mode: -- :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const +- :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const Returns the left ``TangentMode`` for the point at ``index``. @@ -141,13 +148,13 @@ Returns the left tangent angle (in degrees) for the point at ``index``. .. _class_Curve_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const Returns the curve coordinates for the point at ``index``. .. _class_Curve_get_point_right_mode: -- :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const +- :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const Returns the right ``TangentMode`` for the point at ``index``. @@ -177,7 +184,7 @@ Removes the point at ``index`` from the curve. .. _class_Curve_set_point_left_mode: -- void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** +- void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the left ``TangentMode`` for the point at ``index`` to ``mode``. @@ -195,7 +202,7 @@ Sets the offset from ``0.5`` .. _class_Curve_set_point_right_mode: -- void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** +- void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the right ``TangentMode`` for the point at ``index`` to ``mode``. diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 585a712c3..748abb389 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -7,8 +7,7 @@ Curve2D ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,68 +15,68 @@ Brief Description Describes a Bezier curve in 2D space. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | +| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector2` to_point **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a :ref:`Path2D`, but can be manually sampled for other purposes. + +It keeps a cache of precalculated points along the curve, to speed further calculations up. + +Property Descriptions +--------------------- .. _class_Curve2D_bake_interval: - :ref:`float` **bake_interval** - The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points` or :ref:`get_baked_length` function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. -Description ------------ - -This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a :ref:`Path2D`, but can be manually sampled for other purposes. - -It keeps a cache of precalculated points along the curve, to speed further calculations up. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** +- void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** Adds a point to a curve, at "position", with control points "in" and "out". @@ -97,13 +96,13 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve2D_get_baked_points: -- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector2Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`PoolVector2Array`. +Returns the cache of points as a :ref:`PoolVector2Array`. .. _class_Curve2D_get_closest_offset: -- :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const +- :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const Returns the closest offset to ``to_point``. This offset is meant to be used in :ref:`interpolate_baked`. @@ -111,7 +110,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : .. _class_Curve2D_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const Returns the closest point (in curve's local space) to ``to_point``. @@ -125,25 +124,25 @@ Returns the number of points describing the curve. .. _class_Curve2D_get_point_in: -- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_in** **(** :ref:`int` idx **)** const Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_get_point_out: -- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_out** **(** :ref:`int` idx **)** const Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). .. _class_Curve2D_interpolate: -- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. @@ -151,7 +150,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve2D_interpolate_baked: -- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. @@ -161,7 +160,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve2D_interpolatef: -- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector2` **interpolatef** **(** :ref:`float` fofs **)** const Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". @@ -173,25 +172,25 @@ Deletes the point "idx" from the curve. Sends an error to the console if "idx" i .. _class_Curve2D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_set_point_position: -- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** +- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_tessellate: -- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 5b1fa540f..885465627 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -7,8 +7,7 @@ Curve3D ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,59 +15,66 @@ Brief Description Describes a Bezier curve in 3D space. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | +| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_points` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_baked_length` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_baked_up_vectors` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | +| :ref:`float` | :ref:`get_closest_offset` **(** :ref:`Vector3` to_point **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const | +| :ref:`Vector3` | :ref:`interpolate_baked_up_vector` **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` idx **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a :ref:`Path`, but can be manually sampled for other purposes. + +It keeps a cache of precalculated points along the curve, to speed further calculations up. + +Property Descriptions +--------------------- .. _class_Curve3D_bake_interval: @@ -76,22 +82,15 @@ Member Variables .. _class_Curve3D_up_vector_enabled: -- :ref:`bool` **up_vector_enabled** - If ``true``, the curve will bake up vectors used for orientation. See :ref:`OrientedPathFollow`. Changing it forces the cache to be recomputed. +- :ref:`bool` **up_vector_enabled** - If ``true``, the curve will bake up vectors used for orientation. See :ref:`OrientedPathFollow`. Changing it forces the cache to be recomputed. -Description ------------ - -This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a :ref:`Path`, but can be manually sampled for other purposes. - -It keeps a cache of precalculated points along the curve, to speed further calculations up. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** +- void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** Adds a point to a curve, at "position", with control points "in" and "out". @@ -111,27 +110,27 @@ Returns the total length of the curve, based on the cached points. Given enough .. _class_Curve3D_get_baked_points: -- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_points** **(** **)** const -Returns the cache of points as a :ref:`PoolVector3Array`. +Returns the cache of points as a :ref:`PoolVector3Array`. .. _class_Curve3D_get_baked_tilts: -- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const +- :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a RealArray. .. _class_Curve3D_get_baked_up_vectors: -- :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const +- :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const -Returns the cache of up vectors as a :ref:`PoolVector3Array`. +Returns the cache of up vectors as a :ref:`PoolVector3Array`. If :ref:`up_vector_enabled` is ``false``, the cache will be empty. .. _class_Curve3D_get_closest_offset: -- :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const +- :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const Returns the closest offset to ``to_point``. This offset is meant to be used in one of the interpolate_baked\* methods. @@ -139,7 +138,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in o .. _class_Curve3D_get_closest_point: -- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const +- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const Returns the closest point (in curve's local space) to ``to_point``. @@ -153,19 +152,19 @@ Returns the number of points describing the curve. .. _class_Curve3D_get_point_in: -- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_in** **(** :ref:`int` idx **)** const Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). .. _class_Curve3D_get_point_out: -- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_out** **(** :ref:`int` idx **)** const Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). .. _class_Curve3D_get_point_position: -- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). @@ -177,7 +176,7 @@ Returns the tilt angle in radians for the point "idx". If the index is out of bo .. _class_Curve3D_interpolate: -- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const +- :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. @@ -185,7 +184,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i .. _class_Curve3D_interpolate_baked: -- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const +- :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. @@ -195,7 +194,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and .. _class_Curve3D_interpolate_baked_up_vector: -- :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const +- :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const Returns an up vector within the curve at position ``offset``, where ``offset`` is measured as a distance in 3D units along the curve. @@ -205,7 +204,7 @@ If the curve has no up vectors, the function sends an error to the console, and .. _class_Curve3D_interpolatef: -- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const +- :ref:`Vector3` **interpolatef** **(** :ref:`float` fofs **)** const Returns the position at the vertex "fofs". It calls :ref:`interpolate` using the integer part of fofs as "idx", and its fractional part as "t". @@ -217,19 +216,19 @@ Deletes the point "idx" from the curve. Sends an error to the console if "idx" i .. _class_Curve3D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_position: -- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** +- void **set_point_position** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. @@ -239,11 +238,11 @@ Sets the position for the vertex "idx". If the index is out of bounds, the funct Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. -The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow` or :ref:`OrientedPathFollow`, this tilt is an offset over the natural tilt the :ref:`PathFollow` or :ref:`OrientedPathFollow` calculates. +The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow` or :ref:`OrientedPathFollow`, this tilt is an offset over the natural tilt the :ref:`PathFollow` or :ref:`OrientedPathFollow` calculates. .. _class_Curve3D_tessellate: -- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const +- :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 4fe453139..816e735b5 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -7,8 +7,7 @@ CurveTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description A texture that shows a curve. -Member Variables ----------------- +Description +----------- + +Renders a given :ref:`Curve` provided to it. Simplifies the task of drawing curves and/or saving them as image files. + +Property Descriptions +--------------------- .. _class_CurveTexture_curve: -- :ref:`Curve` **curve** - The ``curve`` rendered onto the texture. +- :ref:`Curve` **curve** - The ``curve`` rendered onto the texture. .. _class_CurveTexture_width: - :ref:`int` **width** - The width of the texture. -Description ------------ - -Renders a given :ref:`Curve` provided to it. Simplifies the task of drawing curves and/or saving them as image files. - diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index ac77567f1..18338797a 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -7,17 +7,21 @@ CylinderMesh ============ -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Class representing a cylindrical :ref:`PrimitiveMesh`. +Class representing a cylindrical :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Class representing a cylindrical :ref:`PrimitiveMesh`. + +Property Descriptions +--------------------- .. _class_CylinderMesh_bottom_radius: @@ -40,8 +44,3 @@ Member Variables - :ref:`float` **top_radius** - Top radius of the cylinder. Defaults to 1.0. -Description ------------ - -Class representing a cylindrical :ref:`PrimitiveMesh`. - diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index a12a70853..2c1d00d6a 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -7,8 +7,7 @@ CylinderShape ============= -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Cylinder shape for collisions. -Member Variables ----------------- +Description +----------- + +Cylinder shape for collisions. + +Property Descriptions +--------------------- .. _class_CylinderShape_height: @@ -28,8 +32,3 @@ Member Variables - :ref:`float` **radius** - The cylinder's radius. -Description ------------ - -Cylinder shape for collisions. - diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 62d69f14b..d250b5075 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -7,8 +7,7 @@ DampedSpringJoint2D =================== -**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Damped spring constraint for 2D physics. -Member Variables ----------------- +Description +----------- + +Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. + +Property Descriptions +--------------------- .. _class_DampedSpringJoint2D_damping: @@ -36,8 +40,3 @@ Member Variables - :ref:`float` **stiffness** - The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: ``20`` -Description ------------ - -Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. - diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 60e19b410..7fb8bb2f9 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -14,29 +14,29 @@ Brief Description Dictionary type. -Member Functions ----------------- +Methods +------- +--------------------------------------+---------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | +| :ref:`Dictionary` | :ref:`duplicate` **(** :ref:`bool` deep=False **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`erase` **(** var key **)** | +| :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** var key **)** | +| :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | +| :ref:`bool` | :ref:`has_all` **(** :ref:`Array` keys **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`keys` **(** **)** | +| :ref:`Array` | :ref:`keys` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`values` **(** **)** | +| :ref:`Array` | :ref:`values` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------------------------+ Description @@ -44,8 +44,8 @@ Description Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Dictionary_clear: @@ -55,7 +55,7 @@ Clear the dictionary, removing all key/value pairs. .. _class_Dictionary_duplicate: -- :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** +- :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** Creates a copy of the dictionary, and returns it. @@ -67,19 +67,19 @@ Return true if the dictionary is empty. .. _class_Dictionary_erase: -- :ref:`bool` **erase** **(** var key **)** +- :ref:`bool` **erase** **(** :ref:`Variant` key **)** Erase a dictionary key/value pair by key. .. _class_Dictionary_has: -- :ref:`bool` **has** **(** var key **)** +- :ref:`bool` **has** **(** :ref:`Variant` key **)** Return true if the dictionary has a given key. .. _class_Dictionary_has_all: -- :ref:`bool` **has_all** **(** :ref:`Array` keys **)** +- :ref:`bool` **has_all** **(** :ref:`Array` keys **)** Return true if the dictionary has all of the keys in the given array. @@ -91,7 +91,7 @@ Return a hashed integer value representing the dictionary contents. .. _class_Dictionary_keys: -- :ref:`Array` **keys** **(** **)** +- :ref:`Array` **keys** **(** **)** Return the list of keys in the ``Dictionary``. @@ -103,7 +103,7 @@ Return the size of the dictionary (in pairs). .. _class_Dictionary_values: -- :ref:`Array` **values** **(** **)** +- :ref:`Array` **values** **(** **)** Return the list of values in the ``Dictionary``. diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index b53907029..f220edfb2 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -7,8 +7,7 @@ DirectionalLight ================ -**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,48 +15,8 @@ Brief Description Directional light from a distance, as from the Sun. -Member Variables ----------------- - - .. _class_DirectionalLight_directional_shadow_bias_split_scale: - -- :ref:`float` **directional_shadow_bias_split_scale** - Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. - - .. _class_DirectionalLight_directional_shadow_blend_splits: - -- :ref:`bool` **directional_shadow_blend_splits** - If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. - - .. _class_DirectionalLight_directional_shadow_depth_range: - -- :ref:`ShadowDepthRange` **directional_shadow_depth_range** - Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. - - .. _class_DirectionalLight_directional_shadow_max_distance: - -- :ref:`float` **directional_shadow_max_distance** - The maximum distance for shadow splits. - - .. _class_DirectionalLight_directional_shadow_mode: - -- :ref:`ShadowMode` **directional_shadow_mode** - The light's shadow rendering algorithm. See :ref:`ShadowMode`. - - .. _class_DirectionalLight_directional_shadow_normal_bias: - -- :ref:`float` **directional_shadow_normal_bias** - Can be used to fix special cases of self shadowing when objects are perpendicular to the light. - - .. _class_DirectionalLight_directional_shadow_split_1: - -- :ref:`float` **directional_shadow_split_1** - The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. - - .. _class_DirectionalLight_directional_shadow_split_2: - -- :ref:`float` **directional_shadow_split_2** - The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. - - .. _class_DirectionalLight_directional_shadow_split_3: - -- :ref:`float` **directional_shadow_split_3** - The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL_4_SPLITS. - - -Enums ------ +Enumerations +------------ .. _enum_DirectionalLight_ShadowDepthRange: @@ -78,10 +37,50 @@ enum **ShadowMode** Description ----------- -A directional light is a type of :ref:`Light` node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. +A directional light is a type of :ref:`Light` node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` +Property Descriptions +--------------------- + + .. _class_DirectionalLight_directional_shadow_bias_split_scale: + +- :ref:`float` **directional_shadow_bias_split_scale** - Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. + + .. _class_DirectionalLight_directional_shadow_blend_splits: + +- :ref:`bool` **directional_shadow_blend_splits** - If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. + + .. _class_DirectionalLight_directional_shadow_depth_range: + +- :ref:`ShadowDepthRange` **directional_shadow_depth_range** - Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. + + .. _class_DirectionalLight_directional_shadow_max_distance: + +- :ref:`float` **directional_shadow_max_distance** - The maximum distance for shadow splits. + + .. _class_DirectionalLight_directional_shadow_mode: + +- :ref:`ShadowMode` **directional_shadow_mode** - The light's shadow rendering algorithm. See :ref:`ShadowMode`. + + .. _class_DirectionalLight_directional_shadow_normal_bias: + +- :ref:`float` **directional_shadow_normal_bias** - Can be used to fix special cases of self shadowing when objects are perpendicular to the light. + + .. _class_DirectionalLight_directional_shadow_split_1: + +- :ref:`float` **directional_shadow_split_1** - The distance from camera to shadow split 1. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. + + .. _class_DirectionalLight_directional_shadow_split_2: + +- :ref:`float` **directional_shadow_split_2** - The distance from shadow split 1 to split 2. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL\_\*_SPLITS. + + .. _class_DirectionalLight_directional_shadow_split_3: + +- :ref:`float` **directional_shadow_split_3** - The distance from shadow split 2 to split 3. Relative to :ref:`directional_shadow_max_distance`. Only used in :ref:`directional_shadow_mode` SHADOW_PARALLEL_4_SPLITS. + + diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 64af3da54..6964793f0 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -7,8 +7,7 @@ Directory ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,45 +15,45 @@ Brief Description Type used to handle the filesystem. -Member Functions ----------------- +Methods +------- +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_dir` **(** :ref:`String` todir **)** | +| :ref:`Error` | :ref:`change_dir` **(** :ref:`String` todir **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | +| :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`current_is_dir` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | +| :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_dir` **(** **)** | +| :ref:`String` | :ref:`get_current_dir` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_drive` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | +| :ref:`String` | :ref:`get_drive` **(** :ref:`int` idx **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_drive_count` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_next` **(** **)** | +| :ref:`String` | :ref:`get_next` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_space_left` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | +| :ref:`Error` | :ref:`list_dir_begin` **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`list_dir_end` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | +| :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -85,24 +84,24 @@ Tutorials - :doc:`../getting_started/step_by_step/filesystem` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Directory_change_dir: -- :ref:`Error` **change_dir** **(** :ref:`String` todir **)** +- :ref:`Error` **change_dir** **(** :ref:`String` todir **)** Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``). -The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). .. _class_Directory_copy: -- :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** +- :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. -Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_current_is_dir: @@ -112,19 +111,19 @@ Return whether the current item processed with the last :ref:`get_next` **dir_exists** **(** :ref:`String` path **)** +- :ref:`bool` **dir_exists** **(** :ref:`String` path **)** Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_file_exists: -- :ref:`bool` **file_exists** **(** :ref:`String` path **)** +- :ref:`bool` **file_exists** **(** :ref:`String` path **)** Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. .. _class_Directory_get_current_dir: -- :ref:`String` **get_current_dir** **(** **)** +- :ref:`String` **get_current_dir** **(** **)** Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``). @@ -136,7 +135,7 @@ Returns the currently opened directory's drive index. See :ref:`get_drive` **get_drive** **(** :ref:`int` idx **)** +- :ref:`String` **get_drive** **(** :ref:`int` idx **)** On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String. @@ -148,7 +147,7 @@ On Windows, return the number of drives (partitions) mounted on the current file .. _class_Directory_get_next: -- :ref:`String` **get_next** **(** **)** +- :ref:`String` **get_next** **(** **)** Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin`). @@ -162,7 +161,7 @@ On Unix desktop systems, return the available space on the current directory's d .. _class_Directory_list_dir_begin: -- :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** +- :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** Initialise the stream used to list all files and directories using the :ref:`get_next` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end`. @@ -178,42 +177,42 @@ Close the current stream opened with :ref:`list_dir_begin` **make_dir** **(** :ref:`String` path **)** +- :ref:`Error` **make_dir** **(** :ref:`String` path **)** Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive`). -The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_make_dir_recursive: -- :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** +- :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir` recursively. The argument can be relative to the current directory, or an absolute path. -Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). .. _class_Directory_open: -- :ref:`Error` **open** **(** :ref:`String` path **)** +- :ref:`Error` **open** **(** :ref:`String` path **)** Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``). -The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). +The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). .. _class_Directory_remove: -- :ref:`Error` **remove** **(** :ref:`String` path **)** +- :ref:`Error` **remove** **(** :ref:`String` path **)** Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. -Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). .. _class_Directory_rename: -- :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** +- :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. -Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). +Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 950099511..ba7f1a982 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -7,8 +7,7 @@ DynamicFont =========== -**Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Font` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,41 @@ Brief Description DynamicFont renders vector font files at runtime. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | +| void | :ref:`add_fallback` **(** :ref:`DynamicFontData` data **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | +| :ref:`DynamicFontData` | :ref:`get_fallback` **(** :ref:`int` idx **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_fallback_count` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_fallback` **(** :ref:`int` idx **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | +| void | :ref:`set_fallback` **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_DynamicFont_SpacingType: + +enum **SpacingType** + +- **SPACING_TOP** = **0** --- Spacing at the top. +- **SPACING_BOTTOM** = **1** --- Spacing at the bottom. +- **SPACING_CHAR** = **2** --- Character spacing. +- **SPACING_SPACE** = **3** --- Space spacing. + + +Description +----------- + +DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont`. This trades the faster loading time of :ref:`BitmapFont`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData` is used for referencing the font file paths. + +Property Descriptions +--------------------- .. _class_DynamicFont_extra_spacing_bottom: @@ -52,11 +69,11 @@ Member Variables .. _class_DynamicFont_font_data: -- :ref:`DynamicFontData` **font_data** - The font data. +- :ref:`DynamicFontData` **font_data** - The font data. .. _class_DynamicFont_outline_color: -- :ref:`Color` **outline_color** +- :ref:`Color` **outline_color** .. _class_DynamicFont_outline_size: @@ -75,36 +92,18 @@ Member Variables - :ref:`bool` **use_mipmaps** - If ``true`` mipmapping is used. -Enums ------ - - .. _enum_DynamicFont_SpacingType: - -enum **SpacingType** - -- **SPACING_TOP** = **0** --- Spacing at the top. -- **SPACING_BOTTOM** = **1** --- Spacing at the bottom. -- **SPACING_CHAR** = **2** --- Character spacing. -- **SPACING_SPACE** = **3** --- Space spacing. - - -Description ------------ - -DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont`. This trades the faster loading time of :ref:`BitmapFont`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData` is used for referencing the font file paths. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_DynamicFont_add_fallback: -- void **add_fallback** **(** :ref:`DynamicFontData` data **)** +- void **add_fallback** **(** :ref:`DynamicFontData` data **)** Adds a fallback font. .. _class_DynamicFont_get_fallback: -- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const +- :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. @@ -122,7 +121,7 @@ Removes the fallback font at index ``idx``. .. _class_DynamicFont_set_fallback: -- void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** +- void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** Sets the fallback font at index ``idx``. diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 9c8a8105f..d875aaae1 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -7,29 +7,16 @@ DynamicFontData =============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Used with :ref:`DynamicFont` to describe the location of a font file. +Used with :ref:`DynamicFont` to describe the location of a font file. -Member Variables ----------------- - - .. _class_DynamicFontData_font_path: - -- :ref:`String` **font_path** - The path to the vector font file. - - .. _class_DynamicFontData_hinting: - -- :ref:`Hinting` **hinting** - The font hinting mode used by FreeType. - - -Enums ------ +Enumerations +------------ .. _enum_DynamicFontData_Hinting: @@ -43,5 +30,17 @@ enum **Hinting** Description ----------- -Used with :ref:`DynamicFont` to describe the location of a vector font file for dynamic rendering at runtime. +Used with :ref:`DynamicFont` to describe the location of a vector font file for dynamic rendering at runtime. + +Property Descriptions +--------------------- + + .. _class_DynamicFontData_font_path: + +- :ref:`String` **font_path** - The path to the vector font file. + + .. _class_DynamicFontData_hinting: + +- :ref:`Hinting` **hinting** - The font hinting mode used by FreeType. + diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 45855eaa7..4828d539a 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -7,8 +7,7 @@ EditorExportPlugin ================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,69 +15,69 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | +| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | +| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | +| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | +| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | +| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skip` **(** **)** | +-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorExportPlugin__export_begin: -- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual +- void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual .. _class_EditorExportPlugin__export_file: -- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual +- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual .. _class_EditorExportPlugin_add_file: -- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** +- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** .. _class_EditorExportPlugin_add_ios_bundle_file: -- void **add_ios_bundle_file** **(** :ref:`String` path **)** +- void **add_ios_bundle_file** **(** :ref:`String` path **)** .. _class_EditorExportPlugin_add_ios_cpp_code: -- void **add_ios_cpp_code** **(** :ref:`String` code **)** +- void **add_ios_cpp_code** **(** :ref:`String` code **)** .. _class_EditorExportPlugin_add_ios_framework: -- void **add_ios_framework** **(** :ref:`String` path **)** +- void **add_ios_framework** **(** :ref:`String` path **)** .. _class_EditorExportPlugin_add_ios_linker_flags: -- void **add_ios_linker_flags** **(** :ref:`String` flags **)** +- void **add_ios_linker_flags** **(** :ref:`String` flags **)** .. _class_EditorExportPlugin_add_ios_plist_content: -- void **add_ios_plist_content** **(** :ref:`String` plist_content **)** +- void **add_ios_plist_content** **(** :ref:`String` plist_content **)** .. _class_EditorExportPlugin_add_shared_object: -- void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** +- void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** .. _class_EditorExportPlugin_skip: diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index c6e4c5dcf..a978cc198 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -7,8 +7,7 @@ EditorFileDialog ================ -**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------+ | void | :ref:`clear_filters` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------+ | void | :ref:`invalidate` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------+ @@ -34,61 +33,25 @@ Signals .. _class_EditorFileDialog_dir_selected: -- **dir_selected** **(** :ref:`String` dir **)** +- **dir_selected** **(** :ref:`String` dir **)** Emitted when a directory is selected. .. _class_EditorFileDialog_file_selected: -- **file_selected** **(** :ref:`String` path **)** +- **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. .. _class_EditorFileDialog_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** Emitted when multiple files are selected. -Member Variables ----------------- - - .. _class_EditorFileDialog_access: - -- :ref:`Access` **access** - The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. - - .. _class_EditorFileDialog_current_dir: - -- :ref:`String` **current_dir** - The currently occupied directory. - - .. _class_EditorFileDialog_current_file: - -- :ref:`String` **current_file** - The currently selected file. - - .. _class_EditorFileDialog_current_path: - -- :ref:`String` **current_path** - The file system path in the address bar. - - .. _class_EditorFileDialog_disable_overwrite_warning: - -- :ref:`bool` **disable_overwrite_warning** - If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. - - .. _class_EditorFileDialog_display_mode: - -- :ref:`DisplayMode` **display_mode** - The view format in which the ``EditorFileDialog`` displays resources to the user. - - .. _class_EditorFileDialog_mode: - -- :ref:`Mode` **mode** - The purpose of the ``EditorFileDialog``. Changes allowed behaviors. - - .. _class_EditorFileDialog_show_hidden_files: - -- :ref:`bool` **show_hidden_files** - If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. - - -Enums ------ +Enumerations +------------ .. _enum_EditorFileDialog_Access: @@ -116,12 +79,48 @@ enum **Mode** - **MODE_SAVE_FILE** = **4** --- The ``EditorFileDialog`` can select only one file. Accepting the window will save the file. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_EditorFileDialog_access: + +- :ref:`Access` **access** - The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. + + .. _class_EditorFileDialog_current_dir: + +- :ref:`String` **current_dir** - The currently occupied directory. + + .. _class_EditorFileDialog_current_file: + +- :ref:`String` **current_file** - The currently selected file. + + .. _class_EditorFileDialog_current_path: + +- :ref:`String` **current_path** - The file system path in the address bar. + + .. _class_EditorFileDialog_disable_overwrite_warning: + +- :ref:`bool` **disable_overwrite_warning** - If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. + + .. _class_EditorFileDialog_display_mode: + +- :ref:`DisplayMode` **display_mode** - The view format in which the ``EditorFileDialog`` displays resources to the user. + + .. _class_EditorFileDialog_mode: + +- :ref:`Mode` **mode** - The purpose of the ``EditorFileDialog``. Changes allowed behaviors. + + .. _class_EditorFileDialog_show_hidden_files: + +- :ref:`bool` **show_hidden_files** - If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. + + +Method Descriptions +------------------- .. _class_EditorFileDialog_add_filter: -- void **add_filter** **(** :ref:`String` filter **)** +- void **add_filter** **(** :ref:`String` filter **)** Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` with an optional semi-colon-delimited label. @@ -135,7 +134,7 @@ Removes all filters except for "All Files (\*)". .. _class_EditorFileDialog_get_vbox: -- :ref:`VBoxContainer` **get_vbox** **(** **)** +- :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``VBoxContainer`` used to display the file system. diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index ce69ab612..5c5d9240e 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -7,8 +7,7 @@ EditorFileSystem ================ -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Resource filesystem, as the editor sees it. -Member Functions ----------------- +Methods +------- +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_file_type` **(** :ref:`String` path **)** const | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem` **(** **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | +| :ref:`EditorFileSystemDirectory` | :ref:`get_filesystem_path` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_scanning_progress` **(** **)** const | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ @@ -34,7 +33,7 @@ Member Functions +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scan_sources` **(** **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_file` **(** :ref:`String` path **)** | +| void | :ref:`update_file` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_script_classes` **(** **)** | +--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ @@ -50,7 +49,7 @@ Emitted if the filesystem changed. .. _class_EditorFileSystem_resources_reimported: -- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** +- **resources_reimported** **(** :ref:`PoolStringArray` resources **)** Remitted if a resource is reimported. @@ -70,24 +69,24 @@ Description This object holds information of all resources in the filesystem, their types, etc. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorFileSystem_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`String` path **)** const +- :ref:`String` **get_file_type** **(** :ref:`String` path **)** const Get the type of the file, given the full path. .. _class_EditorFileSystem_get_filesystem: -- :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** +- :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. .. _class_EditorFileSystem_get_filesystem_path: -- :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** +- :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** Returns a view into the filesystem at ``path``. @@ -117,7 +116,7 @@ Check if the source of any imported resource changed. .. _class_EditorFileSystem_update_file: -- void **update_file** **(** :ref:`String` path **)** +- void **update_file** **(** :ref:`String` path **)** Update a file information. Call this if an external program (not Godot) modified the file. diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index acc133150..2978c2c76 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -7,8 +7,7 @@ EditorFileSystemDirectory ========================= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,35 +15,35 @@ Brief Description A diretory for the resource filesystem. -Member Functions ----------------- +Methods +------- +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_dir_index` **(** :ref:`String` name **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_file_index` **(** :ref:`String` name **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_file` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_file_count` **(** **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_file_import_is_valid` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_file_path` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_file_script_class_extends` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_file_script_class_name` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_file_type` **(** :ref:`int` idx **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** | +| :ref:`String` | :ref:`get_name` **(** **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | +| :ref:`EditorFileSystemDirectory` | :ref:`get_parent` **(** **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | +| :ref:`String` | :ref:`get_path` **(** **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | +| :ref:`EditorFileSystemDirectory` | :ref:`get_subdir` **(** :ref:`int` idx **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_subdir_count` **(** **)** const | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,24 +53,24 @@ Description A more generalized, low-level variation of the directory concept. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorFileSystemDirectory_find_dir_index: -- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_dir_index** **(** :ref:`String` name **)** const Returns the index of the directory with name ``name`` or ``-1`` if not found. .. _class_EditorFileSystemDirectory_find_file_index: -- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const +- :ref:`int` **find_file_index** **(** :ref:`String` name **)** const Returns the index of the file with name ``name`` or ``-1`` if not found. .. _class_EditorFileSystemDirectory_get_file: -- :ref:`String` **get_file** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file** **(** :ref:`int` idx **)** const Returns the name of the file at index ``idx``. @@ -89,45 +88,45 @@ Returns ``true`` if the file at index ``idx`` imported properly. .. _class_EditorFileSystemDirectory_get_file_path: -- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_path** **(** :ref:`int` idx **)** const Returns the path to the file at index ``idx``. .. _class_EditorFileSystemDirectory_get_file_script_class_extends: -- :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_file_script_class_name: -- :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const .. _class_EditorFileSystemDirectory_get_file_type: -- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const Returns the file extension of the file at index ``idx``. .. _class_EditorFileSystemDirectory_get_name: -- :ref:`String` **get_name** **(** **)** +- :ref:`String` **get_name** **(** **)** Returns the name of this directory. .. _class_EditorFileSystemDirectory_get_parent: -- :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** +- :ref:`EditorFileSystemDirectory` **get_parent** **(** **)** Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``. .. _class_EditorFileSystemDirectory_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** const Returns the path to this directory. .. _class_EditorFileSystemDirectory_get_subdir: -- :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** +- :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index d6261ed28..3d45bd06c 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -7,8 +7,7 @@ EditorImportPlugin ================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,43 @@ Brief Description Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. -Member Functions ----------------- +Methods +------- +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | +| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_import_order` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | +| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | +| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | +| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_priority` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | +| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | +| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | +| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | +| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | +| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. +EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`get_recognized_extension` and :ref:`get_resource_type`). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.import`` directory. -Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": +Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": :: @@ -99,12 +98,12 @@ Tutorials - :doc:`../tutorials/plugins/editor/import_plugins` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorImportPlugin_get_import_options: -- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual +- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional). @@ -116,13 +115,13 @@ Get the order of this importer to be run when importing resources. Higher values .. _class_EditorImportPlugin_get_importer_name: -- :ref:`String` **get_importer_name** **(** **)** virtual +- :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. .. _class_EditorImportPlugin_get_option_visibility: -- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual +- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual .. _class_EditorImportPlugin_get_preset_count: @@ -132,7 +131,7 @@ Get the number of initial presets defined by the plugin. Use :ref:`get_import_op .. _class_EditorImportPlugin_get_preset_name: -- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual +- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual Get the name of the options preset at this index. @@ -144,30 +143,30 @@ Get the priority of this plugin for the recognized extension. Higher priority pl .. _class_EditorImportPlugin_get_recognized_extensions: -- :ref:`Array` **get_recognized_extensions** **(** **)** virtual +- :ref:`Array` **get_recognized_extensions** **(** **)** virtual Get the list of file extensions to associate with this loader (case insensitive). e.g. "obj". .. _class_EditorImportPlugin_get_resource_type: -- :ref:`String` **get_resource_type** **(** **)** virtual +- :ref:`String` **get_resource_type** **(** **)** virtual Get the Godot resource type associated with this loader. e.g. "Mesh" or "Animation". .. _class_EditorImportPlugin_get_save_extension: -- :ref:`String` **get_save_extension** **(** **)** virtual +- :ref:`String` **get_save_extension** **(** **)** virtual Get the extension used to save this resource in the ``.import`` directory. .. _class_EditorImportPlugin_get_visible_name: -- :ref:`String` **get_visible_name** **(** **)** virtual +- :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. .. _class_EditorImportPlugin_import: -- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual +- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 9269f3588..a848466fd 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -7,8 +7,7 @@ EditorInspector =============== -**Inherits:** :ref:`ScrollContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ScrollContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+-----------------------------------------------------------+ | void | :ref:`refresh` **(** **)** | @@ -32,27 +31,27 @@ Signals .. _class_EditorInspector_property_edited: -- **property_edited** **(** :ref:`String` property **)** +- **property_edited** **(** :ref:`String` property **)** .. _class_EditorInspector_property_keyed: -- **property_keyed** **(** :ref:`String` property **)** +- **property_keyed** **(** :ref:`String` property **)** .. _class_EditorInspector_property_selected: -- **property_selected** **(** :ref:`String` property **)** +- **property_selected** **(** :ref:`String` property **)** .. _class_EditorInspector_resource_selected: -- **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** +- **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** .. _class_EditorInspector_restart_requested: - **restart_requested** **(** **)** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorInspector_refresh: diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index e4fd0f2c5..8b27e137c 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -7,8 +7,7 @@ EditorInspectorPlugin ===================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,53 +15,53 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_control` **(** :ref:`Control` control **)** | +| void | :ref:`add_custom_control` **(** :ref:`Control` control **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor **)** | +| void | :ref:`add_property_editor` **(** :ref:`String` property, :ref:`Control` editor **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** | +| void | :ref:`add_property_editor_for_multiple_properties` **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_handle` **(** :ref:`Object` object **)** virtual | +| :ref:`bool` | :ref:`can_handle` **(** :ref:`Object` object **)** virtual | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_begin` **(** :ref:`Object` object **)** virtual | +| void | :ref:`parse_begin` **(** :ref:`Object` object **)** virtual | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_category` **(** :ref:`Object` object, :ref:`String` category **)** virtual | +| void | :ref:`parse_category` **(** :ref:`Object` object, :ref:`String` category **)** virtual | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`parse_end` **(** **)** virtual | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`parse_property` **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual | +| :ref:`bool` | :ref:`parse_property` **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual | +--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorInspectorPlugin_add_custom_control: -- void **add_custom_control** **(** :ref:`Control` control **)** +- void **add_custom_control** **(** :ref:`Control` control **)** .. _class_EditorInspectorPlugin_add_property_editor: -- void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** +- void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** .. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties: -- void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** +- void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** .. _class_EditorInspectorPlugin_can_handle: -- :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual +- :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual .. _class_EditorInspectorPlugin_parse_begin: -- void **parse_begin** **(** :ref:`Object` object **)** virtual +- void **parse_begin** **(** :ref:`Object` object **)** virtual .. _class_EditorInspectorPlugin_parse_category: -- void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual +- void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual .. _class_EditorInspectorPlugin_parse_end: @@ -70,6 +69,6 @@ Member Function Description .. _class_EditorInspectorPlugin_parse_property: -- :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual +- :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index ad8644877..d4c3f8347 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -7,8 +7,7 @@ EditorInterface =============== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,172 +15,172 @@ Brief Description Editor interface and main components. -Member Functions ----------------- +Methods +------- +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | +| void | :ref:`edit_resource` **(** :ref:`Resource` resource **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_base_control` **(** **)** | +| :ref:`Control` | :ref:`get_base_control` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | +| :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | +| :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | +| :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | +| :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selected_path` **(** **)** const | +| :ref:`String` | :ref:`get_selected_path` **(** **)** const | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | +| :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | +| void | :ref:`inspect_object` **(** :ref:`Object` object, :ref:`String` for_property="" **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** const | +| :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** const | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | +| :ref:`Array` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_scene` **(** **)** | +| :ref:`Error` | :ref:`save_scene` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | +| void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_file` **(** :ref:`String` p_file **)** | +| void | :ref:`select_file` **(** :ref:`String` p_file **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | +| void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to :ref:`EditorSettings`, :ref:`EditorFileSystem`, :ref:`EditorResourcePreview`, :ref:`ScriptEditor`, the editor viewport, as well as information about scenes. Also see :ref:`EditorPlugin` and :ref:`EditorScript`. +Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects and provides access to :ref:`EditorSettings`, :ref:`EditorFileSystem`, :ref:`EditorResourcePreview`, :ref:`ScriptEditor`, the editor viewport, as well as information about scenes. Also see :ref:`EditorPlugin` and :ref:`EditorScript`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorInterface_edit_resource: -- void **edit_resource** **(** :ref:`Resource` resource **)** +- void **edit_resource** **(** :ref:`Resource` resource **)** -Edits the given :ref:`Resource`. +Edits the given :ref:`Resource`. .. _class_EditorInterface_get_base_control: -- :ref:`Control` **get_base_control** **(** **)** +- :ref:`Control` **get_base_control** **(** **)** -Returns the base :ref:`Control`. +Returns the base :ref:`Control`. .. _class_EditorInterface_get_edited_scene_root: -- :ref:`Node` **get_edited_scene_root** **(** **)** +- :ref:`Node` **get_edited_scene_root** **(** **)** -Returns the edited scene's root :ref:`Node`. +Returns the edited scene's root :ref:`Node`. .. _class_EditorInterface_get_editor_settings: -- :ref:`EditorSettings` **get_editor_settings** **(** **)** +- :ref:`EditorSettings` **get_editor_settings** **(** **)** -Returns the :ref:`EditorSettings`. +Returns the :ref:`EditorSettings`. .. _class_EditorInterface_get_editor_viewport: -- :ref:`Control` **get_editor_viewport** **(** **)** +- :ref:`Control` **get_editor_viewport** **(** **)** -Returns the editor :ref:`Viewport`. +Returns the editor :ref:`Viewport`. .. _class_EditorInterface_get_open_scenes: -- :ref:`Array` **get_open_scenes** **(** **)** const +- :ref:`Array` **get_open_scenes** **(** **)** const -Returns an :ref:`Array` of the currently opened scenes. +Returns an :ref:`Array` of the currently opened scenes. .. _class_EditorInterface_get_resource_filesystem: -- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** +- :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** -Returns the :ref:`EditorFileSystem`. +Returns the :ref:`EditorFileSystem`. .. _class_EditorInterface_get_resource_previewer: -- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** +- :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** -Returns the :ref:`EditorResourcePreview`\ er. +Returns the :ref:`EditorResourcePreview`\ er. .. _class_EditorInterface_get_script_editor: -- :ref:`ScriptEditor` **get_script_editor** **(** **)** +- :ref:`ScriptEditor` **get_script_editor** **(** **)** -Returns the :ref:`ScriptEditor`. +Returns the :ref:`ScriptEditor`. .. _class_EditorInterface_get_selected_path: -- :ref:`String` **get_selected_path** **(** **)** const +- :ref:`String` **get_selected_path** **(** **)** const .. _class_EditorInterface_get_selection: -- :ref:`EditorSelection` **get_selection** **(** **)** +- :ref:`EditorSelection` **get_selection** **(** **)** -Returns the :ref:`EditorSelection`. +Returns the :ref:`EditorSelection`. .. _class_EditorInterface_inspect_object: -- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** +- void **inspect_object** **(** :ref:`Object` object, :ref:`String` for_property="" **)** Shows the given property on the given ``object`` in the Editor's Inspector dock. .. _class_EditorInterface_is_plugin_enabled: -- :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const +- :ref:`bool` **is_plugin_enabled** **(** :ref:`String` plugin **)** const Returns the enabled status of a plugin. The plugin name is the same as its directory name. .. _class_EditorInterface_make_mesh_previews: -- :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** +- :ref:`Array` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** -Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture`\ s. +Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture`\ s. .. _class_EditorInterface_open_scene_from_path: -- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** +- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** Opens the scene at the given path. .. _class_EditorInterface_reload_scene_from_path: -- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** +- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** Reloads the scene at the given path. .. _class_EditorInterface_save_scene: -- :ref:`Error` **save_scene** **(** **)** +- :ref:`Error` **save_scene** **(** **)** -Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. +Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. .. _class_EditorInterface_save_scene_as: -- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** +- void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** Saves the scene as a file at ``path``. .. _class_EditorInterface_select_file: -- void **select_file** **(** :ref:`String` p_file **)** +- void **select_file** **(** :ref:`String` p_file **)** .. _class_EditorInterface_set_plugin_enabled: -- void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** +- void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** Sets the enabled status of a plugin. The plugin name is the same as its directory name. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index abcf72f55..96fd792f3 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -7,8 +7,7 @@ EditorPlugin ============ -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description Used by the editor to extend its functionality. -Member Functions ----------------- +Methods +------- +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_autoload_singleton` **(** :ref:`String` name, :ref:`String` path **)** | +| void | :ref:`add_autoload_singleton` **(** :ref:`String` name, :ref:`String` path **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | +| :ref:`ToolButton` | :ref:`add_control_to_bottom_panel` **(** :ref:`Control` control, :ref:`String` title **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | +| void | :ref:`add_control_to_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | +| void | :ref:`add_control_to_dock` **(** :ref:`DockSlot` slot, :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +| void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +| void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +| void | :ref:`add_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +| void | :ref:`add_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_menu_item` **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** | +| void | :ref:`add_tool_menu_item` **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | +| void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_changes` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -48,63 +47,63 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +| void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** virtual | +| :ref:`bool` | :ref:`forward_canvas_gui_input` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +| void | :ref:`forward_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`forward_force_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +| void | :ref:`forward_force_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +| :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +| :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | +| :ref:`Object` | :ref:`get_plugin_icon` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +| :ref:`String` | :ref:`get_plugin_name` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | +| :ref:`ScriptCreateDialog` | :ref:`get_script_create_dialog` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | +| :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | +| :ref:`UndoRedo` | :ref:`get_undo_redo` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +| void | :ref:`get_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | +| :ref:`bool` | :ref:`handles` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_main_screen` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide_bottom_panel` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | +| void | :ref:`make_bottom_panel_item_visible` **(** :ref:`Control` item **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_save_layout` **(** **)** const | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | +| void | :ref:`remove_autoload_singleton` **(** :ref:`String` name **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | +| void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | +| void | :ref:`remove_control_from_container` **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | +| void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +| void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +| void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +| void | :ref:`remove_inspector_plugin` **(** :ref:`EditorInspectorPlugin` plugin **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +| void | :ref:`remove_scene_import_plugin` **(** :ref:`EditorSceneImporter` scene_importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | +| void | :ref:`remove_tool_menu_item` **(** :ref:`String` name **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -112,9 +111,9 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | +| void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +| void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`update_overlays` **(** **)** const | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -124,29 +123,29 @@ Signals .. _class_EditorPlugin_main_screen_changed: -- **main_screen_changed** **(** :ref:`String` screen_name **)** +- **main_screen_changed** **(** :ref:`String` screen_name **)** Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. .. _class_EditorPlugin_resource_saved: -- **resource_saved** **(** :ref:`Object` resource **)** +- **resource_saved** **(** :ref:`Resource` resource **)** .. _class_EditorPlugin_scene_changed: -- **scene_changed** **(** :ref:`Object` scene_root **)** +- **scene_changed** **(** :ref:`Node` scene_root **)** Emitted when user change scene. The argument is a root node of freshly opened scene. .. _class_EditorPlugin_scene_closed: -- **scene_closed** **(** :ref:`String` filepath **)** +- **scene_closed** **(** :ref:`String` filepath **)** Emitted when user close scene. The argument is file path to a closed scene. -Enums ------ +Enumerations +------------ .. _enum_EditorPlugin_DockSlot: @@ -168,12 +167,14 @@ enum **CustomControlContainer** - **CONTAINER_TOOLBAR** = **0** - **CONTAINER_SPATIAL_EDITOR_MENU** = **1** -- **CONTAINER_SPATIAL_EDITOR_SIDE** = **2** -- **CONTAINER_SPATIAL_EDITOR_BOTTOM** = **3** -- **CONTAINER_CANVAS_EDITOR_MENU** = **4** -- **CONTAINER_CANVAS_EDITOR_SIDE** = **5** -- **CONTAINER_CANVAS_EDITOR_BOTTOM** = **6** -- **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **7** +- **CONTAINER_SPATIAL_EDITOR_SIDE_LEFT** = **2** +- **CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT** = **3** +- **CONTAINER_SPATIAL_EDITOR_BOTTOM** = **4** +- **CONTAINER_CANVAS_EDITOR_MENU** = **5** +- **CONTAINER_CANVAS_EDITOR_SIDE_LEFT** = **6** +- **CONTAINER_CANVAS_EDITOR_SIDE_RIGHT** = **7** +- **CONTAINER_CANVAS_EDITOR_BOTTOM** = **8** +- **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **9** Description @@ -186,24 +187,24 @@ Tutorials - :doc:`../development/plugins/index` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorPlugin_add_autoload_singleton: -- void **add_autoload_singleton** **(** :ref:`String` name, :ref:`String` path **)** +- void **add_autoload_singleton** **(** :ref:`String` name, :ref:`String` path **)** Add a script at ``path`` to the Autoload list as ``name``. .. _class_EditorPlugin_add_control_to_bottom_panel: -- :ref:`ToolButton` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** +- :ref:`ToolButton` **add_control_to_bottom_panel** **(** :ref:`Control` control, :ref:`String` title **)** Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_bottom_panel`. .. _class_EditorPlugin_add_control_to_container: -- void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** +- void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** Add a custom control to a container (see CONTAINER\_\* enum). There are many locations where custom controls can be added in the editor UI. @@ -213,7 +214,7 @@ If your plugin is being removed, also make sure to remove your custom controls t .. _class_EditorPlugin_add_control_to_dock: -- void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** +- void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** Add the control to a specific dock slot (see DOCK\_\* enum for options). @@ -223,7 +224,7 @@ If your plugin is being removed, also make sure to remove your control by callin .. _class_EditorPlugin_add_custom_type: -- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** +- void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. @@ -235,29 +236,29 @@ During run-time, this will be a simple object with a script so this function doe .. _class_EditorPlugin_add_export_plugin: -- void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +- void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** .. _class_EditorPlugin_add_import_plugin: -- void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +- void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_add_inspector_plugin: -- void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** +- void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** .. _class_EditorPlugin_add_scene_import_plugin: -- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** +- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** .. _class_EditorPlugin_add_tool_menu_item: -- void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** +- void **add_tool_menu_item** **(** :ref:`String` name, :ref:`Object` handler, :ref:`String` callback, :ref:`Variant` ud=null **)** Adds a custom menu to 'Project > Tools' as ``name`` that calls ``callback`` on an instance of ``handler`` with a parameter ``ud`` when user activates it. .. _class_EditorPlugin_add_tool_submenu_item: -- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** +- void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** .. _class_EditorPlugin_apply_changes: @@ -279,25 +280,25 @@ Clear all the state and reset the object being edited to zero. This ensures your .. _class_EditorPlugin_edit: -- void **edit** **(** :ref:`Object` object **)** virtual +- void **edit** **(** :ref:`Object` object **)** virtual This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. .. _class_EditorPlugin_forward_canvas_gui_input: -- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_canvas_gui_input** **(** :ref:`InputEvent` event **)** virtual .. _class_EditorPlugin_forward_draw_over_viewport: -- void **forward_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual +- void **forward_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual .. _class_EditorPlugin_forward_force_draw_over_viewport: -- void **forward_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual +- void **forward_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual .. _class_EditorPlugin_forward_spatial_gui_input: -- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual +- :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual Implement this function if you are interested in 3D view screen input events. It will be called only if currently selected node is handled by your plugin. @@ -305,49 +306,49 @@ If you would like to always gets those input events then additionally use :ref:` .. _class_EditorPlugin_get_breakpoints: -- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual +- :ref:`PoolStringArray` **get_breakpoints** **(** **)** virtual This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 .. _class_EditorPlugin_get_editor_interface: -- :ref:`EditorInterface` **get_editor_interface** **(** **)** +- :ref:`EditorInterface` **get_editor_interface** **(** **)** .. _class_EditorPlugin_get_plugin_icon: -- :ref:`Object` **get_plugin_icon** **(** **)** virtual +- :ref:`Object` **get_plugin_icon** **(** **)** virtual .. _class_EditorPlugin_get_plugin_name: -- :ref:`String` **get_plugin_name** **(** **)** virtual +- :ref:`String` **get_plugin_name** **(** **)** virtual .. _class_EditorPlugin_get_script_create_dialog: -- :ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** +- :ref:`ScriptCreateDialog` **get_script_create_dialog** **(** **)** Gets the Editor's dialogue used for making scripts. Note that users can configure it before use. .. _class_EditorPlugin_get_state: -- :ref:`Dictionary` **get_state** **(** **)** virtual +- :ref:`Dictionary` **get_state** **(** **)** virtual Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). .. _class_EditorPlugin_get_undo_redo: -- :ref:`UndoRedo` **get_undo_redo** **(** **)** +- :ref:`UndoRedo` **get_undo_redo** **(** **)** Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. .. _class_EditorPlugin_get_window_layout: -- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **get_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Get the GUI layout of the plugin. This is used to save the project's editor layout when the :ref:`EditorPlugin.queue_save_layout` is called or the editor layout was changed(For example changing the position of a dock). .. _class_EditorPlugin_handles: -- :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual +- :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions :ref:`EditorPlugin.edit` and :ref:`EditorPlugin.make_visible` called when the editor requests them. @@ -363,7 +364,7 @@ Return true if this is a main screen editor plugin (it goes in the main screen s .. _class_EditorPlugin_make_bottom_panel_item_visible: -- void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** +- void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** .. _class_EditorPlugin_make_visible: @@ -381,53 +382,53 @@ Queue save the project's editor layout. .. _class_EditorPlugin_remove_autoload_singleton: -- void **remove_autoload_singleton** **(** :ref:`String` name **)** +- void **remove_autoload_singleton** **(** :ref:`String` name **)** Remove an Autoload ``name`` from the list. .. _class_EditorPlugin_remove_control_from_bottom_panel: -- void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** +- void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. .. _class_EditorPlugin_remove_control_from_container: -- void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** +- void **remove_control_from_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** Remove the control from the specified container. Use it when cleaning up after adding a control with :ref:`add_control_to_container`. Note that you can simply free the control if you won't use it anymore. .. _class_EditorPlugin_remove_control_from_docks: -- void **remove_control_from_docks** **(** :ref:`Control` control **)** +- void **remove_control_from_docks** **(** :ref:`Control` control **)** Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly. .. _class_EditorPlugin_remove_custom_type: -- void **remove_custom_type** **(** :ref:`String` type **)** +- void **remove_custom_type** **(** :ref:`String` type **)** Remove a custom type added by :ref:`EditorPlugin.add_custom_type` .. _class_EditorPlugin_remove_export_plugin: -- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** +- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** .. _class_EditorPlugin_remove_import_plugin: -- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** +- void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** .. _class_EditorPlugin_remove_inspector_plugin: -- void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** +- void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** .. _class_EditorPlugin_remove_scene_import_plugin: -- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** +- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** .. _class_EditorPlugin_remove_tool_menu_item: -- void **remove_tool_menu_item** **(** :ref:`String` name **)** +- void **remove_tool_menu_item** **(** :ref:`String` name **)** Removes a menu ``name`` from 'Project > Tools'. @@ -449,13 +450,13 @@ Use this method if you always want to receive inputs from 3D view screen inside .. _class_EditorPlugin_set_state: -- void **set_state** **(** :ref:`Dictionary` state **)** virtual +- void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`EditorPlugin.get_state`. .. _class_EditorPlugin_set_window_layout: -- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual +- void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 4c76674f6..ad9767eb0 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -7,8 +7,7 @@ EditorProperty ============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_edited_object` **(** **)** | +| :ref:`Object` | :ref:`get_edited_object` **(** **)** | +------------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_edited_property` **(** **)** | +| :ref:`String` | :ref:`get_edited_property` **(** **)** | +------------------------------+----------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | +| :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------+ | void | :ref:`update_property` **(** **)** virtual | +------------------------------+----------------------------------------------------------------------------------+ @@ -34,39 +33,39 @@ Signals .. _class_EditorProperty_multiple_properties_changed: -- **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** +- **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** .. _class_EditorProperty_object_id_selected: -- **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** +- **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** .. _class_EditorProperty_property_changed: -- **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** +- **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** .. _class_EditorProperty_property_checked: -- **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** +- **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** .. _class_EditorProperty_property_keyed: -- **property_keyed** **(** :ref:`String` property **)** +- **property_keyed** **(** :ref:`String` property **)** .. _class_EditorProperty_property_keyed_with_value: -- **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** +- **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** .. _class_EditorProperty_resource_selected: -- **resource_selected** **(** :ref:`String` path, :ref:`Object` resource **)** +- **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** .. _class_EditorProperty_selected: -- **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** +- **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_EditorProperty_checkable: @@ -86,27 +85,27 @@ Member Variables .. _class_EditorProperty_label: -- :ref:`String` **label** +- :ref:`String` **label** .. _class_EditorProperty_read_only: - :ref:`bool` **read_only** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorProperty_get_edited_object: -- :ref:`Object` **get_edited_object** **(** **)** +- :ref:`Object` **get_edited_object** **(** **)** .. _class_EditorProperty_get_edited_property: -- :ref:`String` **get_edited_property** **(** **)** +- :ref:`String` **get_edited_property** **(** **)** .. _class_EditorProperty_get_tooltip_text: -- :ref:`String` **get_tooltip_text** **(** **)** const +- :ref:`String` **get_tooltip_text** **(** **)** const .. _class_EditorProperty_update_property: diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 9ea967a8c..64b09e647 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -7,8 +7,7 @@ EditorResourceConversionPlugin ============================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,24 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | +| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_converts_to` **(** **)** virtual | +| :ref:`String` | :ref:`_converts_to` **(** **)** virtual | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorResourceConversionPlugin__convert: -- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual +- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual .. _class_EditorResourceConversionPlugin__converts_to: -- :ref:`String` **_converts_to** **(** **)** virtual +- :ref:`String` **_converts_to** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 51a206757..57b437db1 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -7,8 +7,7 @@ EditorResourcePreview ===================== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description Helper to generate previews of resources or files. -Member Functions ----------------- +Methods +------- +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +| void | :ref:`add_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | +| void | :ref:`check_for_invalidation` **(** :ref:`String` path **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +| void | :ref:`queue_edited_resource_preview` **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +| void | :ref:`queue_resource_preview` **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +| void | :ref:`remove_preview_generator` **(** :ref:`EditorResourcePreviewGenerator` generator **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -36,7 +35,7 @@ Signals .. _class_EditorResourcePreview_preview_invalidated: -- **preview_invalidated** **(** :ref:`String` path **)** +- **preview_invalidated** **(** :ref:`String` path **)** If a preview was invalidated (changed) this signal will emit (using the path of the preview) @@ -46,36 +45,36 @@ Description This object is used to generate previews for resources of files. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorResourcePreview_add_preview_generator: -- void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +- void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. .. _class_EditorResourcePreview_check_for_invalidation: -- void **check_for_invalidation** **(** :ref:`String` path **)** +- void **check_for_invalidation** **(** :ref:`String` path **)** Check if the resource changed, if so it will be invalidated and the corresponding signal emitted. .. _class_EditorResourcePreview_queue_edited_resource_preview: -- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_edited_resource_preview** **(** :ref:`Resource` resource, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. .. _class_EditorResourcePreview_queue_resource_preview: -- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** +- void **queue_resource_preview** **(** :ref:`String` path, :ref:`Object` receiver, :ref:`String` receiver_func, :ref:`Variant` userdata **)** Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texture (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. .. _class_EditorResourcePreview_remove_preview_generator: -- void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** +- void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Remove a custom preview generator. diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 40d52d8e9..26a1aef56 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -7,8 +7,7 @@ EditorResourcePreviewGenerator ============================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Custom generator of previews. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | +| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | +| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | +| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -32,12 +31,12 @@ Description Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorResourcePreviewGenerator_generate: -- :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual +- :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual Generate a preview from a given resource. This must be always implemented. @@ -47,7 +46,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_generate_from_path: -- :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual +- :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual Generate a preview directly from a path, implementing this is optional, as default code will load and call generate() @@ -57,7 +56,7 @@ Care must be taken because this function is always called from a thread (not the .. _class_EditorResourcePreviewGenerator_handles: -- :ref:`bool` **handles** **(** :ref:`String` type **)** virtual +- :ref:`bool` **handles** **(** :ref:`String` type **)** virtual Return if your generator supports this resource type. diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index b4c31edc1..4681df058 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -7,8 +7,7 @@ EditorSceneImporter =================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,25 +15,25 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_extensions` **(** **)** virtual | +| :ref:`Array` | :ref:`_get_extensions` **(** **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_import_flags` **(** **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +| :ref:`Animation` | :ref:`_import_animation` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +| :ref:`Node` | :ref:`_import_scene` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | +| :ref:`Animation` | :ref:`import_animation_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | +| :ref:`Node` | :ref:`import_scene_from_other_importer` **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ +Constants +--------- - **IMPORT_SCENE** = **1** - **IMPORT_ANIMATION** = **2** @@ -47,12 +46,12 @@ Numeric Constants - **IMPORT_MATERIALS_IN_INSTANCES** = **1024** - **IMPORT_USE_COMPRESSION** = **2048** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorSceneImporter__get_extensions: -- :ref:`Array` **_get_extensions** **(** **)** virtual +- :ref:`Array` **_get_extensions** **(** **)** virtual .. _class_EditorSceneImporter__get_import_flags: @@ -60,18 +59,18 @@ Member Function Description .. _class_EditorSceneImporter__import_animation: -- :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +- :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual .. _class_EditorSceneImporter__import_scene: -- :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual +- :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual .. _class_EditorSceneImporter_import_animation_from_other_importer: -- :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** +- :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** .. _class_EditorSceneImporter_import_scene_from_other_importer: -- :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** +- :ref:`Node` **import_scene_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index cd527d187..710e1af15 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -7,8 +7,7 @@ EditorScenePostImport ===================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Post process scenes after import -Member Functions ----------------- +Methods +------- +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_file` **(** **)** const | +| :ref:`String` | :ref:`get_source_file` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_source_folder` **(** **)** const | +| :ref:`String` | :ref:`get_source_folder` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | +| :ref:`Object` | :ref:`post_import` **(** :ref:`Object` scene **)** virtual | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ Description @@ -37,24 +36,24 @@ Tutorials - `http://docs.godotengine.org/en/latest/learning/workflow/assets/importing_scenes.html?highlight=post%20import `_ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorScenePostImport_get_source_file: -- :ref:`String` **get_source_file** **(** **)** const +- :ref:`String` **get_source_file** **(** **)** const Returns the source-file-path which got imported (e.g. ``res://scene.dae`` ) .. _class_EditorScenePostImport_get_source_folder: -- :ref:`String` **get_source_folder** **(** **)** const +- :ref:`String` **get_source_folder** **(** **)** const Returns the resource-folder the imported scene-file is located in .. _class_EditorScenePostImport_post_import: -- :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual +- :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual Gets called after the scene got imported and has to return the modified version of the scene diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index 2df5dea2c..7041b5a29 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -7,8 +7,7 @@ EditorScript ============ -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description Base script that can be used to add extension functions to the editor. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-------------------------------------------------------------------------------------------------+ | void | :ref:`_run` **(** **)** virtual | +------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | +| void | :ref:`add_root_node` **(** :ref:`Node` node **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +| :ref:`EditorInterface` | :ref:`get_editor_interface` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_scene` **(** **)** | +| :ref:`Node` | :ref:`get_scene` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------+ Description ----------- -Scripts extending this class and implementing its ``_run()`` method can be executed from the Script Editor's ``File -> Run`` menu option (or by pressing ``CTRL+Shift+X``) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using :ref:`EditorPlugin`\ s instead. Note that extending scripts need to have ``tool mode`` enabled. +Scripts extending this class and implementing its ``_run()`` method can be executed from the Script Editor's ``File -> Run`` menu option (or by pressing ``CTRL+Shift+X``) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using :ref:`EditorPlugin`\ s instead. Note that extending scripts need to have ``tool mode`` enabled. Example script: @@ -46,8 +45,8 @@ Example script: Note that the script is run in the Editor context, which means the output is visible in the console window started with the Editor (STDOUT) instead of the usual Godot *Output* dock. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorScript__run: @@ -57,7 +56,7 @@ This method is executed by the Editor when ``File -> Run`` is used. .. _class_EditorScript_add_root_node: -- void **add_root_node** **(** :ref:`Node` node **)** +- void **add_root_node** **(** :ref:`Node` node **)** Adds ``node`` as a child of the root node in the editor context. @@ -65,13 +64,13 @@ WARNING: The implementation of this method is currently disabled. .. _class_EditorScript_get_editor_interface: -- :ref:`EditorInterface` **get_editor_interface** **(** **)** +- :ref:`EditorInterface` **get_editor_interface** **(** **)** -Returns the :ref:`EditorInterface` singleton instance. +Returns the :ref:`EditorInterface` singleton instance. .. _class_EditorScript_get_scene: -- :ref:`Node` **get_scene** **(** **)** +- :ref:`Node` **get_scene** **(** **)** Returns the Editor's currently active scene. diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 4c8292fcf..f6d4099a3 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -7,8 +7,7 @@ EditorSelection =============== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description Manages the SceneTree selection in the editor. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Node` node **)** | +| void | :ref:`add_node` **(** :ref:`Node` node **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | +| :ref:`Array` | :ref:`get_selected_nodes` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | +| :ref:`Array` | :ref:`get_transformable_selected_nodes` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Node` node **)** | +| void | :ref:`remove_node` **(** :ref:`Node` node **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ Signals @@ -46,12 +45,12 @@ Description This object manages the SceneTree selection in the editor. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorSelection_add_node: -- void **add_node** **(** :ref:`Node` node **)** +- void **add_node** **(** :ref:`Node` node **)** Add a node to the selection. @@ -63,19 +62,19 @@ Clear the selection. .. _class_EditorSelection_get_selected_nodes: -- :ref:`Array` **get_selected_nodes** **(** **)** +- :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. .. _class_EditorSelection_get_transformable_selected_nodes: -- :ref:`Array` **get_transformable_selected_nodes** **(** **)** +- :ref:`Array` **get_transformable_selected_nodes** **(** **)** Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild. .. _class_EditorSelection_remove_node: -- void **remove_node** **(** :ref:`Node` node **)** +- void **remove_node** **(** :ref:`Node` node **)** Remove a node from the selection. diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 2009c9854..f5df32f7b 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -7,8 +7,7 @@ EditorSettings ============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,41 +15,41 @@ Brief Description Object that holds the project-independent editor settings. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | +| void | :ref:`add_property_info` **(** :ref:`Dictionary` info **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`String` property **)** | +| void | :ref:`erase` **(** :ref:`String` property **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +| :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_project_settings_dir` **(** **)** const | +| :ref:`String` | :ref:`get_project_settings_dir` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_recent_dirs` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_settings_dir` **(** **)** const | +| :ref:`String` | :ref:`get_settings_dir` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | +| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | +| void | :ref:`set_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | +| void | :ref:`set_recent_dirs` **(** :ref:`PoolStringArray` dirs **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -66,7 +65,7 @@ Description Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu. -Accessing the settings is done by using the regular :ref:`Object` API, such as: +Accessing the settings is done by using the regular :ref:`Object` API, such as: :: @@ -74,14 +73,14 @@ Accessing the settings is done by using the regular :ref:`Object` settings.get(prop) list_of_settings = settings.get_property_list() -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorSettings_add_property_info: -- void **add_property_info** **(** :ref:`Dictionary` info **)** +- void **add_property_info** **(** :ref:`Dictionary` info **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: @@ -100,39 +99,39 @@ Example: .. _class_EditorSettings_erase: -- void **erase** **(** :ref:`String` property **)** +- void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). .. _class_EditorSettings_get_favorite_dirs: -- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const Get the list of favorite directories for this project. .. _class_EditorSettings_get_project_metadata: -- :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const +- :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const .. _class_EditorSettings_get_project_settings_dir: -- :ref:`String` **get_project_settings_dir** **(** **)** const +- :ref:`String` **get_project_settings_dir** **(** **)** const Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. .. _class_EditorSettings_get_recent_dirs: -- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. .. _class_EditorSettings_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const .. _class_EditorSettings_get_settings_dir: -- :ref:`String` **get_settings_dir** **(** **)** const +- :ref:`String` **get_settings_dir** **(** **)** const Get the global settings path for the engine. Inside this path you can find some standard paths such as: @@ -142,38 +141,38 @@ settings/templates - where export templates are located .. _class_EditorSettings_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const .. _class_EditorSettings_property_can_revert: -- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** .. _class_EditorSettings_property_get_revert: -- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** .. _class_EditorSettings_set_favorite_dirs: -- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of favorite directories for this project. .. _class_EditorSettings_set_initial_value: -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** .. _class_EditorSettings_set_project_metadata: -- void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** +- void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** .. _class_EditorSettings_set_recent_dirs: -- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_recent_dirs** **(** :ref:`PoolStringArray` dirs **)** Set the list of recently visited folders in the file dialog for this project. .. _class_EditorSettings_set_setting: -- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index fbe45a1c8..f611f3cef 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -7,8 +7,7 @@ EditorSpatialGizmo ================== -**Inherits:** :ref:`SpatialGizmo` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`SpatialGizmo` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,37 +15,37 @@ Brief Description Custom gizmo for editing Spatial objects. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | +| void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | +| void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | +| void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | +| void | :ref:`add_mesh` **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | +| void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | +| void | :ref:`commit_handle` **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | +| :ref:`String` | :ref:`get_handle_name` **(** :ref:`int` index **)** virtual | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | +| :ref:`Variant` | :ref:`get_handle_value` **(** :ref:`int` index **)** virtual | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`redraw` **(** **)** virtual | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | +| void | :ref:`set_handle` **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hidden` **(** :ref:`bool` hidden **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | +| void | :ref:`set_spatial_node` **(** :ref:`Node` node **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -54,22 +53,22 @@ Description Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by :ref:`EditorPlugin.create_spatial_gizmo`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EditorSpatialGizmo_add_collision_segments: -- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** +- void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** -Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. +Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh` can be generated from a regular :ref:`Mesh` too. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_handles: -- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** +- void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** Add a list of handles (points) which can be used to deform the object being edited. @@ -77,17 +76,17 @@ There are virtual functions which will be called upon editing of these handles. .. _class_EditorSpatialGizmo_add_lines: -- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** +- void **add_lines** **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw`. .. _class_EditorSpatialGizmo_add_mesh: -- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** +- void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** .. _class_EditorSpatialGizmo_add_unscaled_billboard: -- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** +- void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. @@ -97,7 +96,7 @@ Add an unscaled billboard for visualization. Call this function during :ref:`red .. _class_EditorSpatialGizmo_commit_handle: -- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual +- void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual Commit a handle being edited (handles must have been previously added by :ref:`add_handles`). @@ -105,7 +104,7 @@ If the cancel parameter is true, an option to restore the edited value to the or .. _class_EditorSpatialGizmo_get_handle_name: -- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual +- :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual Get the name of an edited handle (handles must have been previously added by :ref:`add_handles`). @@ -113,7 +112,7 @@ Handles can be named for reference to the user when editing. .. _class_EditorSpatialGizmo_get_handle_value: -- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual +- :ref:`Variant` **get_handle_value** **(** :ref:`int` index **)** virtual Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling :ref:`commit_handle` @@ -125,11 +124,11 @@ This function is called when the Spatial this gizmo refers to changes (the :ref: .. _class_EditorSpatialGizmo_set_handle: -- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual +- void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual This function is used when the user drags a gizmo handle (previously added with :ref:`add_handles`) in screen coordinates. -The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. +The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. .. _class_EditorSpatialGizmo_set_hidden: @@ -137,6 +136,6 @@ The :ref:`Camera` is also provided so screen coordinates can be co .. _class_EditorSpatialGizmo_set_spatial_node: -- void **set_spatial_node** **(** :ref:`Node` node **)** +- void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index ee319bdcb..18e0c71c9 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -7,8 +7,7 @@ EncodedObjectAsID ================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_object_id` **(** **)** const | @@ -25,8 +24,8 @@ Member Functions | void | :ref:`set_object_id` **(** :ref:`int` id **)** | +------------------------+--------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_EncodedObjectAsID_get_object_id: diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 23736a214..3e95a2466 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -7,8 +7,7 @@ Engine ====== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,37 +15,42 @@ Brief Description Access to basic engine properties. -Member Functions ----------------- +Methods +------- +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_author_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_author_info` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_copyright_info` **(** **)** const | +| :ref:`Array` | :ref:`get_copyright_info` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_donor_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_donor_info` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frames_drawn` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_frames_per_second` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_license_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_license_info` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_license_text` **(** **)** const | +| :ref:`String` | :ref:`get_license_text` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | +| :ref:`MainLoop` | :ref:`get_main_loop` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_in_physics_frame` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +The ``Engine`` class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. + +Property Descriptions +--------------------- .. _class_Engine_editor_hint: @@ -69,17 +73,12 @@ Member Variables - :ref:`float` **time_scale** - Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. -Description ------------ - -The ``Engine`` class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Engine_get_author_info: -- :ref:`Dictionary` **get_author_info** **(** **)** const +- :ref:`Dictionary` **get_author_info** **(** **)** const Returns engine author information in a Dictionary. @@ -93,7 +92,7 @@ Returns engine author information in a Dictionary. .. _class_Engine_get_copyright_info: -- :ref:`Array` **get_copyright_info** **(** **)** const +- :ref:`Array` **get_copyright_info** **(** **)** const Returns an Array of copyright information Dictionaries. @@ -103,7 +102,7 @@ Returns an Array of copyright information Dictionaries. .. _class_Engine_get_donor_info: -- :ref:`Dictionary` **get_donor_info** **(** **)** const +- :ref:`Dictionary` **get_donor_info** **(** **)** const Returns a Dictionary of Arrays of donor names. @@ -123,29 +122,29 @@ Returns the frames per second of the running game. .. _class_Engine_get_license_info: -- :ref:`Dictionary` **get_license_info** **(** **)** const +- :ref:`Dictionary` **get_license_info** **(** **)** const Returns Dictionary of licenses used by Godot and included third party components. .. _class_Engine_get_license_text: -- :ref:`String` **get_license_text** **(** **)** const +- :ref:`String` **get_license_text** **(** **)** const Returns Godot license text. .. _class_Engine_get_main_loop: -- :ref:`MainLoop` **get_main_loop** **(** **)** const +- :ref:`MainLoop` **get_main_loop** **(** **)** const -Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). +Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). .. _class_Engine_get_singleton: -- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const +- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const .. _class_Engine_get_version_info: -- :ref:`Dictionary` **get_version_info** **(** **)** const +- :ref:`Dictionary` **get_version_info** **(** **)** const Returns the current engine version information in a Dictionary. @@ -163,7 +162,7 @@ Returns the current engine version information in a Dictionary. .. _class_Engine_has_singleton: -- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const +- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const .. _class_Engine_is_in_physics_frame: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 6a9fde832..646e764d7 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -7,17 +7,98 @@ Environment =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple rendering options. +Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple rendering options. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Environment_BGMode: + +enum **BGMode** + +- **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background. +- **BG_CLEAR_COLOR** = **0** --- Clear the background using the project's clear color. +- **BG_COLOR** = **1** --- Clear the background using a custom clear color. +- **BG_SKY** = **2** --- Display a user-defined sky in the background. +- **BG_COLOR_SKY** = **3** --- Clear the background using a custom clear color and allows defining a sky for shading and reflection. +- **BG_CANVAS** = **4** --- Display a :ref:`CanvasLayer` in the background. +- **BG_MAX** = **6** --- Helper constant keeping track of the enum's size, has no direct usage in API calls. + + .. _enum_Environment_DOFBlurQuality: + +enum **DOFBlurQuality** + +- **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. +- **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. +- **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality. + + .. _enum_Environment_GlowBlendMode: + +enum **GlowBlendMode** + +- **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. +- **GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom. +- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. +- **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value. + + .. _enum_Environment_ToneMapper: + +enum **ToneMapper** + +- **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. +- **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color). +- **TONE_MAPPER_FILMIC** = **2** --- Filmic tonemapper operator. +- **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator. + + .. _enum_Environment_SSAOBlur: + +enum **SSAOBlur** + +- **SSAO_BLUR_DISABLED** = **0** +- **SSAO_BLUR_1x1** = **1** +- **SSAO_BLUR_2x2** = **2** +- **SSAO_BLUR_3x3** = **3** + + .. _enum_Environment_SSAOQuality: + +enum **SSAOQuality** + +- **SSAO_QUALITY_LOW** = **0** +- **SSAO_QUALITY_MEDIUM** = **1** +- **SSAO_QUALITY_HIGH** = **2** + + +Description +----------- + +Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple environment operations (such as background :ref:`Sky` or :ref:`Color`, ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: + + + +- DOF Blur + +- Motion Blur + +- Bloom + +- Tonemap (auto exposure) + +- Adjustments + +Tutorials +--------- + +- :doc:`../tutorials/3d/environment_and_post_processing` +- :doc:`../tutorials/3d/high_dynamic_range` + +Property Descriptions +--------------------- .. _class_Environment_adjustment_brightness: @@ -25,7 +106,7 @@ Member Variables .. _class_Environment_adjustment_color_correction: -- :ref:`Texture` **adjustment_color_correction** - Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. +- :ref:`Texture` **adjustment_color_correction** - Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. .. _class_Environment_adjustment_contrast: @@ -41,7 +122,7 @@ Member Variables .. _class_Environment_ambient_light_color: -- :ref:`Color` **ambient_light_color** - :ref:`Color` of the ambient light. +- :ref:`Color` **ambient_light_color** - :ref:`Color` of the ambient light. .. _class_Environment_ambient_light_energy: @@ -77,7 +158,7 @@ Member Variables .. _class_Environment_background_color: -- :ref:`Color` **background_color** - Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). +- :ref:`Color` **background_color** - Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). .. _class_Environment_background_energy: @@ -85,15 +166,15 @@ Member Variables .. _class_Environment_background_mode: -- :ref:`BGMode` **background_mode** - Defines the mode of background. +- :ref:`BGMode` **background_mode** - Defines the mode of background. .. _class_Environment_background_sky: -- :ref:`Sky` **background_sky** - :ref:`Sky` resource defined as background. +- :ref:`Sky` **background_sky** - :ref:`Sky` resource defined as background. .. _class_Environment_background_sky_custom_fov: -- :ref:`float` **background_sky_custom_fov** - :ref:`Sky` resource's custom field of view. +- :ref:`float` **background_sky_custom_fov** - :ref:`Sky` resource's custom field of view. .. _class_Environment_dof_blur_far_amount: @@ -109,7 +190,7 @@ Member Variables .. _class_Environment_dof_blur_far_quality: -- :ref:`DOFBlurQuality` **dof_blur_far_quality** - Quality of the far blur quality. +- :ref:`DOFBlurQuality` **dof_blur_far_quality** - Quality of the far blur quality. .. _class_Environment_dof_blur_far_transition: @@ -129,7 +210,7 @@ Member Variables .. _class_Environment_dof_blur_near_quality: -- :ref:`DOFBlurQuality` **dof_blur_near_quality** - Quality of the near blur quality. +- :ref:`DOFBlurQuality` **dof_blur_near_quality** - Quality of the near blur quality. .. _class_Environment_dof_blur_near_transition: @@ -137,7 +218,7 @@ Member Variables .. _class_Environment_fog_color: -- :ref:`Color` **fog_color** - Fog's :ref:`Color`. +- :ref:`Color` **fog_color** - Fog's :ref:`Color`. .. _class_Environment_fog_depth_begin: @@ -177,7 +258,7 @@ Member Variables .. _class_Environment_fog_sun_color: -- :ref:`Color` **fog_sun_color** - Sun :ref:`Color`. +- :ref:`Color` **fog_sun_color** - Sun :ref:`Color`. .. _class_Environment_fog_transmit_curve: @@ -193,7 +274,7 @@ Member Variables .. _class_Environment_glow_blend_mode: -- :ref:`GlowBlendMode` **glow_blend_mode** - Glow blending mode. +- :ref:`GlowBlendMode` **glow_blend_mode** - Glow blending mode. .. _class_Environment_glow_bloom: @@ -281,11 +362,11 @@ Member Variables .. _class_Environment_ssao_blur: -- :ref:`SSAOBlur` **ssao_blur** +- :ref:`SSAOBlur` **ssao_blur** .. _class_Environment_ssao_color: -- :ref:`Color` **ssao_color** +- :ref:`Color` **ssao_color** .. _class_Environment_ssao_edge_sharpness: @@ -309,7 +390,7 @@ Member Variables .. _class_Environment_ssao_quality: -- :ref:`SSAOQuality` **ssao_quality** +- :ref:`SSAOQuality` **ssao_quality** .. _class_Environment_ssao_radius: @@ -325,92 +406,10 @@ Member Variables .. _class_Environment_tonemap_mode: -- :ref:`ToneMapper` **tonemap_mode** - Tonemapping mode. +- :ref:`ToneMapper` **tonemap_mode** - Tonemapping mode. .. _class_Environment_tonemap_white: - :ref:`float` **tonemap_white** - White reference value for tonemap. -Enums ------ - - .. _enum_Environment_BGMode: - -enum **BGMode** - -- **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background. -- **BG_CLEAR_COLOR** = **0** --- Clear the background using the project's clear color. -- **BG_COLOR** = **1** --- Clear the background using a custom clear color. -- **BG_SKY** = **2** --- Display a user-defined sky in the background. -- **BG_COLOR_SKY** = **3** --- Clear the background using a custom clear color and allows defining a sky for shading and reflection. -- **BG_CANVAS** = **4** --- Display a :ref:`CanvasLayer` in the background. -- **BG_MAX** = **6** --- Helper constant keeping track of the enum's size, has no direct usage in API calls. - - .. _enum_Environment_DOFBlurQuality: - -enum **DOFBlurQuality** - -- **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality. -- **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality. -- **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality. - - .. _enum_Environment_GlowBlendMode: - -enum **GlowBlendMode** - -- **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. -- **GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom. -- **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom. -- **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value. - - .. _enum_Environment_ToneMapper: - -enum **ToneMapper** - -- **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. -- **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color). -- **TONE_MAPPER_FILMIC** = **2** --- Filmic tonemapper operator. -- **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator. - - .. _enum_Environment_SSAOBlur: - -enum **SSAOBlur** - -- **SSAO_BLUR_DISABLED** = **0** -- **SSAO_BLUR_1x1** = **1** -- **SSAO_BLUR_2x2** = **2** -- **SSAO_BLUR_3x3** = **3** - - .. _enum_Environment_SSAOQuality: - -enum **SSAOQuality** - -- **SSAO_QUALITY_LOW** = **0** -- **SSAO_QUALITY_MEDIUM** = **1** -- **SSAO_QUALITY_HIGH** = **2** - - -Description ------------ - -Resource for environment nodes (like :ref:`WorldEnvironment`) that define multiple environment operations (such as background :ref:`Sky` or :ref:`Color`, ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: - - - -- DOF Blur - -- Motion Blur - -- Bloom - -- Tonemap (auto exposure) - -- Adjustments - -Tutorials ---------- - -- :doc:`../tutorials/3d/environment_and_post_processing` -- :doc:`../tutorials/3d/high_dynamic_range` - diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 2b8d93fe5..534a0b317 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -7,8 +7,7 @@ Expression ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,29 +15,29 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`execute` **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** | +| :ref:`Variant` | :ref:`execute` **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_error_text` **(** **)** const | +| :ref:`String` | :ref:`get_error_text` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_execute_failed` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | +| :ref:`Error` | :ref:`parse` **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Expression_execute: -- :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** +- :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** .. _class_Expression_get_error_text: -- :ref:`String` **get_error_text** **(** **)** const +- :ref:`String` **get_error_text** **(** **)** const .. _class_Expression_has_execute_failed: @@ -46,6 +45,6 @@ Member Function Description .. _class_Expression_parse: -- :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** +- :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index bc0a850b0..fa8ce10b8 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -7,8 +7,7 @@ File ==== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Type to handle file reading and writing operations. -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`eof_reached` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_16` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,49 +33,49 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_8` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | +| :ref:`String` | :ref:`get_as_text` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_double` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_error` **(** **)** const | +| :ref:`Error` | :ref:`get_error` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_float` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_len` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | +| :ref:`String` | :ref:`get_line` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pascal_string` **(** **)** | +| :ref:`String` | :ref:`get_pascal_string` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | +| :ref:`String` | :ref:`get_path` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | +| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_position` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_real` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | +| :ref:`Variant` | :ref:`get_var` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_open` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | +| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | +| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | +| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | +| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`seek` **(** :ref:`int` position **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,35 +89,25 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`store_8` **(** :ref:`int` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`store_double` **(** :ref:`float` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`store_float` **(** :ref:`float` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | +| void | :ref:`store_line` **(** :ref:`String` line **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`store_real` **(** :ref:`float` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | +| void | :ref:`store_string` **(** :ref:`String` string **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value **)** | +| void | :ref:`store_var` **(** :ref:`Variant` value **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_File_endian_swap: - -- :ref:`bool` **endian_swap** - If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. - -Note that this is about the file format, not CPU type. This is always reset to ``false`` whenever you open the file. - - -Enums ------ +Enumerations +------------ .. _enum_File_CompressionMode: @@ -166,8 +155,18 @@ Tutorials - :doc:`../getting_started/step_by_step/filesystem` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_File_endian_swap: + +- :ref:`bool` **endian_swap** - If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. + +Note that this is about the file format, not CPU type. This is always reset to ``false`` whenever you open the file. + + +Method Descriptions +------------------- .. _class_File_close: @@ -183,7 +182,7 @@ Returns ``true`` if the file cursor has reached the end of the file. .. _class_File_file_exists: -- :ref:`bool` **file_exists** **(** :ref:`String` path **)** const +- :ref:`bool` **file_exists** **(** :ref:`String` path **)** const Returns ``true`` if the file exists in the given path. @@ -213,19 +212,19 @@ Returns the next 8 bits from the file as an integer. .. _class_File_get_as_text: -- :ref:`String` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** const -Returns the whole file as a :ref:`String`. +Returns the whole file as a :ref:`String`. .. _class_File_get_buffer: -- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const +- :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const -Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. +Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. .. _class_File_get_csv_line: -- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const +- :ref:`PoolStringArray` **get_csv_line** **(** :ref:`String` delim="," **)** const Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). @@ -237,9 +236,9 @@ Returns the next 64 bits from the file as a floating point number. .. _class_File_get_error: -- :ref:`Error` **get_error** **(** **)** const +- :ref:`Error` **get_error** **(** **)** const -Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope`. +Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE_*`` constants from :ref:`@GlobalScope`. .. _class_File_get_float: @@ -255,39 +254,39 @@ Returns the size of the file in bytes. .. _class_File_get_line: -- :ref:`String` **get_line** **(** **)** const +- :ref:`String` **get_line** **(** **)** const -Returns the next line of the file as a :ref:`String`. +Returns the next line of the file as a :ref:`String`. .. _class_File_get_md5: -- :ref:`String` **get_md5** **(** :ref:`String` path **)** const +- :ref:`String` **get_md5** **(** :ref:`String` path **)** const -Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. +Returns an MD5 String representing the file at the given path or an empty :ref:`String` on failure. .. _class_File_get_modified_time: -- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const +- :ref:`int` **get_modified_time** **(** :ref:`String` file **)** const -Returns the last time the ``file`` was modified in unix timestamp format or returns a :ref:`String` "ERROR IN ``file``". This unix timestamp can be converted to datetime by using :ref:`OS.get_datetime_from_unix_time`. +Returns the last time the ``file`` was modified in unix timestamp format or returns a :ref:`String` "ERROR IN ``file``". This unix timestamp can be converted to datetime by using :ref:`OS.get_datetime_from_unix_time`. .. _class_File_get_pascal_string: -- :ref:`String` **get_pascal_string** **(** **)** +- :ref:`String` **get_pascal_string** **(** **)** -Returns a :ref:`String` saved in Pascal format from the file. +Returns a :ref:`String` saved in Pascal format from the file. .. _class_File_get_path: -- :ref:`String` **get_path** **(** **)** const +- :ref:`String` **get_path** **(** **)** const -Returns the path as a :ref:`String` for the current open file. +Returns the path as a :ref:`String` for the current open file. .. _class_File_get_path_absolute: -- :ref:`String` **get_path_absolute** **(** **)** const +- :ref:`String` **get_path_absolute** **(** **)** const -Returns the absolute path as a :ref:`String` for the current open file. +Returns the absolute path as a :ref:`String` for the current open file. .. _class_File_get_position: @@ -303,15 +302,15 @@ Returns the next bits from the file as a floating point number. .. _class_File_get_sha256: -- :ref:`String` **get_sha256** **(** :ref:`String` path **)** const +- :ref:`String` **get_sha256** **(** :ref:`String` path **)** const -Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. +Returns a SHA-256 :ref:`String` representing the file at the given path or an empty :ref:`String` on failure. .. _class_File_get_var: -- :ref:`Variant` **get_var** **(** **)** const +- :ref:`Variant` **get_var** **(** **)** const -Returns the next :ref:`Variant` value from the file. +Returns the next :ref:`Variant` value from the file. .. _class_File_is_open: @@ -321,25 +320,25 @@ Returns ``true`` if the file is currently opened. .. _class_File_open: -- :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** +- :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** Opens the file for writing or reading, depending on the flags. .. _class_File_open_compressed: -- :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** +- :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``. .. _class_File_open_encrypted: -- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** +- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. .. _class_File_open_encrypted_with_pass: -- :ref:`Error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** +- :ref:`Error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. @@ -381,7 +380,7 @@ Stores an integer as 8 bits in the file. .. _class_File_store_buffer: -- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** +- void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. @@ -399,15 +398,15 @@ Stores a floating point number as 32 bits in the file. .. _class_File_store_line: -- void **store_line** **(** :ref:`String` line **)** +- void **store_line** **(** :ref:`String` line **)** -Stores the given :ref:`String` as a line in the file. +Stores the given :ref:`String` as a line in the file. .. _class_File_store_pascal_string: -- void **store_pascal_string** **(** :ref:`String` string **)** +- void **store_pascal_string** **(** :ref:`String` string **)** -Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). +Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). .. _class_File_store_real: @@ -417,13 +416,13 @@ Stores a floating point number in the file. .. _class_File_store_string: -- void **store_string** **(** :ref:`String` string **)** +- void **store_string** **(** :ref:`String` string **)** -Stores the given :ref:`String` in the file. +Stores the given :ref:`String` in the file. .. _class_File_store_var: -- void **store_var** **(** :ref:`Variant` value **)** +- void **store_var** **(** :ref:`Variant` value **)** Stores any Variant value in the file. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index eb9fc4a99..89f088d7b 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -7,8 +7,7 @@ FileDialog ========== -**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description Dialog for selecting files or directories in the filesystem. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`add_filter` **(** :ref:`String` filter **)** | +| void | :ref:`add_filter` **(** :ref:`String` filter **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ | void | :ref:`clear_filters` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ | void | :ref:`deselect_items` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +| :ref:`VBoxContainer` | :ref:`get_vbox` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ | void | :ref:`invalidate` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -38,68 +37,32 @@ Signals .. _class_FileDialog_dir_selected: -- **dir_selected** **(** :ref:`String` dir **)** +- **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. .. _class_FileDialog_file_selected: -- **file_selected** **(** :ref:`String` path **)** +- **file_selected** **(** :ref:`String` path **)** Event emitted when the user selects a file (double clicks it or presses the OK button). .. _class_FileDialog_files_selected: -- **files_selected** **(** :ref:`PoolStringArray` paths **)** +- **files_selected** **(** :ref:`PoolStringArray` paths **)** Event emitted when the user selects multiple files. -Member Variables ----------------- - - .. _class_FileDialog_access: - -- :ref:`Access` **access** - - .. _class_FileDialog_current_dir: - -- :ref:`String` **current_dir** - The current working directory of the file dialog. - - .. _class_FileDialog_current_file: - -- :ref:`String` **current_file** - The currently selected file of the file dialog. - - .. _class_FileDialog_current_path: - -- :ref:`String` **current_path** - The currently selected file path of the file dialog. - - .. _class_FileDialog_filters: - -- :ref:`PoolStringArray` **filters** - - .. _class_FileDialog_mode: - -- :ref:`Mode` **mode** - - .. _class_FileDialog_mode_overrides_title: - -- :ref:`bool` **mode_overrides_title** - If ``true``, changing the ``mode`` property will set the window title accordingly (e. g. setting mode to ``MODE_OPEN_FILE`` will change the window title to "Open a File"). - - .. _class_FileDialog_show_hidden_files: - -- :ref:`bool` **show_hidden_files** - - -Enums ------ +Enumerations +------------ .. _enum_FileDialog_Access: enum **Access** - **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory. -- **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource` path(res://) . +- **ACCESS_USERDATA** = **1** --- The dialog allows access files under :ref:`Resource` path(res://) . - **ACCESS_FILESYSTEM** = **2** --- The dialog allows access files in whole file system. .. _enum_FileDialog_Mode: @@ -118,12 +81,48 @@ Description FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_FileDialog_access: + +- :ref:`Access` **access** + + .. _class_FileDialog_current_dir: + +- :ref:`String` **current_dir** - The current working directory of the file dialog. + + .. _class_FileDialog_current_file: + +- :ref:`String` **current_file** - The currently selected file of the file dialog. + + .. _class_FileDialog_current_path: + +- :ref:`String` **current_path** - The currently selected file path of the file dialog. + + .. _class_FileDialog_filters: + +- :ref:`PoolStringArray` **filters** + + .. _class_FileDialog_mode: + +- :ref:`Mode` **mode** + + .. _class_FileDialog_mode_overrides_title: + +- :ref:`bool` **mode_overrides_title** - If ``true``, changing the ``mode`` property will set the window title accordingly (e. g. setting mode to ``MODE_OPEN_FILE`` will change the window title to "Open a File"). + + .. _class_FileDialog_show_hidden_files: + +- :ref:`bool` **show_hidden_files** + + +Method Descriptions +------------------- .. _class_FileDialog_add_filter: -- void **add_filter** **(** :ref:`String` filter **)** +- void **add_filter** **(** :ref:`String` filter **)** Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images"); @@ -139,11 +138,11 @@ Clear all the added filters in the dialog. .. _class_FileDialog_get_line_edit: -- :ref:`LineEdit` **get_line_edit** **(** **)** +- :ref:`LineEdit` **get_line_edit** **(** **)** .. _class_FileDialog_get_vbox: -- :ref:`VBoxContainer` **get_vbox** **(** **)** +- :ref:`VBoxContainer` **get_vbox** **(** **)** Return the vertical box container of the dialog, custom controls can be added to it. diff --git a/classes/class_float.rst b/classes/class_float.rst index 37e354bfa..d905790c6 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -14,15 +14,15 @@ Brief Description Float built-in type -Member Functions ----------------- +Methods +------- +----------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | +----------------------------+------------------------------------------------------------------------------+ | :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | +----------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | +| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | +----------------------------+------------------------------------------------------------------------------+ Description @@ -30,8 +30,8 @@ Description Float built-in type. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_float_float: @@ -47,8 +47,8 @@ Cast an :ref:`int` value to a floating point value, ``float(1)`` will .. _class_float_float: -- :ref:`float` **float** **(** :ref:`String` from **)** +- :ref:`float` **float** **(** :ref:`String` from **)** -Cast a :ref:`String` value to a floating point value. This method accepts float value strings like `` '1.23' `` and exponential notation strings for its parameter so calling `` float('1e3') `` will return 1000.0 and calling `` float('1e-3') `` will return -0.001. +Cast a :ref:`String` value to a floating point value. This method accepts float value strings like `` '1.23' `` and exponential notation strings for its parameter so calling `` float('1e3') `` will return 1000.0 and calling `` float('1e-3') `` will return -0.001. diff --git a/classes/class_font.rst b/classes/class_font.rst index 34672c00b..560e48d7b 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -7,10 +7,8 @@ Font ==== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`DynamicFont`, :ref:`BitmapFont` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`DynamicFont`, :ref:`BitmapFont` **Category:** Core Brief Description @@ -18,13 +16,13 @@ Brief Description Internationalized font and text drawing support. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const | +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const | +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ascent` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -32,7 +30,7 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_height` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_outline` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,18 +44,18 @@ Description Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Font_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1, :ref:`Color` outline_modulate=Color( 1, 1, 1, 1 ) **)** const Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. .. _class_Font_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` outline=false **)** const Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. @@ -81,7 +79,7 @@ Return the total font height (ascent plus descent) in pixels. .. _class_Font_get_string_size: -- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const +- :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const Return the size of a string, taking kerning and advance into account. diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 0cb2cda81..0ee20b282 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -7,8 +7,7 @@ FuncRef ======= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Reference to a function in an object. -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | +| :ref:`Variant` | :ref:`call_func` **(** **)** vararg | +--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function` **(** :ref:`String` name **)** | +| void | :ref:`set_function` **(** :ref:`String` name **)** | +--------------------------------+--------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | +| void | :ref:`set_instance` **(** :ref:`Object` instance **)** | +--------------------------------+--------------------------------------------------------------------------------------------------+ Description @@ -34,25 +33,25 @@ In GDScript, functions are not *first-class objects*. This means it is impossibl However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` function, a reference to a function in a given object can be created, passed around and called. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_FuncRef_call_func: -- :ref:`Variant` **call_func** **(** **)** vararg +- :ref:`Variant` **call_func** **(** **)** vararg Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. .. _class_FuncRef_set_function: -- void **set_function** **(** :ref:`String` name **)** +- void **set_function** **(** :ref:`String` name **)** The name of the referenced function to call on the object, without parentheses or any parameters. .. _class_FuncRef_set_instance: -- void **set_instance** **(** :ref:`Object` instance **)** +- void **set_instance** **(** :ref:`Object` instance **)** -The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object`, not a built-in type such as :ref:`int`, :ref:`Vector2` or :ref:`Dictionary`. +The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object`, not a built-in type such as :ref:`int`, :ref:`Vector2` or :ref:`Dictionary`. diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 8693e7581..3511369cb 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -7,8 +7,7 @@ GDNative ======== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | +| :ref:`Variant` | :ref:`call_native` **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`initialize` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`terminate` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_GDNative_library: -- :ref:`GDNativeLibrary` **library** +- :ref:`GDNativeLibrary` **library** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GDNative_call_native: -- :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** +- :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** .. _class_GDNative_initialize: diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 2a46f99a4..ca7519620 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -7,8 +7,7 @@ GDNativeLibrary =============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_current_dependencies` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | +| :ref:`String` | :ref:`get_current_library_path` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_GDNativeLibrary_config_file: -- :ref:`ConfigFile` **config_file** +- :ref:`ConfigFile` **config_file** .. _class_GDNativeLibrary_load_once: @@ -46,18 +45,18 @@ Member Variables .. _class_GDNativeLibrary_symbol_prefix: -- :ref:`String` **symbol_prefix** +- :ref:`String` **symbol_prefix** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GDNativeLibrary_get_current_dependencies: -- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const +- :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const .. _class_GDNativeLibrary_get_current_library_path: -- :ref:`String` **get_current_library_path** **(** **)** const +- :ref:`String` **get_current_library_path** **(** **)** const diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index e08278479..8ee2ea3cd 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -7,8 +7,7 @@ GDScript ======== -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description A script implemented in the GDScript programming language. -Member Functions ----------------- +Methods +------- +--------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | +| :ref:`PoolByteArray` | :ref:`get_as_byte_code` **(** **)** const | +--------------------------------------------+----------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | +| :ref:`Object` | :ref:`new` **(** **)** vararg | +--------------------------------------------+----------------------------------------------------------------------------+ Description @@ -37,18 +36,18 @@ Tutorials - :doc:`../getting_started/scripting/gdscript/index` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GDScript_get_as_byte_code: -- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const +- :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. .. _class_GDScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg Returns a new instance of the script. diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 6fb6a608e..8e4c2fd93 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -7,8 +7,7 @@ GDScriptFunctionState ===================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description State of a function call after yielding. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=null **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------+ Signals @@ -30,7 +29,7 @@ Signals .. _class_GDScriptFunctionState_completed: -- **completed** **(** :ref:`Nil` result **)** +- **completed** **(** :ref:`Nil` result **)** Description @@ -38,8 +37,8 @@ Description Calling :ref:`@GDScript.yield` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume` on this state object. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GDScriptFunctionState_is_valid: @@ -51,11 +50,11 @@ If ``extended_check`` is enabled, it also checks if the associated script and ob .. _class_GDScriptFunctionState_resume: -- :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** +- :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** Resume execution of the yielded function call. -If handed an argument, return the argument from the :ref:`@GDScript.yield` call in the yielded function call. You can pass e.g. an :ref:`Array` to hand multiple arguments. +If handed an argument, return the argument from the :ref:`@GDScript.yield` call in the yielded function call. You can pass e.g. an :ref:`Array` to hand multiple arguments. This function returns what the resumed function call returns, possibly another function state if yielded again. diff --git a/classes/class_gdscriptnativeclass.rst b/classes/class_gdscriptnativeclass.rst index 8240cf8dd..b3c0a5eb3 100644 --- a/classes/class_gdscriptnativeclass.rst +++ b/classes/class_gdscriptnativeclass.rst @@ -7,8 +7,7 @@ GDScriptNativeClass =================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,18 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+-------------------------------------------------------+ -| :ref:`Variant` | :ref:`new` **(** **)** | +| :ref:`Variant` | :ref:`new` **(** **)** | +--------------------------------+-------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GDScriptNativeClass_new: -- :ref:`Variant` **new** **(** **)** +- :ref:`Variant` **new** **(** **)** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index eae262eed..f52027928 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -7,8 +7,7 @@ Generic6DOFJoint ================ -**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,49 @@ Brief Description The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Generic6DOFJoint_Flag: + +enum **Flag** + +- **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. +- **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. +- **FLAG_ENABLE_MOTOR** = **2** --- If ``set`` there is a rotational motor across these axes. +- **FLAG_ENABLE_LINEAR_MOTOR** = **3** +- **FLAG_MAX** = **4** --- End flag of FLAG\_\* constants, used internally. + + .. _enum_Generic6DOFJoint_Param: + +enum **Param** + +- **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. +- **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. +- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the axes The lower, the slower the movement. +- **PARAM_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement The lower, the more momentum gets lost. +- **PARAM_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes. +- **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity the linear motor will try to reach. +- **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force the linear motor will apply while trying to reach the velocity target. +- **PARAM_ANGULAR_LOWER_LIMIT** = **7** --- The minimum rotation in negative direction to break loose and rotate around the axes. +- **PARAM_ANGULAR_UPPER_LIMIT** = **8** --- The minimum rotation in positive direction to break loose and rotate around the axes. +- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **9** --- The speed of all rotations across the axes. +- **PARAM_ANGULAR_DAMPING** = **10** --- The amount of rotational damping across the axes. The lower, the more dampening occurs. +- **PARAM_ANGULAR_RESTITUTION** = **11** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs. +- **PARAM_ANGULAR_FORCE_LIMIT** = **12** --- The maximum amount of force that can occur, when rotating around the axes. +- **PARAM_ANGULAR_ERP** = **13** --- When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. +- **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **14** --- Target speed for the motor at the axes. +- **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **15** --- Maximum acceleration for the motor at the axes. +- **PARAM_MAX** = **16** --- End flag of PARAM\_\* constants, used internally. + + +Description +----------- + +The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited. + +Property Descriptions +--------------------- .. _class_Generic6DOFJoint_angular_limit_x/damping: @@ -262,44 +302,3 @@ The lower, the longer an impulse from one side takes to travel to the other side - :ref:`float` **linear_motor_z/target_velocity** - The speed that the linear motor will attempt to reach on the z-axis. -Enums ------ - - .. _enum_Generic6DOFJoint_Flag: - -enum **Flag** - -- **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. -- **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. -- **FLAG_ENABLE_MOTOR** = **2** --- If ``set`` there is a rotational motor across these axes. -- **FLAG_ENABLE_LINEAR_MOTOR** = **3** -- **FLAG_MAX** = **4** --- End flag of FLAG\_\* constants, used internally. - - .. _enum_Generic6DOFJoint_Param: - -enum **Param** - -- **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. -- **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. -- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the axes The lower, the slower the movement. -- **PARAM_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement The lower, the more momentum gets lost. -- **PARAM_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes. -- **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity the linear motor will try to reach. -- **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force the linear motor will apply while trying to reach the velocity target. -- **PARAM_ANGULAR_LOWER_LIMIT** = **7** --- The minimum rotation in negative direction to break loose and rotate around the axes. -- **PARAM_ANGULAR_UPPER_LIMIT** = **8** --- The minimum rotation in positive direction to break loose and rotate around the axes. -- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **9** --- The speed of all rotations across the axes. -- **PARAM_ANGULAR_DAMPING** = **10** --- The amount of rotational damping across the axes. The lower, the more dampening occurs. -- **PARAM_ANGULAR_RESTITUTION** = **11** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs. -- **PARAM_ANGULAR_FORCE_LIMIT** = **12** --- The maximum amount of force that can occur, when rotating around the axes. -- **PARAM_ANGULAR_ERP** = **13** --- When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. -- **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **14** --- Target speed for the motor at the axes. -- **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **15** --- Maximum acceleration for the motor at the axes. -- **PARAM_MAX** = **16** --- End flag of PARAM\_\* constants, used internally. - - -Description ------------ - -The first 3 DOF axes are linear axes, which represent translation of Bodies, and the latter 3 DOF axes represent the angular motion. Each axis can be either locked, or limited. - diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 108993cc5..c40fefc88 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -7,8 +7,7 @@ Geometry ======== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,194 +15,194 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** | +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** | +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | +| :ref:`PoolVector3Array` | :ref:`clip_polygon` **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | +| :ref:`PoolVector2Array` | :ref:`convex_hull_2d` **(** :ref:`PoolVector2Array` points **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | +| :ref:`Variant` | :ref:`line_intersects_line_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Geometry_build_box_planes: -- :ref:`Array` **build_box_planes** **(** :ref:`Vector3` extents **)** +- :ref:`Array` **build_box_planes** **(** :ref:`Vector3` extents **)** -Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). +Returns an array with 6 :ref:`Plane`\ s that describe the sides of a box centered at the origin. The box size is defined by ``extents``, which represents one (positive) corner of the box (i.e. half its actual size). .. _class_Geometry_build_capsule_planes: -- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** +- :ref:`Array` **build_capsule_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`Axis` axis=2 **)** -Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). +Returns an array of :ref:`Plane`\ s closely bounding a faceted capsule centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the side part of the capsule, whereas ``lats`` gives the number of latitudinal steps at the bottom and top of the capsule. The parameter ``axis`` describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). .. _class_Geometry_build_cylinder_planes: -- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** +- :ref:`Array` **build_cylinder_planes** **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`Axis` axis=2 **)** -Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). +Returns an array of :ref:`Plane`\ s closely bounding a faceted cylinder centered at the origin with radius ``radius`` and height ``height``. The parameter ``sides`` defines how many planes will be generated for the round part of the cylinder. The parameter ``axis`` describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). .. _class_Geometry_clip_polygon: -- :ref:`PoolVector3Array` **clip_polygon** **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** +- :ref:`PoolVector3Array` **clip_polygon** **(** :ref:`PoolVector3Array` points, :ref:`Plane` plane **)** Clips the polygon defined by the points in ``points`` against the ``plane`` and returns the points of the clipped polygon. .. _class_Geometry_convex_hull_2d: -- :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** +- :ref:`PoolVector2Array` **convex_hull_2d** **(** :ref:`PoolVector2Array` points **)** -Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. +Given an array of :ref:`Vector2`\ s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. .. _class_Geometry_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. .. _class_Geometry_get_closest_point_to_segment_2d: -- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +- :ref:`Vector2` **get_closest_point_to_segment_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** Returns the 2d point on the 2d segment (``s1``, ``s2``) that is closest to ``point``. The returned point will always be inside the specified segment. .. _class_Geometry_get_closest_point_to_segment_uncapped: -- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** +- :ref:`Vector3` **get_closest_point_to_segment_uncapped** **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** Returns the 3d point on the 3d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. .. _class_Geometry_get_closest_point_to_segment_uncapped_2d: -- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** +- :ref:`Vector2` **get_closest_point_to_segment_uncapped_2d** **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** Returns the 2d point on the 2d line defined by (``s1``, ``s2``) that is closest to ``point``. The returned point can be inside the segment (``s1``, ``s2``) or outside of it, i.e. somewhere on the line extending from the segment. .. _class_Geometry_get_closest_points_between_segments: -- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** +- :ref:`PoolVector3Array` **get_closest_points_between_segments** **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** -Given the two 3d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +Given the two 3d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector3Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). .. _class_Geometry_get_closest_points_between_segments_2d: -- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** +- :ref:`PoolVector2Array` **get_closest_points_between_segments_2d** **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** -Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). +Given the two 2d segments (``p1``, ``p2``) and (``q1``, ``q2``), finds those two points on the two segments that are closest to each other. Returns a :ref:`PoolVector2Array` that contains this point on (``p1``, ``p2``) as well the accompanying point on (``q1``, ``q2``). .. _class_Geometry_get_uv84_normal_bit: -- :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** +- :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** .. _class_Geometry_line_intersects_line_2d: -- :ref:`Variant` **line_intersects_line_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** +- :ref:`Variant` **line_intersects_line_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` dir_a, :ref:`Vector2` from_b, :ref:`Vector2` dir_b **)** -Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. Note that the lines are specified using direction vectors, not end points. +Checks if the two lines (``from_a``, ``dir_a``) and (``from_b``, ``dir_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. Note that the lines are specified using direction vectors, not end points. .. _class_Geometry_make_atlas: -- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** +- :ref:`Dictionary` **make_atlas** **(** :ref:`PoolVector2Array` sizes **)** -Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. +Given an array of :ref:`Vector2`\ s representing tiles, builds an atlas. The returned dictionary has two keys: ``points`` is a vector of :ref:`Vector2` that specifies the positions of each tile, ``size`` contains the overall size of the whole atlas as :ref:`Vector2`. .. _class_Geometry_point_is_inside_triangle: -- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const +- :ref:`bool` **point_is_inside_triangle** **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. .. _class_Geometry_ray_intersects_triangle: -- :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **ray_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** -Tests if the 3d ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. +Tests if the 3d ray starting at ``from`` with the direction of ``dir`` intersects the triangle specified by ``a``, ``b`` and ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. .. _class_Geometry_segment_intersects_circle: -- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** +- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** Given the 2d segment (``segment_from``, ``segment_to``), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position ``circle_position`` and has radius ``circle_radius``. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). .. _class_Geometry_segment_intersects_convex: -- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** +- :ref:`PoolVector3Array` **segment_intersects_convex** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** -Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PoolVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. +Given a convex hull defined though the :ref:`Plane`\ s in the array ``planes``, tests if the segment (``from``, ``to``) intersects with that hull. If an intersection is found, returns a :ref:`PoolVector3Array` containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. .. _class_Geometry_segment_intersects_cylinder: -- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** +- :ref:`PoolVector3Array` **segment_intersects_cylinder** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** -Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PoolVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. +Checks if the segment (``from``, ``to``) intersects the cylinder with height ``height`` that is centered at the origin and has radius ``radius``. If no, returns an empty :ref:`PoolVector3Array`. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. .. _class_Geometry_segment_intersects_segment_2d: -- :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** +- :ref:`Variant` **segment_intersects_segment_2d** **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** -Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. +Checks if the two segments (``from_a``, ``to_a``) and (``from_b``, ``to_b``) intersect. If yes, return the point of intersection as :ref:`Vector2`. If no intersection takes place, returns an empty :ref:`Variant`. .. _class_Geometry_segment_intersects_sphere: -- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** +- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** -Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PoolVector3Array`. If yes, returns a :ref:`PoolVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. +Checks if the segment (``from``, ``to``) intersects the sphere that is located at ``sphere_position`` and has radius ``sphere_radius``. If no, returns an empty :ref:`PoolVector3Array`. If yes, returns a :ref:`PoolVector3Array` containing the point of intersection and the sphere's normal at the point of intersection. .. _class_Geometry_segment_intersects_triangle: -- :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** +- :ref:`Variant` **segment_intersects_triangle** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** -Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. +Tests if the segment (``from``, ``to``) intersects the triangle ``a``, ``b``, ``c``. If yes, returns the point of intersection as :ref:`Vector3`. If no intersection takes place, an empty :ref:`Variant` is returned. .. _class_Geometry_triangulate_polygon: -- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** +- :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** -Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. +Triangulates the polygon specified by the points in ``polygon``. Returns a :ref:`PoolIntArray` where each triangle consists of three consecutive point indices into ``polygon`` (i.e. the returned array will have ``n * 3`` elements, with ``n`` being the number of found triangles). If the triangulation did not succeed, an empty :ref:`PoolIntArray` is returned. diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 43883152b..39d4e2d91 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -7,10 +7,8 @@ GeometryInstance ================ -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`MeshInstance`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry`, :ref:`CPUParticles` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`MeshInstance`, :ref:`SpriteBase3D`, :ref:`ImmediateGeometry`, :ref:`CPUParticles` **Category:** Core Brief Description @@ -18,52 +16,14 @@ Brief Description Base node for geometry based visual instances. -Member Variables ----------------- - - .. _class_GeometryInstance_cast_shadow: - -- :ref:`ShadowCastingSetting` **cast_shadow** - The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. - - .. _class_GeometryInstance_extra_cull_margin: - -- :ref:`float` **extra_cull_margin** - The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. - - .. _class_GeometryInstance_lod_max_distance: - -- :ref:`float` **lod_max_distance** - The GeometryInstance's max LOD distance. - - .. _class_GeometryInstance_lod_max_hysteresis: - -- :ref:`float` **lod_max_hysteresis** - The GeometryInstance's max LOD margin. - - .. _class_GeometryInstance_lod_min_distance: - -- :ref:`float` **lod_min_distance** - The GeometryInstance's min LOD distance. - - .. _class_GeometryInstance_lod_min_hysteresis: - -- :ref:`float` **lod_min_hysteresis** - The GeometryInstance's min LOD margin. - - .. _class_GeometryInstance_material_override: - -- :ref:`Material` **material_override** - The material override for the whole geometry. - -If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh. - - .. _class_GeometryInstance_use_in_baked_light: - -- :ref:`bool` **use_in_baked_light** - If ``true`` this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. - - -Enums ------ +Enumerations +------------ .. _enum_GeometryInstance_Flags: enum **Flags** -- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. +- **FLAG_USE_BAKED_LIGHT** = **0** --- Will allow the GeometryInstance to be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. Added documentation for GeometryInstance and VisualInstance - **FLAG_MAX** = **2** @@ -89,3 +49,41 @@ Description Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. +Property Descriptions +--------------------- + + .. _class_GeometryInstance_cast_shadow: + +- :ref:`ShadowCastingSetting` **cast_shadow** - The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. + + .. _class_GeometryInstance_extra_cull_margin: + +- :ref:`float` **extra_cull_margin** - The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. + + .. _class_GeometryInstance_lod_max_distance: + +- :ref:`float` **lod_max_distance** - The GeometryInstance's max LOD distance. + + .. _class_GeometryInstance_lod_max_hysteresis: + +- :ref:`float` **lod_max_hysteresis** - The GeometryInstance's max LOD margin. + + .. _class_GeometryInstance_lod_min_distance: + +- :ref:`float` **lod_min_distance** - The GeometryInstance's min LOD distance. + + .. _class_GeometryInstance_lod_min_hysteresis: + +- :ref:`float` **lod_min_hysteresis** - The GeometryInstance's min LOD margin. + + .. _class_GeometryInstance_material_override: + +- :ref:`Material` **material_override** - The material override for the whole geometry. + +If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh. + + .. _class_GeometryInstance_use_in_baked_light: + +- :ref:`bool` **use_in_baked_light** - If ``true`` this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. + + diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index b10f6ef49..914732149 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -7,8 +7,7 @@ GIProbe ======= -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,61 +15,17 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+---------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | +| void | :ref:`bake` **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`debug_bake` **(** **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_GIProbe_bias: - -- :ref:`float` **bias** - - .. _class_GIProbe_compress: - -- :ref:`bool` **compress** - - .. _class_GIProbe_data: - -- :ref:`GIProbeData` **data** - - .. _class_GIProbe_dynamic_range: - -- :ref:`int` **dynamic_range** - - .. _class_GIProbe_energy: - -- :ref:`float` **energy** - - .. _class_GIProbe_extents: - -- :ref:`Vector3` **extents** - - .. _class_GIProbe_interior: - -- :ref:`bool` **interior** - - .. _class_GIProbe_normal_bias: - -- :ref:`float` **normal_bias** - - .. _class_GIProbe_propagation: - -- :ref:`float` **propagation** - - .. _class_GIProbe_subdiv: - -- :ref:`Subdiv` **subdiv** - - -Enums ------ +Enumerations +------------ .. _enum_GIProbe_Subdiv: @@ -88,12 +43,56 @@ Tutorials - :doc:`../tutorials/3d/gi_probes` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_GIProbe_bias: + +- :ref:`float` **bias** + + .. _class_GIProbe_compress: + +- :ref:`bool` **compress** + + .. _class_GIProbe_data: + +- :ref:`GIProbeData` **data** + + .. _class_GIProbe_dynamic_range: + +- :ref:`int` **dynamic_range** + + .. _class_GIProbe_energy: + +- :ref:`float` **energy** + + .. _class_GIProbe_extents: + +- :ref:`Vector3` **extents** + + .. _class_GIProbe_interior: + +- :ref:`bool` **interior** + + .. _class_GIProbe_normal_bias: + +- :ref:`float` **normal_bias** + + .. _class_GIProbe_propagation: + +- :ref:`float` **propagation** + + .. _class_GIProbe_subdiv: + +- :ref:`Subdiv` **subdiv** + + +Method Descriptions +------------------- .. _class_GIProbe_bake: -- void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** +- void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** .. _class_GIProbe_debug_bake: diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 131774bf8..281bb2899 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -7,8 +7,7 @@ GIProbeData =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_GIProbeData_bias: @@ -25,7 +24,7 @@ Member Variables .. _class_GIProbeData_bounds: -- :ref:`AABB` **bounds** +- :ref:`AABB` **bounds** .. _class_GIProbeData_cell_size: @@ -37,7 +36,7 @@ Member Variables .. _class_GIProbeData_dynamic_data: -- :ref:`PoolIntArray` **dynamic_data** +- :ref:`PoolIntArray` **dynamic_data** .. _class_GIProbeData_dynamic_range: @@ -61,6 +60,6 @@ Member Variables .. _class_GIProbeData_to_cell_xform: -- :ref:`Transform` **to_cell_xform** +- :ref:`Transform` **to_cell_xform** diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index a51759e73..124712240 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -7,8 +7,7 @@ GodotSharp ========== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------+--------------------------------------------------------------------------------+ | void | :ref:`attach_thread` **(** **)** | @@ -29,8 +28,8 @@ Member Functions | :ref:`bool` | :ref:`is_finalizing_domain` **(** **)** | +--------------------------+--------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GodotSharp_attach_thread: diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 40139de19..31edecbe7 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -7,8 +7,7 @@ Gradient ======== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,56 +15,56 @@ Brief Description Color interpolator node. -Member Functions ----------------- +Methods +------- +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` offset **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Gradient_colors: - -- :ref:`PoolColorArray` **colors** - Gradient's colors returned as a :ref:`PoolColorArray`. - - .. _class_Gradient_offsets: - -- :ref:`PoolRealArray` **offsets** - Gradient's offsets returned as a :ref:`PoolRealArray`. - - Description ----------- Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Gradient_colors: + +- :ref:`PoolColorArray` **colors** - Gradient's colors returned as a :ref:`PoolColorArray`. + + .. _class_Gradient_offsets: + +- :ref:`PoolRealArray` **offsets** - Gradient's offsets returned as a :ref:`PoolRealArray`. + + +Method Descriptions +------------------- .. _class_Gradient_add_point: -- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** +- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** Adds the specified color to the end of the ramp, with the specified offset .. _class_Gradient_get_color: -- :ref:`Color` **get_color** **(** :ref:`int` point **)** const +- :ref:`Color` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* @@ -83,7 +82,7 @@ Returns the number of colors in the ramp .. _class_Gradient_interpolate: -- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** +- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* @@ -95,7 +94,7 @@ Removes the color at the index *offset* .. _class_Gradient_set_color: -- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** +- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index *point* diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 7e6beea2a..8493dd9f4 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -7,8 +7,7 @@ GradientTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description Gradient filled texture. -Member Variables ----------------- - - .. _class_GradientTexture_gradient: - -- :ref:`Gradient` **gradient** - The :ref:`Gradient` that will be used to fill the texture. - - .. _class_GradientTexture_width: - -- :ref:`int` **width** - The number of color samples that will be obtained from the :ref:`Gradient`. - - Description ----------- -Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`set_width`). +Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`set_width`). + +Property Descriptions +--------------------- + + .. _class_GradientTexture_gradient: + +- :ref:`Gradient` **gradient** - The :ref:`Gradient` that will be used to fill the texture. + + .. _class_GradientTexture_width: + +- :ref:`int` **width** - The number of color samples that will be obtained from the :ref:`Gradient`. + diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index c08f16afc..35201fa2a 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -7,8 +7,7 @@ GraphEdit ========= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. -Member Functions ----------------- +Methods +------- +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** | @@ -28,15 +27,15 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_connections` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +| :ref:`Error` | :ref:`connect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +| void | :ref:`disconnect_node` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | +| :ref:`Array` | :ref:`get_connection_list` **(** **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | +| :ref:`HBoxContainer` | :ref:`get_zoom_hbox` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +| :ref:`bool` | :ref:`is_node_connected` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_connection_type` **(** :ref:`int` from_type, :ref:`int` to_type **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,9 +45,9 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_valid_right_disconnect_type` **(** :ref:`int` type **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | +| void | :ref:`set_connection_activity` **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`Node` node **)** | +| void | :ref:`set_selected` **(** :ref:`Node` node **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -68,13 +67,13 @@ Signal sent at the end of a GraphNode movement. .. _class_GraphEdit_connection_request: -- **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **connection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. .. _class_GraphEdit_connection_to_empty: -- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** +- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** .. _class_GraphEdit_delete_nodes_request: @@ -84,7 +83,7 @@ Signal sent when a GraphNode is attempted to be removed from the GraphEdit. .. _class_GraphEdit_disconnection_request: -- **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** +- **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`int` to_slot **)** Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. @@ -96,23 +95,30 @@ Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. .. _class_GraphEdit_node_selected: -- **node_selected** **(** :ref:`Object` node **)** +- **node_selected** **(** :ref:`Node` node **)** Emitted when a GraphNode is selected. .. _class_GraphEdit_popup_request: -- **popup_request** **(** :ref:`Vector2` p_position **)** +- **popup_request** **(** :ref:`Vector2` p_position **)** Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. .. _class_GraphEdit_scroll_offset_changed: -- **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** +- **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** -Member Variables ----------------- +Description +----------- + +GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. + +It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. + +Property Descriptions +--------------------- .. _class_GraphEdit_right_disconnects: @@ -120,7 +126,7 @@ Member Variables .. _class_GraphEdit_scroll_offset: -- :ref:`Vector2` **scroll_offset** - The scroll offset. +- :ref:`Vector2` **scroll_offset** - The scroll offset. .. _class_GraphEdit_snap_distance: @@ -135,15 +141,8 @@ Member Variables - :ref:`float` **zoom** - The current zoom value. -Description ------------ - -GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. - -It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode`) when using GraphEdits. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GraphEdit_add_valid_connection_type: @@ -171,29 +170,29 @@ Remove all connections between nodes. .. _class_GraphEdit_connect_node: -- :ref:`Error` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`Error` **connect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. .. _class_GraphEdit_disconnect_node: -- void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- void **disconnect_node** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. .. _class_GraphEdit_get_connection_list: -- :ref:`Array` **get_connection_list** **(** **)** const +- :ref:`Array` **get_connection_list** **(** **)** const Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } .. _class_GraphEdit_get_zoom_hbox: -- :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** +- :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** .. _class_GraphEdit_is_node_connected: -- :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** +- :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. @@ -223,11 +222,11 @@ Removes the possibility to disconnect nodes when dragging from the slot at the r .. _class_GraphEdit_set_connection_activity: -- void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** +- void **set_connection_activity** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port, :ref:`float` amount **)** .. _class_GraphEdit_set_selected: -- void **set_selected** **(** :ref:`Node` node **)** +- void **set_selected** **(** :ref:`Node` node **)** Sets the specified ``node`` as the one selected. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 2cfa905ab..7947eb338 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -7,8 +7,7 @@ GraphNode ========= -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,33 @@ Brief Description A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. -Member Functions ----------------- +Methods +------- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_all_slots` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_slot` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | +| :ref:`Color` | :ref:`get_connection_input_color` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_count` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | +| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | +| :ref:`Color` | :ref:`get_connection_output_color` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_count` **(** **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | +| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_slot_color_left` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_slot_color_right` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slot_type_left` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -52,7 +51,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_slot_enabled_right` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | +| void | :ref:`set_slot` **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -66,7 +65,7 @@ Signal sent on closing the GraphNode. .. _class_GraphNode_dragged: -- **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. @@ -84,43 +83,11 @@ Signal sent when the GraphNode is requested to be displayed over other ones. Hap .. _class_GraphNode_resize_request: -- **resize_request** **(** :ref:`Vector2` new_minsize **)** +- **resize_request** **(** :ref:`Vector2` new_minsize **)** -Member Variables ----------------- - - .. _class_GraphNode_comment: - -- :ref:`bool` **comment** - - .. _class_GraphNode_offset: - -- :ref:`Vector2` **offset** - The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit`. Note that you cannot use position directly, as :ref:`GraphEdit` is a :ref:`Container`. - - .. _class_GraphNode_overlay: - -- :ref:`Overlay` **overlay** - - .. _class_GraphNode_resizable: - -- :ref:`bool` **resizable** - - .. _class_GraphNode_selected: - -- :ref:`bool` **selected** - - .. _class_GraphNode_show_close: - -- :ref:`bool` **show_close** - - .. _class_GraphNode_title: - -- :ref:`String` **title** - - -Enums ------ +Enumerations +------------ .. _enum_GraphNode_Overlay: @@ -136,8 +103,40 @@ Description A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_GraphNode_comment: + +- :ref:`bool` **comment** + + .. _class_GraphNode_offset: + +- :ref:`Vector2` **offset** - The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdit`. Note that you cannot use position directly, as :ref:`GraphEdit` is a :ref:`Container`. + + .. _class_GraphNode_overlay: + +- :ref:`Overlay` **overlay** + + .. _class_GraphNode_resizable: + +- :ref:`bool` **resizable** + + .. _class_GraphNode_selected: + +- :ref:`bool` **selected** + + .. _class_GraphNode_show_close: + +- :ref:`bool` **show_close** + + .. _class_GraphNode_title: + +- :ref:`String` **title** + + +Method Descriptions +------------------- .. _class_GraphNode_clear_all_slots: @@ -153,7 +152,7 @@ Disable input and output slot whose index is 'idx'. .. _class_GraphNode_get_connection_input_color: -- :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** +- :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Return the color of the input connection 'idx'. @@ -165,7 +164,7 @@ Return the number of enabled input slots (connections) to the GraphNode. .. _class_GraphNode_get_connection_input_position: -- :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. @@ -177,7 +176,7 @@ Return the type of the input connection 'idx'. .. _class_GraphNode_get_connection_output_color: -- :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** +- :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Return the color of the output connection 'idx'. @@ -189,7 +188,7 @@ Return the number of enabled output slots (connections) of the GraphNode. .. _class_GraphNode_get_connection_output_position: -- :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. @@ -201,13 +200,13 @@ Return the type of the output connection 'idx'. .. _class_GraphNode_get_slot_color_left: -- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_left** **(** :ref:`int` idx **)** const Return the color set to 'idx' left (input) slot. .. _class_GraphNode_get_slot_color_right: -- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Return the color set to 'idx' right (output) slot. @@ -237,6 +236,6 @@ Return true if right (output) slot 'idx' is enabled. False otherwise. .. _class_GraphNode_set_slot: -- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** +- void **set_slot** **(** :ref:`int` idx, :ref:`bool` enable_left, :ref:`int` type_left, :ref:`Color` color_left, :ref:`bool` enable_right, :ref:`int` type_right, :ref:`Color` color_right, :ref:`Texture` custom_left=null, :ref:`Texture` custom_right=null **)** diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 3917c8985..4f96bfe9b 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -7,8 +7,7 @@ GridContainer ============= -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description Grid container used to arrange elements in a grid like layout. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_child_control_at_cell` **(** :ref:`int` row, :ref:`int` column **)** | +| :ref:`Control` | :ref:`get_child_control_at_cell` **(** :ref:`int` row, :ref:`int` column **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_GridContainer_columns: - -- :ref:`int` **columns** - The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. - - Description ----------- Grid container will arrange its children in a grid like structure, the grid columns are specified using the :ref:`set_columns` method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_GridContainer_columns: + +- :ref:`int` **columns** - The number of columns in the ``GridContainer``. If modified, ``GridContainer`` reorders its children to accommodate the new layout. + + +Method Descriptions +------------------- .. _class_GridContainer_get_child_control_at_cell: -- :ref:`Control` **get_child_control_at_cell** **(** :ref:`int` row, :ref:`int` column **)** +- :ref:`Control` **get_child_control_at_cell** **(** :ref:`int` row, :ref:`int` column **)** diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index f599dcfbd..a14d25d1b 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -7,8 +7,7 @@ GridMap ======= -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,17 @@ Brief Description Node for 3D tile-based maps. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_baked_meshes` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | +| :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_bake_meshes` **(** **)** | +| :ref:`Array` | :ref:`get_bake_meshes` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,29 +35,50 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_meshes` **(** **)** | +| :ref:`Array` | :ref:`get_meshes` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_baked_meshes` **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +| void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_item` **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** | +| void | :ref:`set_clip` **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | +| :ref:`Vector3` | :ref:`world_to_map` **(** :ref:`Vector3` pos **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- + +- **INVALID_CELL_ITEM** = **-1** --- Invalid cell item that can be used in :ref:`set_cell_item` to clear cells (or represent an empty cell in :ref:`get_cell_item`). + +Description +----------- + +GridMap lets you place meshes on a grid interactively. It works both from the editor and can help you create in-game level editors. + +GridMaps use a :ref:`MeshLibrary` which contain a list of tiles: meshes with materials plus optional collisions and extra elements. + +A GridMap contains a collection of cells. Each grid cell refers to a :ref:`MeshLibrary` item. All cells in the map have the same dimensions. + +A GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells. + +Tutorials +--------- + +- :doc:`../tutorials/3d/using_gridmaps` + +Property Descriptions +--------------------- .. _class_GridMap_cell_center_x: @@ -82,7 +102,7 @@ Member Variables .. _class_GridMap_cell_size: -- :ref:`Vector3` **cell_size** - The dimensions of the grid's cells. +- :ref:`Vector3` **cell_size** - The dimensions of the grid's cells. .. _class_GridMap_collision_layer: @@ -92,34 +112,17 @@ Member Variables - :ref:`int` **collision_mask** + .. _class_GridMap_mesh_library: + +- :ref:`MeshLibrary` **mesh_library** - The assigned :ref:`MeshLibrary`. + .. _class_GridMap_theme: -- :ref:`MeshLibrary` **theme** - The assigned :ref:`MeshLibrary`. +- :ref:`MeshLibrary` **theme** - Deprecated, use :ref:`mesh_library` instead. -Numeric Constants ------------------ - -- **INVALID_CELL_ITEM** = **-1** --- Invalid cell item that can be used in :ref:`set_cell_item` to clear cells (or represent an empty cell in :ref:`get_cell_item`). - -Description ------------ - -GridMap lets you place meshes on a grid interactively. It works both from the editor and can help you create in-game level editors. - -GridMaps use a :ref:`MeshLibrary` which contain a list of tiles: meshes with materials plus optional collisions and extra elements. - -A GridMap contains a collection of cells. Each grid cell refers to a :ref:`MeshLibrary` item. All cells in the map have the same dimensions. - -A GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells. - -Tutorials ---------- - -- :doc:`../tutorials/3d/using_gridmaps` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_GridMap_clear: @@ -133,17 +136,17 @@ Clear all cells. .. _class_GridMap_get_bake_mesh_instance: -- :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** +- :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** .. _class_GridMap_get_bake_meshes: -- :ref:`Array` **get_bake_meshes** **(** **)** +- :ref:`Array` **get_bake_meshes** **(** **)** .. _class_GridMap_get_cell_item: - :ref:`int` **get_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const -The :ref:`MeshLibrary` item index located at the grid-based X, Y and Z coordinates. If the cell is empty, INVALID_CELL_ITEM will be returned. +The :ref:`MeshLibrary` item index located at the grid-based X, Y and Z coordinates. If the cell is empty, INVALID_CELL_ITEM will be returned. .. _class_GridMap_get_cell_item_orientation: @@ -161,15 +164,15 @@ The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is retu .. _class_GridMap_get_meshes: -- :ref:`Array` **get_meshes** **(** **)** +- :ref:`Array` **get_meshes** **(** **)** -Array of :ref:`Transform` and :ref:`Mesh` references corresponding to the non empty cells in the grid. The transforms are specified in world space. +Array of :ref:`Transform` and :ref:`Mesh` references corresponding to the non empty cells in the grid. The transforms are specified in world space. .. _class_GridMap_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** const -Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. +Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. .. _class_GridMap_make_baked_meshes: @@ -177,11 +180,11 @@ Array of :ref:`Vector3` with the non empty cell coordinates in th .. _class_GridMap_map_to_world: -- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const +- :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const .. _class_GridMap_resource_changed: -- void **resource_changed** **(** :ref:`Resource` resource **)** +- void **resource_changed** **(** :ref:`Resource` resource **)** .. _class_GridMap_set_cell_item: @@ -195,7 +198,7 @@ Optionally, the item's orientation can be passed. .. _class_GridMap_set_clip: -- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** +- void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** .. _class_GridMap_set_collision_layer_bit: @@ -207,6 +210,6 @@ Optionally, the item's orientation can be passed. .. _class_GridMap_world_to_map: -- :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const +- :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 34e766d3a..de30d65e5 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -7,8 +7,7 @@ GrooveJoint2D ============= -**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Groove constraint for 2D physics. -Member Variables ----------------- +Description +----------- + +Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. + +Property Descriptions +--------------------- .. _class_GrooveJoint2D_initial_offset: @@ -28,8 +32,3 @@ Member Variables - :ref:`float` **length** - The groove's length. The groove is from the joint's origin towards :ref:`length` along the joint's local y axis. Default value: ``50`` -Description ------------ - -Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. - diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 947582931..e5ed770b4 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -7,8 +7,7 @@ HBoxContainer ============= -**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Horizontal box container. Description ----------- -Horizontal box container. See :ref:`BoxContainer`. +Horizontal box container. See :ref:`BoxContainer`. diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 5a2f52e6d..c819bae6f 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -7,8 +7,7 @@ HingeJoint ========== -**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,39 @@ Brief Description A hinge between two 3D bodies. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_HingeJoint_Flag: + +enum **Flag** + +- **FLAG_USE_LIMIT** = **0** --- If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +- **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. +- **FLAG_MAX** = **2** --- End flag of FLAG\_\* constants, used internally. + + .. _enum_HingeJoint_Param: + +enum **Param** + +- **PARAM_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. +- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. +- **PARAM_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. +- **PARAM_LIMIT_SOFTNESS** = **4** +- **PARAM_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down. +- **PARAM_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. +- **PARAM_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. +- **PARAM_MAX** = **8** --- End flag of PARAM\_\* constants, used internally. + + +Description +----------- + +Normally uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. + +Property Descriptions +--------------------- .. _class_HingeJoint_angular_limit/bias: @@ -60,34 +90,3 @@ Member Variables - :ref:`float` **params/bias** - The speed with which the two bodies get pulled together when they move in different directions. -Enums ------ - - .. _enum_HingeJoint_Flag: - -enum **Flag** - -- **FLAG_USE_LIMIT** = **0** --- If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. -- **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. -- **FLAG_MAX** = **2** --- End flag of FLAG\_\* constants, used internally. - - .. _enum_HingeJoint_Param: - -enum **Param** - -- **PARAM_BIAS** = **0** --- The speed with which the two bodies get pulled together when they move in different directions. -- **PARAM_LIMIT_UPPER** = **1** --- The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. -- **PARAM_LIMIT_LOWER** = **2** --- The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. -- **PARAM_LIMIT_BIAS** = **3** --- The speed with which the rotation across the axis perpendicular to the hinge gets corrected. -- **PARAM_LIMIT_SOFTNESS** = **4** -- **PARAM_LIMIT_RELAXATION** = **5** --- The lower this value, the more the rotation gets slowed down. -- **PARAM_MOTOR_TARGET_VELOCITY** = **6** --- Target speed for the motor. -- **PARAM_MOTOR_MAX_IMPULSE** = **7** --- Maximum acceleration for the motor. -- **PARAM_MAX** = **8** --- End flag of PARAM\_\* constants, used internally. - - -Description ------------ - -Normally uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. - diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index a0626ed02..6643b0f6d 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -7,8 +7,7 @@ HScrollBar ========== -**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Horizontal scroll bar. Description ----------- -Horizontal scroll bar. See :ref:`ScrollBar`. This one goes from left (min) to right (max). +Horizontal scroll bar. See :ref:`ScrollBar`. This one goes from left (min) to right (max). diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 0d93c5d1d..8d09d5855 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -7,8 +7,7 @@ HSeparator ========== -**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Horizontal separator. Description ----------- -Horizontal separator. See :ref:`Separator`. It is used to separate objects vertically, though (but it looks horizontal!). +Horizontal separator. See :ref:`Separator`. It is used to separate objects vertically, though (but it looks horizontal!). diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index e0b5e68f5..89265490c 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -7,8 +7,7 @@ HSlider ======= -**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Horizontal slider. Description ----------- -Horizontal slider. See :ref:`Slider`. This one goes from left (min) to right (max). +Horizontal slider. See :ref:`Slider`. This one goes from left (min) to right (max). diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index 1d67b556f..a797c26f5 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -7,8 +7,7 @@ HSplitContainer =============== -**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Horizontal split container. Description ----------- -Horizontal split container. See :ref:`SplitContainer`. This goes from left to right. +Horizontal split container. See :ref:`SplitContainer`. This goes from left to right. diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index e4aa5d353..51f252a43 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -7,8 +7,7 @@ HTTPClient ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,55 +15,43 @@ Brief Description Hyper-text transfer protocol client. -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_response_body_length` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_response_code` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | +| :ref:`PoolStringArray` | :ref:`get_response_headers` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | +| :ref:`Dictionary` | :ref:`get_response_headers_as_dictionary` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_response` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_response_chunked` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | +| :ref:`Error` | :ref:`poll` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | +| :ref:`String` | :ref:`query_string_from_dict` **(** :ref:`Dictionary` fields **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | +| :ref:`PoolByteArray` | :ref:`read_response_body_chunk` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | +| :ref:`Error` | :ref:`request` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | +| :ref:`Error` | :ref:`request_raw` **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_read_chunk_size` **(** :ref:`int` bytes **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_HTTPClient_blocking_mode_enabled: - -- :ref:`bool` **blocking_mode_enabled** - If ``true``, execution will block until all data is read from the response. - - .. _class_HTTPClient_connection: - -- :ref:`StreamPeer` **connection** - The connection to use for this client. - - -Enums ------ +Enumerations +------------ .. _enum_HTTPClient_Status: @@ -180,8 +167,20 @@ Tutorials - :doc:`../tutorials/networking/http_client_class` - :doc:`../tutorials/networking/ssl_certificates` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_HTTPClient_blocking_mode_enabled: + +- :ref:`bool` **blocking_mode_enabled** - If ``true``, execution will block until all data is read from the response. + + .. _class_HTTPClient_connection: + +- :ref:`StreamPeer` **connection** - The connection to use for this client. + + +Method Descriptions +------------------- .. _class_HTTPClient_close: @@ -191,7 +190,7 @@ Closes the current connection, allowing reuse of this ``HTTPClient``. .. _class_HTTPClient_connect_to_host: -- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** +- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** Connect to a host. This needs to be done before any requests are sent. @@ -215,13 +214,13 @@ Returns the response's HTTP status code. .. _class_HTTPClient_get_response_headers: -- :ref:`PoolStringArray` **get_response_headers** **(** **)** +- :ref:`PoolStringArray` **get_response_headers** **(** **)** Returns the response headers. .. _class_HTTPClient_get_response_headers_as_dictionary: -- :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** +- :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. @@ -231,7 +230,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) .. _class_HTTPClient_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** const Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. @@ -249,13 +248,13 @@ If ``true`` this ``HTTPClient`` has a response that is chunked. .. _class_HTTPClient_poll: -- :ref:`Error` **poll** **(** **)** +- :ref:`Error` **poll** **(** **)** This needs to be called in order to have any request processed. Check results with :ref:`get_status` .. _class_HTTPClient_query_string_from_dict: -- :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** +- :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: @@ -275,13 +274,13 @@ Furthermore, if a key has a null value, only the key itself is added, without eq .. _class_HTTPClient_read_response_body_chunk: -- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** +- :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. .. _class_HTTPClient_request: -- :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** +- :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** Sends a request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. @@ -298,7 +297,7 @@ To create a POST request with query strings to push to the server, do: .. _class_HTTPClient_request_raw: -- :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** Sends a raw request to the connected host. The URL parameter is just the part after the host, so for ``http://somehost.com/index.php``, it is ``index.php``. diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index c9012d44f..65354e1cd 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -7,8 +7,7 @@ HTTPRequest =========== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description A node with the ability to send HTTP requests. -Member Functions ----------------- +Methods +------- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cancel_request` **(** **)** | @@ -26,9 +25,9 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_http_client_status` **(** **)** const | +| :ref:`Status` | :ref:`get_http_client_status` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | +| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -36,33 +35,13 @@ Signals .. _class_HTTPRequest_request_completed: -- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +- **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** This signal is emitted upon request completion. -Member Variables ----------------- - - .. _class_HTTPRequest_body_size_limit: - -- :ref:`int` **body_size_limit** - Maximum allowed size for response bodies. - - .. _class_HTTPRequest_download_file: - -- :ref:`String` **download_file** - The file to download into. Will output any received file into it. - - .. _class_HTTPRequest_max_redirects: - -- :ref:`int` **max_redirects** - Maximum number of allowed redirects. - - .. _class_HTTPRequest_use_threads: - -- :ref:`bool` **use_threads** - If ``true`` multithreading is used to improve performance. - - -Enums ------ +Enumerations +------------ .. _enum_HTTPRequest_Result: @@ -85,7 +64,7 @@ enum **Result** Description ----------- -A node with the ability to send HTTP requests. Uses :ref:`HTTPClient` internally. +A node with the ability to send HTTP requests. Uses :ref:`HTTPClient` internally. Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. @@ -94,8 +73,28 @@ Tutorials - :doc:`../tutorials/networking/ssl_certificates` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_HTTPRequest_body_size_limit: + +- :ref:`int` **body_size_limit** - Maximum allowed size for response bodies. + + .. _class_HTTPRequest_download_file: + +- :ref:`String` **download_file** - The file to download into. Will output any received file into it. + + .. _class_HTTPRequest_max_redirects: + +- :ref:`int` **max_redirects** - Maximum number of allowed redirects. + + .. _class_HTTPRequest_use_threads: + +- :ref:`bool` **use_threads** - If ``true`` multithreading is used to improve performance. + + +Method Descriptions +------------------- .. _class_HTTPRequest_cancel_request: @@ -117,16 +116,16 @@ Returns the amount of bytes this HTTPRequest downloaded. .. _class_HTTPRequest_get_http_client_status: -- :ref:`Status` **get_http_client_status** **(** **)** const +- :ref:`Status` **get_http_client_status** **(** **)** const -Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. +Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. .. _class_HTTPRequest_request: -- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** +- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PoolStringArray` custom_headers=PoolStringArray( ), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** -Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. +Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. -Returns ``OK`` if request is successfully created. (Does not imply that the server has responded), ``ERR_UNCONFIGURED`` if not in the tree, ``ERR_BUSY`` if still processing previous request, ``ERR_INVALID_PARAMETER`` if given string is not a valid URL format, or ``ERR_CANT_CONNECT`` if not using thread and the :ref:`HTTPClient` cannot connect to host. +Returns ``OK`` if request is successfully created. (Does not imply that the server has responded), ``ERR_UNCONFIGURED`` if not in the tree, ``ERR_BUSY`` if still processing previous request, ``ERR_INVALID_PARAMETER`` if given string is not a valid URL format, or ``ERR_CANT_CONNECT`` if not using thread and the :ref:`HTTPClient` cannot connect to host. diff --git a/classes/class_image.rst b/classes/class_image.rst index 1e37f51b0..581f14088 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -7,8 +7,7 @@ Image ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,41 +15,41 @@ Brief Description Image datatype. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bumpmap_to_normalmap` **(** :ref:`float` bump_scale=1.0 **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_mipmaps` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** | +| :ref:`Error` | :ref:`compress` **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`convert` **(** :ref:`Format` format **)** | +| void | :ref:`convert` **(** :ref:`Format` format **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`copy_from` **(** :ref:`Image` src **)** | +| void | :ref:`copy_from` **(** :ref:`Image` src **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** | +| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`decompress` **(** **)** | +| :ref:`Error` | :ref:`decompress` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | +| :ref:`AlphaMode` | :ref:`detect_alpha` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`expand_x2_hq2x` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fill` **(** :ref:`Color` color **)** | +| void | :ref:`fill` **(** :ref:`Color` color **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fix_alpha_edges` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -58,25 +57,25 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`flip_y` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | +| :ref:`Error` | :ref:`generate_mipmaps` **(** :ref:`bool` renormalize=false **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | +| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** const | +| :ref:`Color` | :ref:`get_pixelv` **(** :ref:`Vector2` src **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -88,13 +87,13 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_invisible` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`load_jpg_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`load_png_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`load_webp_from_buffer` **(** :ref:`PoolByteArray` buffer **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lock` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -102,17 +101,17 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`premultiply_alpha` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | +| :ref:`Image` | :ref:`rgbe_to_srgb` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | +| :ref:`Error` | :ref:`save_png` **(** :ref:`String` path **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | +| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | +| void | :ref:`set_pixelv` **(** :ref:`Vector2` dst, :ref:`Color` color **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shrink_x2` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,16 +120,8 @@ Member Functions | void | :ref:`unlock` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Image_data: - -- :ref:`Dictionary` **data** - Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. - - -Enums ------ +Enumerations +------------ .. _enum_Image_CompressMode: @@ -220,32 +211,40 @@ enum **Format** Description ----------- -Native image datatype. Contains image data, which can be converted to a :ref:`Texture`, and several functions to interact with it. The maximum width and height for an ``Image`` is 16384 pixels. +Native image datatype. Contains image data, which can be converted to a :ref:`Texture`, and several functions to interact with it. The maximum width and height for an ``Image`` is 16384 pixels. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Image_data: + +- :ref:`Dictionary` **data** - Holds all of the image's color data in a given format. See ``FORMAT_*`` constants. + + +Method Descriptions +------------------- .. _class_Image_blend_rect: -- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends ``src_rect`` from ``src`` image to this image at coordinates ``dest``. .. _class_Image_blend_rect_mask: -- void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Alpha-blends ``src_rect`` from ``src`` image to this image using ``mask`` image at coordinates ``dst``. Alpha channels are required for both ``src`` and ``mask``. ``dst`` pixels and ``src`` pixels will blend if the corresponding mask pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. .. _class_Image_blit_rect: -- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copies ``src_rect`` from ``src`` image to this image at coordinates ``dst``. .. _class_Image_blit_rect_mask: -- void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** +- void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Blits ``src_rect`` area from ``src`` image to this image at the coordinates given by ``dst``. ``src`` pixel is copied onto ``dst`` if the corresponding ``mask`` pixel's alpha value is not 0. ``src`` image and ``mask`` image **must** have the same size (width and height) but they can have different formats. @@ -261,31 +260,31 @@ Removes the image's mipmaps. .. _class_Image_compress: -- :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** +- :ref:`Error` **compress** **(** :ref:`CompressMode` mode, :ref:`CompressSource` source, :ref:`float` lossy_quality **)** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See ``COMPRESS_*`` constants. .. _class_Image_convert: -- void **convert** **(** :ref:`Format` format **)** +- void **convert** **(** :ref:`Format` format **)** Converts the image's format. See ``FORMAT_*`` constants. .. _class_Image_copy_from: -- void **copy_from** **(** :ref:`Image` src **)** +- void **copy_from** **(** :ref:`Image` src **)** Copies ``src`` image to this image. .. _class_Image_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. .. _class_Image_create_from_data: -- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** +- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. @@ -297,13 +296,13 @@ Crops the image to the given ``width`` and ``height``. If the specified size is .. _class_Image_decompress: -- :ref:`Error` **decompress** **(** **)** +- :ref:`Error` **decompress** **(** **)** Decompresses the image if it is compressed. Returns an error if decompress function is not available. .. _class_Image_detect_alpha: -- :ref:`AlphaMode` **detect_alpha** **(** **)** const +- :ref:`AlphaMode` **detect_alpha** **(** **)** const Returns ALPHA_BLEND if the image has data for alpha values. Returns ALPHA_BIT if all the alpha values are below a certain threshold or the maximum value. Returns ALPHA_NONE if no data for alpha values is found. @@ -315,9 +314,9 @@ Stretches the image and enlarges it by a factor of 2. No interpolation is done. .. _class_Image_fill: -- void **fill** **(** :ref:`Color` color **)** +- void **fill** **(** :ref:`Color` color **)** -Fills the image with a given :ref:`Color`. +Fills the image with a given :ref:`Color`. .. _class_Image_fix_alpha_edges: @@ -339,19 +338,19 @@ Flips the image vertically. .. _class_Image_generate_mipmaps: -- :ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** +- :ref:`Error` **generate_mipmaps** **(** :ref:`bool` renormalize=false **)** Generates mipmaps for the image. Mipmaps are pre-calculated and lower resolution copies of the image. Mipmaps are automatically used if the image needs to be scaled down when rendered. This improves image quality and the performance of the rendering. Returns an error if the image is compressed, in a custom format or if the image's width/height is 0. .. _class_Image_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** const +- :ref:`PoolByteArray` **get_data** **(** **)** const Returns the image's raw data. .. _class_Image_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** const Returns the image’s format. See ``FORMAT_*`` constants. @@ -369,31 +368,31 @@ Returns the offset where the image's mipmap with index ``mipmap`` is stored in t .. _class_Image_get_pixel: -- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const +- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const -Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. +Returns the color of the pixel at ``(x, y)`` if the image is locked. If the image is unlocked it always returns a :ref:`Color` with the value ``(0, 0, 0, 1.0)``. .. _class_Image_get_pixelv: -- :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const +- :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const .. _class_Image_get_rect: -- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const +- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const Returns a new image that is a copy of the image's area specified with ``rect``. .. _class_Image_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Returns the image's size (width and height). .. _class_Image_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** const +- :ref:`Rect2` **get_used_rect** **(** **)** const -Returns a :ref:`Rect2` enclosing the visible portion of the image. +Returns a :ref:`Rect2` enclosing the visible portion of the image. .. _class_Image_get_width: @@ -427,25 +426,25 @@ Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``f .. _class_Image_load: -- :ref:`Error` **load** **(** :ref:`String` path **)** +- :ref:`Error` **load** **(** :ref:`String` path **)** Loads an image from file ``path``. .. _class_Image_load_jpg_from_buffer: -- :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_jpg_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a JPEG file. .. _class_Image_load_png_from_buffer: -- :ref:`Error` **load_png_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_png_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a PNG file. .. _class_Image_load_webp_from_buffer: -- :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a WebP file. @@ -469,7 +468,7 @@ Multiplies color values with alpha values. Resulting color values for a pixel ar .. _class_Image_resize: -- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** +- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`Interpolation` interpolation=1 **)** Resizes the image to the given ``width`` and ``height``. New pixels are calculated using ``interpolation``. See ``interpolation`` constants. @@ -481,19 +480,19 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar .. _class_Image_rgbe_to_srgb: -- :ref:`Image` **rgbe_to_srgb** **(** **)** +- :ref:`Image` **rgbe_to_srgb** **(** **)** .. _class_Image_save_png: -- :ref:`Error` **save_png** **(** :ref:`String` path **)** const +- :ref:`Error` **save_png** **(** :ref:`String` path **)** const Saves the image as a PNG file to ``path``. .. _class_Image_set_pixel: -- void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** +- void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** -Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is locked. Example: +Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is locked. Example: :: @@ -506,7 +505,7 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo .. _class_Image_set_pixelv: -- void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** +- void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** .. _class_Image_shrink_x2: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 9ff434943..5ec8aeaa7 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -7,34 +7,50 @@ ImageTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A :ref:`Texture` based on an :ref:`Image`. +A :ref:`Texture` based on an :ref:`Image`. -Member Functions ----------------- +Methods +------- +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +| void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`load` **(** :ref:`String` path **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data` **(** :ref:`Image` image **)** | +| void | :ref:`set_data` **(** :ref:`Image` image **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | +| void | :ref:`set_size_override` **(** :ref:`Vector2` size **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_ImageTexture_Storage: + +enum **Storage** + +- **STORAGE_RAW** = **0** --- :ref:`Image` data is stored raw and unaltered. +- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`set_lossy_storage_quality`. +- **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image` data is compressed with a lossless algorithm. + + +Description +----------- + +A :ref:`Texture` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. + +Property Descriptions +--------------------- .. _class_ImageTexture_lossy_quality: @@ -42,66 +58,49 @@ Member Variables .. _class_ImageTexture_storage: -- :ref:`Storage` **storage** - The storage type (raw, lossy, or compressed). +- :ref:`Storage` **storage** - The storage type (raw, lossy, or compressed). -Enums ------ - - .. _enum_ImageTexture_Storage: - -enum **Storage** - -- **STORAGE_RAW** = **0** --- :ref:`Image` data is stored raw and unaltered. -- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`set_lossy_storage_quality`. -- **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image` data is compressed with a lossless algorithm. - - -Description ------------ - -A :ref:`Texture` based on an :ref:`Image`. Can be created from an :ref:`Image` with :ref:`create_from_image`. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ImageTexture_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** Create a new ``ImageTexture`` with "width" and "height". -"format" one of :ref:`Image`.FORMAT\_\*. +"format" one of :ref:`Image`.FORMAT\_\*. -"flags" one or more of :ref:`Texture`.FLAG\_\*. +"flags" one or more of :ref:`Texture`.FLAG\_\*. .. _class_ImageTexture_create_from_image: -- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- void **create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** -Create a new ``ImageTexture`` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. +Create a new ``ImageTexture`` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. .. _class_ImageTexture_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** const -Return the format of the ``ImageTexture``, one of :ref:`Image`.FORMAT\_\*. +Return the format of the ``ImageTexture``, one of :ref:`Image`.FORMAT\_\*. .. _class_ImageTexture_load: -- :ref:`Error` **load** **(** :ref:`String` path **)** +- :ref:`Error` **load** **(** :ref:`String` path **)** Load an ``ImageTexture`` from a file path. .. _class_ImageTexture_set_data: -- void **set_data** **(** :ref:`Image` image **)** +- void **set_data** **(** :ref:`Image` image **)** -Set the :ref:`Image` of this ``ImageTexture``. +Set the :ref:`Image` of this ``ImageTexture``. .. _class_ImageTexture_set_size_override: -- void **set_size_override** **(** :ref:`Vector2` size **)** +- void **set_size_override** **(** :ref:`Vector2` size **)** Resizes the ``ImageTexture`` to the specified dimensions. diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index bed68ef6b..ae4d329b7 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -7,8 +7,7 @@ ImmediateGeometry ================= -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,29 +15,29 @@ Brief Description Draws simple geometry from code. -Member Functions ----------------- +Methods +------- +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | +| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** | +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`end` **(** **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | +| void | :ref:`set_color` **(** :ref:`Color` color **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | +| void | :ref:`set_normal` **(** :ref:`Vector3` normal **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | +| void | :ref:`set_tangent` **(** :ref:`Plane` tangent **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | +| void | :ref:`set_uv` **(** :ref:`Vector2` uv **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | +| void | :ref:`set_uv2` **(** :ref:`Vector2` uv **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -46,8 +45,8 @@ Description Draws simple geometry from code. Uses a drawing mode similar to OpenGL 1.x. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ImmediateGeometry_add_sphere: @@ -57,17 +56,17 @@ Simple helper to draw a uvsphere, with given latitudes, longitude and radius. .. _class_ImmediateGeometry_add_vertex: -- void **add_vertex** **(** :ref:`Vector3` position **)** +- void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. .. _class_ImmediateGeometry_begin: -- void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** +- void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. -For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumerations. +For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumerations. .. _class_ImmediateGeometry_clear: @@ -83,31 +82,31 @@ Ends a drawing context and displays the results. .. _class_ImmediateGeometry_set_color: -- void **set_color** **(** :ref:`Color` color **)** +- void **set_color** **(** :ref:`Color` color **)** The current drawing color. .. _class_ImmediateGeometry_set_normal: -- void **set_normal** **(** :ref:`Vector3` normal **)** +- void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. .. _class_ImmediateGeometry_set_tangent: -- void **set_tangent** **(** :ref:`Plane` tangent **)** +- void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). .. _class_ImmediateGeometry_set_uv: -- void **set_uv** **(** :ref:`Vector2` uv **)** +- void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. .. _class_ImmediateGeometry_set_uv2: -- void **set_uv2** **(** :ref:`Vector2` uv **)** +- void **set_uv2** **(** :ref:`Vector2` uv **)** The next vertex's second layer UV. diff --git a/classes/class_input.rst b/classes/class_input.rst index 769a04876..a3b86f9d1 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -7,10 +7,8 @@ Input ===== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`InputDefault` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`InputDefault` **Category:** Core Brief Description @@ -18,57 +16,57 @@ Brief Description A Singleton that deals with inputs. -Member Functions ----------------- +Methods +------- +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action **)** | +| void | :ref:`action_press` **(** :ref:`String` action **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | +| void | :ref:`action_release` **(** :ref:`String` action **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | +| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -78,23 +76,23 @@ Member Functions +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | +| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | +| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | +| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -107,8 +105,8 @@ Signals Emitted when a joypad device has been connected or disconnected. -Enums ------ +Enumerations +------------ .. _enum_Input_MouseMode: @@ -145,93 +143,95 @@ enum **CursorShape** Description ----------- -A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap`. +A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap`. Tutorials --------- - :doc:`../tutorials/inputs/index` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Input_action_press: -- void **action_press** **(** :ref:`String` action **)** +- void **action_press** **(** :ref:`String` action **)** This will simulate pressing the specified action. .. _class_Input_action_release: -- void **action_release** **(** :ref:`String` action **)** +- void **action_release** **(** :ref:`String` action **)** If the specified action is already pressed, this will release it. .. _class_Input_add_joy_mapping: -- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** +- void **add_joy_mapping** **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. .. _class_Input_get_accelerometer: -- :ref:`Vector3` **get_accelerometer** **(** **)** const +- :ref:`Vector3` **get_accelerometer** **(** **)** const -If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty :ref:`Vector3`. +If the device has an accelerometer, this will return the acceleration. Otherwise, it returns an empty :ref:`Vector3`. + +Note this method returns an empty :ref:`Vector3` when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. .. _class_Input_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const .. _class_Input_get_connected_joypads: -- :ref:`Array` **get_connected_joypads** **(** **)** +- :ref:`Array` **get_connected_joypads** **(** **)** -Returns an :ref:`Array` containing the device IDs of all currently connected joypads. +Returns an :ref:`Array` containing the device IDs of all currently connected joypads. .. _class_Input_get_gravity: -- :ref:`Vector3` **get_gravity** **(** **)** const +- :ref:`Vector3` **get_gravity** **(** **)** const -If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. +If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. .. _class_Input_get_gyroscope: -- :ref:`Vector3` **get_gyroscope** **(** **)** const +- :ref:`Vector3` **get_gyroscope** **(** **)** const -If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. Otherwise, it returns an empty :ref:`Vector3`. +If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. Otherwise, it returns an empty :ref:`Vector3`. .. _class_Input_get_joy_axis: - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const -Returns the current value of the joypad axis at given index (see ``JOY_*`` constants in :ref:`@GlobalScope`) +Returns the current value of the joypad axis at given index (see ``JOY_*`` constants in :ref:`@GlobalScope`) .. _class_Input_get_joy_axis_index_from_string: -- :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** +- :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** .. _class_Input_get_joy_axis_string: -- :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** +- :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** .. _class_Input_get_joy_button_index_from_string: -- :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** +- :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** .. _class_Input_get_joy_button_string: -- :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** +- :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** .. _class_Input_get_joy_guid: -- :ref:`String` **get_joy_guid** **(** :ref:`int` device **)** const +- :ref:`String` **get_joy_guid** **(** :ref:`int` device **)** const Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. .. _class_Input_get_joy_name: -- :ref:`String` **get_joy_name** **(** :ref:`int` device **)** +- :ref:`String` **get_joy_name** **(** :ref:`int` device **)** Returns the name of the joypad at the specified device index @@ -243,19 +243,19 @@ Returns the duration of the current vibration effect in seconds. .. _class_Input_get_joy_vibration_strength: -- :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** +- :ref:`Vector2` **get_joy_vibration_strength** **(** :ref:`int` device **)** Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. .. _class_Input_get_last_mouse_speed: -- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const +- :ref:`Vector2` **get_last_mouse_speed** **(** **)** const Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. .. _class_Input_get_magnetometer: -- :ref:`Vector3` **get_magnetometer** **(** **)** const +- :ref:`Vector3` **get_magnetometer** **(** **)** const If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. @@ -267,13 +267,13 @@ Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the .. _class_Input_get_mouse_mode: -- :ref:`MouseMode` **get_mouse_mode** **(** **)** const +- :ref:`MouseMode` **get_mouse_mode** **(** **)** const Return the mouse mode. See the constants for more information. .. _class_Input_is_action_just_pressed: -- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const Returns ``true`` when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button. @@ -281,13 +281,13 @@ This is useful for code that needs to run only once when an action is pressed, i .. _class_Input_is_action_just_released: -- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const Returns ``true`` when the user stops pressing the action event, meaning it's true only on the frame that the user released the button. .. _class_Input_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if you are pressing the action event. @@ -295,55 +295,59 @@ Returns ``true`` if you are pressing the action event. - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const -Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) +Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) .. _class_Input_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY_*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. +Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY_*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_is_key_pressed: - :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const -Returns ``true`` if you are pressing the key. You can pass ``KEY_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the key. You can pass ``KEY_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_is_mouse_button_pressed: - :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const -Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. .. _class_Input_joy_connection_changed: -- void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** +- void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** .. _class_Input_parse_input_event: -- void **parse_input_event** **(** :ref:`InputEvent` event **)** +- void **parse_input_event** **(** :ref:`InputEvent` event **)** -Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. +Feeds an :ref:`InputEvent` to the game. Can be used to artificially trigger input events from code. .. _class_Input_remove_joy_mapping: -- void **remove_joy_mapping** **(** :ref:`String` guid **)** +- void **remove_joy_mapping** **(** :ref:`String` guid **)** Removes all mappings from the internal db that match the given uid. .. _class_Input_set_custom_mouse_cursor: -- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** +- void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing ``null`` to the image parameter resets to the system cursor. See enum ``CURSOR_*`` for the list of shapes. +``image``'s size must be lower than 256x256. + +``hotspot`` must be within ``image``'s size. + .. _class_Input_set_default_cursor_shape: -- void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** +- void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** .. _class_Input_set_mouse_mode: -- void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** +- void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** Set the mouse mode. See the constants for more information. @@ -363,7 +367,7 @@ Stops the vibration of the joypad. .. _class_Input_warp_mouse_position: -- void **warp_mouse_position** **(** :ref:`Vector2` to **)** +- void **warp_mouse_position** **(** :ref:`Vector2` to **)** Sets the mouse position to the specified vector. diff --git a/classes/class_inputdefault.rst b/classes/class_inputdefault.rst index d8ac18fe0..fe30dc3c5 100644 --- a/classes/class_inputdefault.rst +++ b/classes/class_inputdefault.rst @@ -7,17 +7,16 @@ InputDefault ============ -**Inherits:** :ref:`Input` **<** :ref:`Object` - +**Inherits:** :ref:`Input` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Default implementation of the :ref:`Input` class. +Default implementation of the :ref:`Input` class. Description ----------- -Default implementation of the :ref:`Input` class, used internally by the editor and games for default input management. +Default implementation of the :ref:`Input` class, used internally by the editor and games for default input management. diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index b450f2b6b..5f2b643e2 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -7,10 +7,8 @@ InputEvent ========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers`, :ref:`InputEventScreenDrag`, :ref:`InputEventJoypadMotion`, :ref:`InputEventJoypadButton`, :ref:`InputEventAction` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers`, :ref:`InputEventScreenDrag`, :ref:`InputEventJoypadMotion`, :ref:`InputEventJoypadButton`, :ref:`InputEventAction` **Category:** Core Brief Description @@ -18,19 +16,19 @@ Brief Description Generic input event -Member Functions ----------------- +Methods +------- +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`as_text` **(** **)** const | +| :ref:`String` | :ref:`as_text` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_action_type` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,19 +36,11 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_InputEvent_device: - -- :ref:`int` **device** - The event's device ID. - - Description ----------- @@ -62,34 +52,42 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` - :doc:`../tutorials/2d/2d_transforms` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_InputEvent_device: + +- :ref:`int` **device** - The event's device ID. + + +Method Descriptions +------------------- .. _class_InputEvent_as_text: -- :ref:`String` **as_text** **(** **)** const +- :ref:`String` **as_text** **(** **)** const -Returns a :ref:`String` representation of the event. +Returns a :ref:`String` representation of the event. .. _class_InputEvent_get_action_strength: -- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const +- :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const .. _class_InputEvent_is_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action** **(** :ref:`String` action **)** const Returns ``true`` if this input event matches a pre-defined action of any type. .. _class_InputEvent_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const 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`` or ``NONE``. .. _class_InputEvent_is_action_released: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const +- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const Returns ``true`` if the given action is released (i.e. not pressed). Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. @@ -113,10 +111,10 @@ Returns ``true`` if this input event is pressed. Not relevant for the event type .. _class_InputEvent_shortcut_match: -- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const .. _class_InputEvent_xformed_by: -- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2( 0, 0 ) **)** const diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 0f0a03aca..7a7980755 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -7,8 +7,7 @@ InputEventAction ================ -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Input event type for actions. -Member Variables ----------------- - - .. _class_InputEventAction_action: - -- :ref:`String` **action** - The action's name. Actions are accessed via this :ref:`String`. - - .. _class_InputEventAction_pressed: - -- :ref:`bool` **pressed** - If ``true`` the action's state is pressed. If ``false`` the action's state is released. - - Description ----------- @@ -38,3 +25,15 @@ Tutorials - `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent` +Property Descriptions +--------------------- + + .. _class_InputEventAction_action: + +- :ref:`String` **action** - The action's name. Actions are accessed via this :ref:`String`. + + .. _class_InputEventAction_pressed: + +- :ref:`bool` **pressed** - If ``true`` the action's state is pressed. If ``false`` the action's state is released. + + diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index f271d669a..1dca67e83 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -7,10 +7,8 @@ InputEventGesture ================= -**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`InputEventPanGesture`, :ref:`InputEventMagnifyGesture` - +**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`InputEventPanGesture`, :ref:`InputEventMagnifyGesture` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_InputEventGesture_position: -- :ref:`Vector2` **position** +- :ref:`Vector2` **position** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index ac92b00e3..772ec5d2b 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -7,8 +7,7 @@ InputEventJoypadButton ====================== -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,22 @@ Brief Description Input event for gamepad buttons. -Member Variables ----------------- +Description +----------- + +Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion`. + +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + +Property Descriptions +--------------------- .. _class_InputEventJoypadButton_button_index: -- :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. +- :ref:`int` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. .. _class_InputEventJoypadButton_pressed: @@ -32,13 +41,3 @@ Member Variables - :ref:`float` **pressure** - Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``. -Description ------------ - -Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion`. - -Tutorials ---------- - -- :doc:`../tutorials/inputs/inputevent` - diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index abceee2fc..bf32ea40e 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -7,8 +7,7 @@ InputEventJoypadMotion ====================== -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Input event type for gamepad joysticks and other motions. For buttons see ``InputEventJoypadButton``. -Member Variables ----------------- - - .. _class_InputEventJoypadMotion_axis: - -- :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. - - .. _class_InputEventJoypadMotion_axis_value: - -- :ref:`float` **axis_value** - Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. - - Description ----------- @@ -38,3 +25,15 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` +Property Descriptions +--------------------- + + .. _class_InputEventJoypadMotion_axis: + +- :ref:`int` **axis** - Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. + + .. _class_InputEventJoypadMotion_axis_value: + +- :ref:`float` **axis_value** - Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position. + + diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 676715d16..b0b0be9ef 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -7,8 +7,7 @@ InputEventKey ============= -**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,13 @@ Brief Description Input event type for keyboard events. -Member Functions ----------------- +Methods +------- +------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | +------------------------+-------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_InputEventKey_echo: - -- :ref:`bool` **echo** - If ``true`` the key was already pressed before this event. It means the user is holding the key down. - - .. _class_InputEventKey_pressed: - -- :ref:`bool` **pressed** - If ``true`` the key's state is pressed. If ``false`` the key's state is released. - - .. _class_InputEventKey_scancode: - -- :ref:`int` **scancode** - Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. - - .. _class_InputEventKey_unicode: - -- :ref:`int` **unicode** - Key unicode identifier when relevant. - - Description ----------- @@ -53,13 +32,33 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_InputEventKey_echo: + +- :ref:`bool` **echo** - If ``true`` the key was already pressed before this event. It means the user is holding the key down. + + .. _class_InputEventKey_pressed: + +- :ref:`bool` **pressed** - If ``true`` the key's state is pressed. If ``false`` the key's state is released. + + .. _class_InputEventKey_scancode: + +- :ref:`int` **scancode** - Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. + + .. _class_InputEventKey_unicode: + +- :ref:`int` **unicode** - Key unicode identifier when relevant. + + +Method Descriptions +------------------- .. _class_InputEventKey_get_scancode_with_modifiers: - :ref:`int` **get_scancode_with_modifiers** **(** **)** const -Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. +Returns the scancode combined with modifier keys such as ``Shift`` or ``Alt``. See also :ref:`InputEventWithModifiers`. diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index b85913ef6..f397505c8 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -7,8 +7,7 @@ InputEventMagnifyGesture ======================== -**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_InputEventMagnifyGesture_factor: diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index bb384c84f..5fbec78ac 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -7,10 +7,8 @@ InputEventMouse =============== -**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`InputEventMouseMotion`, :ref:`InputEventMouseButton` - +**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`InputEventMouseMotion`, :ref:`InputEventMouseButton` **Category:** Core Brief Description @@ -18,22 +16,6 @@ Brief Description Base input event type for mouse events. -Member Variables ----------------- - - .. _class_InputEventMouse_button_mask: - -- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. - - .. _class_InputEventMouse_global_position: - -- :ref:`Vector2` **global_position** - Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. - - .. _class_InputEventMouse_position: - -- :ref:`Vector2` **position** - Mouse local position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input` the position is relative to the current :ref:`Control` which is under the mouse. - - Description ----------- @@ -44,3 +26,19 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` +Property Descriptions +--------------------- + + .. _class_InputEventMouse_button_mask: + +- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. + + .. _class_InputEventMouse_global_position: + +- :ref:`Vector2` **global_position** - Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. + + .. _class_InputEventMouse_position: + +- :ref:`Vector2` **position** - Mouse local position relative to the :ref:`Viewport`. If used in :ref:`Control._gui_input` the position is relative to the current :ref:`Control` which is under the mouse. + + diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index a4baeafc4..52559d920 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -7,8 +7,7 @@ InputEventMouseButton ===================== -**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,22 @@ Brief Description Input event type for mouse button events. -Member Variables ----------------- +Description +----------- + +Contains mouse click information. See :ref:`Node._input`. + +Tutorials +--------- + +- :doc:`../tutorials/inputs/mouse_and_input_coordinates` + +Property Descriptions +--------------------- .. _class_InputEventMouseButton_button_index: -- :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. +- :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. .. _class_InputEventMouseButton_doubleclick: @@ -36,13 +45,3 @@ Member Variables - :ref:`bool` **pressed** - If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released. -Description ------------ - -Contains mouse click information. See :ref:`Node._input`. - -Tutorials ---------- - -- :doc:`../tutorials/inputs/mouse_and_input_coordinates` - diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 704275ee7..0099415db 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -7,8 +7,7 @@ InputEventMouseMotion ===================== -**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Input event type for mouse motion events. -Member Variables ----------------- - - .. _class_InputEventMouseMotion_relative: - -- :ref:`Vector2` **relative** - Mouse position relative to the previous position (position at the last frame). - - .. _class_InputEventMouseMotion_speed: - -- :ref:`Vector2` **speed** - Mouse speed. - - Description ----------- @@ -38,3 +25,15 @@ Tutorials - :doc:`../tutorials/inputs/mouse_and_input_coordinates` +Property Descriptions +--------------------- + + .. _class_InputEventMouseMotion_relative: + +- :ref:`Vector2` **relative** - Mouse position relative to the previous position (position at the last frame). + + .. _class_InputEventMouseMotion_speed: + +- :ref:`Vector2` **speed** - Mouse speed. + + diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index a282427a3..eef299ae1 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -7,8 +7,7 @@ InputEventPanGesture ==================== -**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_InputEventPanGesture_delta: -- :ref:`Vector2` **delta** +- :ref:`Vector2` **delta** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 1cf11897f..d59918fca 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -7,8 +7,7 @@ InputEventScreenDrag ==================== -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,26 +17,6 @@ Input event type for screen drag events. (only available on mobile devices) -Member Variables ----------------- - - .. _class_InputEventScreenDrag_index: - -- :ref:`int` **index** - Drag event index in the case of a multi-drag event. - - .. _class_InputEventScreenDrag_position: - -- :ref:`Vector2` **position** - Drag position. - - .. _class_InputEventScreenDrag_relative: - -- :ref:`Vector2` **relative** - Drag position relative to its start position. - - .. _class_InputEventScreenDrag_speed: - -- :ref:`Vector2` **speed** - Drag speed. - - Description ----------- @@ -48,3 +27,23 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` +Property Descriptions +--------------------- + + .. _class_InputEventScreenDrag_index: + +- :ref:`int` **index** - Drag event index in the case of a multi-drag event. + + .. _class_InputEventScreenDrag_position: + +- :ref:`Vector2` **position** - Drag position. + + .. _class_InputEventScreenDrag_relative: + +- :ref:`Vector2` **relative** - Drag position relative to its start position. + + .. _class_InputEventScreenDrag_speed: + +- :ref:`Vector2` **speed** - Drag speed. + + diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index fc177dee4..6e51fb6c5 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -7,8 +7,7 @@ InputEventScreenTouch ===================== -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -18,22 +17,6 @@ Input event type for screen touch events. (only available on mobile devices) -Member Variables ----------------- - - .. _class_InputEventScreenTouch_index: - -- :ref:`int` **index** - Touch index in the case of a multi-touch event. One index = one finger. - - .. _class_InputEventScreenTouch_position: - -- :ref:`Vector2` **position** - Touch position. - - .. _class_InputEventScreenTouch_pressed: - -- :ref:`bool` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. - - Description ----------- @@ -44,3 +27,19 @@ Tutorials - :doc:`../tutorials/inputs/inputevent` +Property Descriptions +--------------------- + + .. _class_InputEventScreenTouch_index: + +- :ref:`int` **index** - Touch index in the case of a multi-touch event. One index = one finger. + + .. _class_InputEventScreenTouch_position: + +- :ref:`Vector2` **position** - Touch position. + + .. _class_InputEventScreenTouch_pressed: + +- :ref:`bool` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. + + diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 4ad5eafd2..d7d2c7f3f 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -7,10 +7,8 @@ InputEventWithModifiers ======================= -**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse`, :ref:`InputEventGesture` - +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse`, :ref:`InputEventGesture` **Category:** Core Brief Description @@ -18,8 +16,18 @@ Brief Description Base class for keys events with modifiers. -Member Variables ----------------- +Description +----------- + +Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. + +Tutorials +--------- + +- :doc:`../tutorials/inputs/inputevent` + +Property Descriptions +--------------------- .. _class_InputEventWithModifiers_alt: @@ -42,13 +50,3 @@ Member Variables - :ref:`bool` **shift** - State of the Shift modifier. -Description ------------ - -Contains keys events information with modifiers support like ``SHIFT`` or ``ALT``. See :ref:`Node._input`. - -Tutorials ---------- - -- :doc:`../tutorials/inputs/inputevent` - diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 1bdd4ae06..d557a879a 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -7,40 +7,39 @@ InputMap ======== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- -Singleton that manages :ref:`InputEventAction`. +Singleton that manages :ref:`InputEventAction`. -Member Functions ----------------- +Methods +------- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_events` **(** :ref:`String` action **)** | +| void | :ref:`action_erase_events` **(** :ref:`String` action **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | +| void | :ref:`action_set_deadzone` **(** :ref:`String` action, :ref:`float` deadzone **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | +| void | :ref:`add_action` **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | +| void | :ref:`erase_action` **(** :ref:`String` action **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | +| :ref:`Array` | :ref:`get_actions` **(** **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | +| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`load_from_globals` **(** **)** | +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -48,79 +47,79 @@ Member Functions Description ----------- -Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. +Manages all :ref:`InputEventAction` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action` and :ref:`action_add_event`. See :ref:`Node._input`. Tutorials --------- - `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_InputMap_action_add_event: -- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** -Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. +Adds an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. .. _class_InputMap_action_erase_event: -- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** -Removes an :ref:`InputEvent` from an action. +Removes an :ref:`InputEvent` from an action. .. _class_InputMap_action_erase_events: -- void **action_erase_events** **(** :ref:`String` action **)** +- void **action_erase_events** **(** :ref:`String` action **)** Removes all events from an action. .. _class_InputMap_action_has_event: -- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** -Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. +Returns ``true`` if the action has the given :ref:`InputEvent` associated with it. .. _class_InputMap_action_set_deadzone: -- void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** +- void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** .. _class_InputMap_add_action: -- void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** +- void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** Adds an empty action to the ``InputMap`` with a configurable ``deadzone``. -An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. +An :ref:`InputEvent` can then be added to this action with :ref:`action_add_event`. .. _class_InputMap_erase_action: -- void **erase_action** **(** :ref:`String` action **)** +- void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. .. _class_InputMap_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const -Returns true if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`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 :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. .. _class_InputMap_get_action_list: -- :ref:`Array` **get_action_list** **(** :ref:`String` action **)** +- :ref:`Array` **get_action_list** **(** :ref:`String` action **)** -Returns an array of :ref:`InputEvent`\ s associated with a given action. +Returns an array of :ref:`InputEvent`\ s associated with a given action. .. _class_InputMap_get_actions: -- :ref:`Array` **get_actions** **(** **)** +- :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. .. _class_InputMap_has_action: -- :ref:`bool` **has_action** **(** :ref:`String` action **)** const +- :ref:`bool` **has_action** **(** :ref:`String` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. @@ -128,6 +127,6 @@ Returns ``true`` if the ``InputMap`` has a registered action with the given name - void **load_from_globals** **(** **)** -Clears all :ref:`InputEventAction` in the ``InputMap`` and load it anew from :ref:`ProjectSettings`. +Clears all :ref:`InputEventAction` in the ``InputMap`` and load it anew from :ref:`ProjectSettings`. diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 480199e1a..44f60ae9f 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -7,26 +7,25 @@ InstancePlaceholder =================== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Placeholder for the root :ref:`Node` of a :ref:`PackedScene`. +Placeholder for the root :ref:`Node` of a :ref:`PackedScene`. -Member Functions ----------------- +Methods +------- +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | +| :ref:`Node` | :ref:`create_instance` **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_path` **(** **)** const | +| :ref:`String` | :ref:`get_instance_path` **(** **)** const | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | +| :ref:`Dictionary` | :ref:`get_stored_values` **(** :ref:`bool` with_order=false **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | +| void | :ref:`replace_by_instance` **(** :ref:`PackedScene` custom_scene=null **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -36,26 +35,26 @@ Turning on the option **Load As Placeholder** for an instanced scene in the edit The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_InstancePlaceholder_create_instance: -- :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** +- :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** .. _class_InstancePlaceholder_get_instance_path: -- :ref:`String` **get_instance_path** **(** **)** const +- :ref:`String` **get_instance_path** **(** **)** const -Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. +Retrieve the path to the :ref:`PackedScene` resource file that is loaded by default when calling :ref:`replace_by_instance`. .. _class_InstancePlaceholder_get_stored_values: -- :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** +- :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** .. _class_InstancePlaceholder_replace_by_instance: -- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** +- void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. diff --git a/classes/class_int.rst b/classes/class_int.rst index 786ed1cb8..7e5699294 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -14,15 +14,15 @@ Brief Description Integer built-in type. -Member Functions ----------------- +Methods +------- +------------------------+------------------------------------------------------------------------+ | :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | +------------------------+------------------------------------------------------------------------+ | :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | +------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | +| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | +------------------------+------------------------------------------------------------------------+ Description @@ -30,8 +30,8 @@ Description Integer built-in type. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_int_int: @@ -47,8 +47,8 @@ Cast a float value to an integer value, this method simply removes the number fr .. _class_int_int: -- :ref:`int` **int** **(** :ref:`String` from **)** +- :ref:`int` **int** **(** :ref:`String` from **)** -Cast a :ref:`String` value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like ``'1.7'``. This method will ignore all non-number characters, so calling ``int('1e3')`` will return 13. +Cast a :ref:`String` value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like ``'1.7'``. This method will ignore all non-number characters, so calling ``int('1e3')`` will return 13. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index f98374a8d..b4887642f 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -7,8 +7,7 @@ InterpolatedCamera ================== -**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Camera` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,22 @@ Brief Description Camera which moves toward another node. -Member Functions ----------------- +Methods +------- +-------+-------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_target` **(** :ref:`Object` target **)** | +| void | :ref:`set_target` **(** :ref:`Object` target **)** | +-------+-------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +InterpolatedCamera is a :ref:`Camera` which smoothly moves to match a target node's position and rotation. + +If it is not :ref:`enabled` or does not have a valid target set, InterpolatedCamera acts like a normal Camera. + +Property Descriptions +--------------------- .. _class_InterpolatedCamera_enabled: @@ -36,22 +42,15 @@ Member Variables .. _class_InterpolatedCamera_target: -- :ref:`NodePath` **target** - The target's :ref:`NodePath`. +- :ref:`NodePath` **target** - The target's :ref:`NodePath`. -Description ------------ - -InterpolatedCamera is a :ref:`Camera` which smoothly moves to match a target node's position and rotation. - -If it is not :ref:`enabled` or does not have a valid target set, InterpolatedCamera acts like a normal Camera. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_InterpolatedCamera_set_target: -- void **set_target** **(** :ref:`Object` target **)** +- void **set_target** **(** :ref:`Object` target **)** Sets the node to move toward and orient with. diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 24c2d974f..1736a4216 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -7,10 +7,8 @@ IP == -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`IP_Unix` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`IP_Unix` **Category:** Core Brief Description @@ -18,33 +16,27 @@ Brief Description Internet protocol (IP) support functions like DNS resolution. -Member Functions ----------------- +Methods +------- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | +| void | :ref:`clear_cache` **(** :ref:`String` hostname="" **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_resolve_item` **(** :ref:`int` id **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | +| :ref:`Array` | :ref:`get_local_addresses` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_resolve_item_address` **(** :ref:`int` id **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | +| :ref:`ResolverStatus` | :ref:`get_resolve_item_status` **(** :ref:`int` id **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | +| :ref:`String` | :ref:`resolve_hostname` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | +| :ref:`int` | :ref:`resolve_hostname_queue_item` **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ - -- **RESOLVER_MAX_QUERIES** = **32** --- Maximum number of concurrent DNS resolver queries allowed, ``RESOLVER_INVALID_ID`` is returned if exceeded. -- **RESOLVER_INVALID_ID** = **-1** --- Invalid ID constant. Returned if ``RESOLVER_MAX_QUERIES`` is exceeded. - -Enums ------ +Enumerations +------------ .. _enum_IP_ResolverStatus: @@ -65,17 +57,23 @@ enum **Type** - **TYPE_ANY** = **3** --- Address type: Any. +Constants +--------- + +- **RESOLVER_MAX_QUERIES** = **32** --- Maximum number of concurrent DNS resolver queries allowed, ``RESOLVER_INVALID_ID`` is returned if exceeded. +- **RESOLVER_INVALID_ID** = **-1** --- Invalid ID constant. Returned if ``RESOLVER_MAX_QUERIES`` is exceeded. + Description ----------- -IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see :ref:`StreamPeerTCP` and :ref:`TCP_Server`). IP provides DNS hostname resolution support, both blocking and threaded. +IP contains support functions for the Internet Protocol (IP). TCP/IP support is in different classes (see :ref:`StreamPeerTCP` and :ref:`TCP_Server`). IP provides DNS hostname resolution support, both blocking and threaded. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_IP_clear_cache: -- void **clear_cache** **(** :ref:`String` hostname="" **)** +- void **clear_cache** **(** :ref:`String` hostname="" **)** Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. @@ -87,31 +85,31 @@ Removes a given item "id" from the queue. This should be used to free a queue af .. _class_IP_get_local_addresses: -- :ref:`Array` **get_local_addresses** **(** **)** const +- :ref:`Array` **get_local_addresses** **(** **)** const Returns all of the user's current IPv4 and IPv6 addresses as an array. .. _class_IP_get_resolve_item_address: -- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const Returns a queued hostname's IP address, given its queue "id". Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). .. _class_IP_get_resolve_item_status: -- :ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** const +- :ref:`ResolverStatus` **get_resolve_item_status** **(** :ref:`int` id **)** const Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id". .. _class_IP_resolve_hostname: -- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** +- :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "ip_type". .. _class_IP_resolve_hostname_queue_item: -- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** +- :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_ip_unix.rst b/classes/class_ip_unix.rst index fcc731f82..16c2b0e29 100644 --- a/classes/class_ip_unix.rst +++ b/classes/class_ip_unix.rst @@ -7,17 +7,16 @@ IP_Unix ======= -**Inherits:** :ref:`IP` **<** :ref:`Object` - +**Inherits:** :ref:`IP` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Unix IP support. See :ref:`IP`. +Unix IP support. See :ref:`IP`. Description ----------- -Unix-specific implementation of IP support functions. See :ref:`IP`. +Unix-specific implementation of IP support functions. See :ref:`IP`. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 6fa06091a..d4e3208d9 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -7,8 +7,7 @@ ItemList ======== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,41 +15,41 @@ Brief Description Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. -Member Functions ----------------- +Methods +------- +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | +| void | :ref:`add_icon_item` **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | +| void | :ref:`add_item` **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_current_is_visible` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_custom_bg_color` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_custom_fg_color` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | +| :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | +| :ref:`PoolIntArray` | :ref:`get_selected_items` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_anything_selected` **(** **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,25 +67,25 @@ Member Functions +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` idx, :ref:`bool` single=true **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | +| void | :ref:`set_item_custom_bg_color` **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | +| void | :ref:`set_item_custom_fg_color` **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | +| void | :ref:`set_item_icon_modulate` **(** :ref:`int` idx, :ref:`Color` modulate **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | +| void | :ref:`set_item_icon_region` **(** :ref:`int` idx, :ref:`Rect2` rect **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_selectable` **(** :ref:`int` idx, :ref:`bool` selectable **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_tooltip_enabled` **(** :ref:`int` idx, :ref:`bool` enable **)** | +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -108,7 +107,7 @@ Fired when specified list item is activated via double click or Enter. .. _class_ItemList_item_rmb_selected: -- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** +- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** Fired when specified list item has been selected via right mouse clicking. @@ -134,59 +133,11 @@ Fired when a multiple selection is altered on a list allowing multiple selection .. _class_ItemList_rmb_clicked: -- **rmb_clicked** **(** :ref:`Vector2` at_position **)** +- **rmb_clicked** **(** :ref:`Vector2` at_position **)** -Member Variables ----------------- - - .. _class_ItemList_allow_reselect: - -- :ref:`bool` **allow_reselect** - If ``true`` the currently selected item may be selected again. - - .. _class_ItemList_allow_rmb_select: - -- :ref:`bool` **allow_rmb_select** - If ``true`` a right mouse button click can select items. - - .. _class_ItemList_auto_height: - -- :ref:`bool` **auto_height** - - .. _class_ItemList_fixed_column_width: - -- :ref:`int` **fixed_column_width** - - .. _class_ItemList_fixed_icon_size: - -- :ref:`Vector2` **fixed_icon_size** - - .. _class_ItemList_icon_mode: - -- :ref:`IconMode` **icon_mode** - - .. _class_ItemList_icon_scale: - -- :ref:`float` **icon_scale** - - .. _class_ItemList_max_columns: - -- :ref:`int` **max_columns** - - .. _class_ItemList_max_text_lines: - -- :ref:`int` **max_text_lines** - - .. _class_ItemList_same_column_width: - -- :ref:`bool` **same_column_width** - - .. _class_ItemList_select_mode: - -- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. - - -Enums ------ +Enumerations +------------ .. _enum_ItemList_IconMode: @@ -210,18 +161,66 @@ This control provides a selectable list of items that may be in a single (or mul Selectable items in the list may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ItemList_allow_reselect: + +- :ref:`bool` **allow_reselect** - If ``true`` the currently selected item may be selected again. + + .. _class_ItemList_allow_rmb_select: + +- :ref:`bool` **allow_rmb_select** - If ``true`` a right mouse button click can select items. + + .. _class_ItemList_auto_height: + +- :ref:`bool` **auto_height** + + .. _class_ItemList_fixed_column_width: + +- :ref:`int` **fixed_column_width** + + .. _class_ItemList_fixed_icon_size: + +- :ref:`Vector2` **fixed_icon_size** + + .. _class_ItemList_icon_mode: + +- :ref:`IconMode` **icon_mode** + + .. _class_ItemList_icon_scale: + +- :ref:`float` **icon_scale** + + .. _class_ItemList_max_columns: + +- :ref:`int` **max_columns** + + .. _class_ItemList_max_text_lines: + +- :ref:`int` **max_text_lines** + + .. _class_ItemList_same_column_width: + +- :ref:`bool` **same_column_width** + + .. _class_ItemList_select_mode: + +- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. + + +Method Descriptions +------------------- .. _class_ItemList_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** +- void **add_icon_item** **(** :ref:`Texture` icon, :ref:`bool` selectable=true **)** Adds an item to the item list with no text, only an icon. .. _class_ItemList_add_item: -- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** +- void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. @@ -241,7 +240,7 @@ Ensure selection is visible, adjusting the scroll position as necessary. .. _class_ItemList_get_item_at_position: -- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const +- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const Given a position within the control return the item (if any) at that point. @@ -253,51 +252,51 @@ Return count of items currently in the item list. .. _class_ItemList_get_item_custom_bg_color: -- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_custom_fg_color: -- :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_icon_modulate: -- :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const -Returns a :ref:`Color` modulating item's icon at the specified index. +Returns a :ref:`Color` modulating item's icon at the specified index. .. _class_ItemList_get_item_icon_region: -- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const +- :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text for specified item index. .. _class_ItemList_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Return tooltip hint for specified item index. .. _class_ItemList_get_selected_items: -- :ref:`PoolIntArray` **get_selected_items** **(** **)** +- :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. .. _class_ItemList_get_v_scroll: -- :ref:`VScrollBar` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. @@ -353,11 +352,11 @@ Note: This method does not trigger the item selection signal. .. _class_ItemList_set_item_custom_bg_color: -- void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** +- void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** .. _class_ItemList_set_item_custom_fg_color: -- void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** +- void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** .. _class_ItemList_set_item_disabled: @@ -369,23 +368,23 @@ Disabled items are not be selectable and do not fire activation (Enter or double .. _class_ItemList_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** Set (or replace) icon of the item at the specified index. .. _class_ItemList_set_item_icon_modulate: -- void **set_item_icon_modulate** **(** :ref:`int` idx, :ref:`Color` modulate **)** +- void **set_item_icon_modulate** **(** :ref:`int` idx, :ref:`Color` modulate **)** -Sets a modulating :ref:`Color` for item's icon at the specified index. +Sets a modulating :ref:`Color` for item's icon at the specified index. .. _class_ItemList_set_item_icon_region: -- void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** +- void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** .. _class_ItemList_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets a value (of any type) to be stored with the item at the specified index. @@ -397,13 +396,13 @@ Allow or disallow selection of the item at the specified index. .. _class_ItemList_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Sets text of item at specified index. .. _class_ItemList_set_item_tooltip: -- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets tooltip hint for item at specified index. diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index a8e5e5297..e70d23076 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -7,8 +7,7 @@ JavaScript ========== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description Singleton that connects the engine with the browser's JavaScript context in HTML5 export. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | +| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -33,12 +32,12 @@ Tutorials - `#calling-javascript-from-script <../getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script>`_ in :doc:`../getting_started/workflow/export/exporting_for_web` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_JavaScript_eval: -- :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** +- :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** Execute the string ``code`` as JavaScript code within the browser window. This is a call to the actual global JavaScript function ``eval()``. diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 832123b84..96e9b0bcb 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -7,10 +7,8 @@ Joint ===== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`SliderJoint`, :ref:`HingeJoint`, :ref:`PinJoint` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`SliderJoint`, :ref:`HingeJoint`, :ref:`PinJoint` **Category:** Core Brief Description @@ -18,8 +16,13 @@ Brief Description Base class for all 3D joints -Member Variables ----------------- +Description +----------- + +All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other + +Property Descriptions +--------------------- .. _class_Joint_collision/exclude_nodes: @@ -27,19 +30,14 @@ Member Variables .. _class_Joint_nodes/node_a: -- :ref:`NodePath` **nodes/node_a** - The :ref:`Node`, the first side of the Joint attaches to. +- :ref:`NodePath` **nodes/node_a** - The :ref:`Node`, the first side of the Joint attaches to. .. _class_Joint_nodes/node_b: -- :ref:`NodePath` **nodes/node_b** - The :ref:`Node`, the second side of the Joint attaches to. +- :ref:`NodePath` **nodes/node_b** - The :ref:`Node`, the second side of the Joint attaches to. .. _class_Joint_solver/priority: - :ref:`int` **solver/priority** - The order in which the solver is executed compared to the other Joints, the lower, the earlier. -Description ------------ - -All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other - diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 10e15007c..7aa951dc4 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -7,10 +7,8 @@ Joint2D ======= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`PinJoint2D`, :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`PinJoint2D`, :ref:`DampedSpringJoint2D`, :ref:`GrooveJoint2D` **Category:** Core Brief Description @@ -18,8 +16,13 @@ Brief Description Base node for all joint constraints in 2D physics. -Member Variables ----------------- +Description +----------- + +Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. + +Property Descriptions +--------------------- .. _class_Joint2D_bias: @@ -31,15 +34,10 @@ Member Variables .. _class_Joint2D_node_a: -- :ref:`NodePath` **node_a** - The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +- :ref:`NodePath` **node_a** - The first body attached to the joint. Must derive from :ref:`PhysicsBody2D`. .. _class_Joint2D_node_b: -- :ref:`NodePath` **node_b** - The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. +- :ref:`NodePath` **node_b** - The second body attached to the joint. Must derive from :ref:`PhysicsBody2D`. -Description ------------ - -Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. - diff --git a/classes/class_json.rst b/classes/class_json.rst index bb99e777f..d32a157dd 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -7,8 +7,7 @@ JSON ==== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,32 +15,32 @@ Brief Description Helper class for parsing JSON data. -Member Functions ----------------- +Methods +------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | +| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`print` **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** | +| :ref:`String` | :ref:`print` **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Helper class for parsing JSON data. For usage example and other important hints, see :ref:`JSONParseResult`. +Helper class for parsing JSON data. For usage example and other important hints, see :ref:`JSONParseResult`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_JSON_parse: -- :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** +- :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** -Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. +Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. .. _class_JSON_print: -- :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** +- :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** Converts a Variant var to JSON text and returns the result. Useful for serializing data to store or send over the network. diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 9b7b40fda..ea6258903 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -7,8 +7,7 @@ JSONParseResult =============== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,17 @@ Brief Description Data class wrapper for decoded JSON. -Member Variables ----------------- +Description +----------- + +Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == OK``. + +Property Descriptions +--------------------- .. _class_JSONParseResult_error: -- :ref:`Error` **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +- :ref:`Error` **error** - The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. .. _class_JSONParseResult_error_line: @@ -29,11 +33,11 @@ Member Variables .. _class_JSONParseResult_error_string: -- :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. +- :ref:`String` **error_string** - The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. .. _class_JSONParseResult_result: -- :ref:`Variant` **result** - A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. +- :ref:`Variant` **result** - A :ref:`Variant` containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with curly braces (``{}``) a :ref:`Dictionary` will be returned, if JSON source starts with braces (``[]``) an :ref:`Array` will be returned. *Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types. @@ -48,8 +52,3 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y print("unexpected results") -Description ------------ - -Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains decoded JSON or error information if JSON source not successfully parsed. You can check if JSON source was successfully parsed with ``if json_result.error == OK``. - diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 9794a169e..d1c7e8d9b 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -7,8 +7,7 @@ KinematicBody ============= -**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Kinematic body 3D node. -Member Functions ----------------- +Methods +------- +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +| :ref:`KinematicCollision` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slide_count` **(** **)** const | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -32,17 +31,31 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_wall` **(** **)** const | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** | +| :ref:`KinematicCollision` | :ref:`move_and_collide` **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +| :ref:`Vector3` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** | +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + +Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + +Kinematic Characters: KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. + +Tutorials +--------- + +- :doc:`../tutorials/physics/kinematic_character_2d` + +Property Descriptions +--------------------- .. _class_KinematicBody_collision/safe_margin: @@ -61,34 +74,20 @@ Member Variables - :ref:`bool` **move_lock_z** -Description ------------ - -Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: - -Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). - -Kinematic Characters: KinematicBody also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. - -Tutorials ---------- - -- :doc:`../tutorials/physics/kinematic_character_2d` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_KinematicBody_get_floor_velocity: -- :ref:`Vector3` **get_floor_velocity** **(** **)** const +- :ref:`Vector3` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody_get_slide_collision: -- :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** +- :ref:`KinematicCollision` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). +Returns a :ref:`KinematicCollision`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). .. _class_KinematicBody_get_slide_count: @@ -116,17 +115,17 @@ Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_ .. _class_KinematicBody_move_and_collide: -- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** +- :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** -Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision`, which contains information about the collision. +Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision`, which contains information about the collision. If ``test_only`` is ``true[/true], the body does not move but the would-be collision information is given. .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` stop_on_slope=false, :ref:`int` max_slides=4, :ref:`float` floor_max_angle=0.785398, :ref:`bool` infinite_inertia=true **)** -Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. +Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. ``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it with ``delta`` — this is done by the method. @@ -142,12 +141,16 @@ Returns the movement that remained when the body stopped. To get more detailed i .. _class_KinematicBody_move_and_slide_with_snap: -- :ref:`Vector3` **move_and_slide_with_snap** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector3` **move_and_slide_with_snap** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` snap, :ref:`Vector3` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** + +Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. + +As long as the ``snap`` vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting``snap`` to``(0, 0, 0)`` or by using :ref:`move_and_slide` instead. .. _class_KinematicBody_test_move: -- :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** +- :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** -Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. +Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 8f79a9efb..3a9a1fe0c 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -7,8 +7,7 @@ KinematicBody2D =============== -**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Kinematic body 2D node. -Member Functions ----------------- +Methods +------- +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slide_count` **(** **)** const | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -32,27 +31,15 @@ Member Functions +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_wall` **(** **)** const | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** | +| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +| :ref:`Vector2` | :ref:`move_and_slide_with_snap` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** | +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_KinematicBody2D_collision/safe_margin: - -- :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. - - .. _class_KinematicBody2D_motion/sync_to_physics: - -- :ref:`bool` **motion/sync_to_physics** - If ``true`` the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. - - Description ----------- @@ -62,20 +49,32 @@ Simulated Motion: When these bodies are moved manually, either from code or from Kinematic Characters: KinematicBody2D also has an API for moving objects (the :ref:`move_and_collide` and :ref:`move_and_slide` methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_KinematicBody2D_collision/safe_margin: + +- :ref:`float` **collision/safe_margin** - If the body is at least this close to another body, this body will consider them to be colliding. + + .. _class_KinematicBody2D_motion/sync_to_physics: + +- :ref:`bool` **motion/sync_to_physics** - If ``true`` the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. + + +Method Descriptions +------------------- .. _class_KinematicBody2D_get_floor_velocity: -- :ref:`Vector2` **get_floor_velocity** **(** **)** const +- :ref:`Vector2` **get_floor_velocity** **(** **)** const Returns the velocity of the floor. Only updates when calling :ref:`move_and_slide`. .. _class_KinematicBody2D_get_slide_collision: -- :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** +- :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** -Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). +Returns a :ref:`KinematicCollision2D`, which contains information about a collision that occurred during the last :ref:`move_and_slide` call. Since the body can collide several times in a single call to :ref:`move_and_slide`, you must specify the index of the collision in the range 0 to (:ref:`get_slide_count` - 1). .. _class_KinematicBody2D_get_slide_count: @@ -103,15 +102,15 @@ Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_ .. _class_KinematicBody2D_move_and_collide: -- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** +- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` exclude_raycast_shapes=true, :ref:`bool` test_only=false **)** -Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. +Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the collision. .. _class_KinematicBody2D_move_and_slide: -- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** -Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. +Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. ``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it with ``delta`` — this is done by the method. @@ -127,7 +126,7 @@ Returns the movement that remained when the body stopped. To get more detailed i .. _class_KinematicBody2D_move_and_slide_with_snap: -- :ref:`Vector2` **move_and_slide_with_snap** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** +- :ref:`Vector2` **move_and_slide_with_snap** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` snap, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`bool` infinite_inertia=true, :ref:`bool` stop_on_slope=false, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_slide`. @@ -135,8 +134,8 @@ As long as the ``snap`` vector is in contact with the ground, the body will rema .. _class_KinematicBody2D_test_move: -- :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** +- :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** -Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. +Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given :ref:`Transform2D`, then tries to move the body along the vector ``rel_vec``. Returns ``true`` if a collision would occur. diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 4d32a0730..1f9e9ba15 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -7,8 +7,7 @@ KinematicCollision ================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,58 +15,58 @@ Brief Description Collision data for KinematicBody collisions. -Member Variables ----------------- - - .. _class_KinematicCollision_collider: - -- :ref:`Object` **collider** - The colliding body. - - .. _class_KinematicCollision_collider_id: - -- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. - - .. _class_KinematicCollision_collider_metadata: - -- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. - - .. _class_KinematicCollision_collider_shape: - -- :ref:`Object` **collider_shape** - The colliding body's shape. - - .. _class_KinematicCollision_collider_shape_index: - -- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject`. - - .. _class_KinematicCollision_collider_velocity: - -- :ref:`Vector3` **collider_velocity** - The colliding object's velocity. - - .. _class_KinematicCollision_local_shape: - -- :ref:`Object` **local_shape** - The moving object's colliding shape. - - .. _class_KinematicCollision_normal: - -- :ref:`Vector3` **normal** - The colliding body's shape's normal at the point of collision. - - .. _class_KinematicCollision_position: - -- :ref:`Vector3` **position** - The point of collision. - - .. _class_KinematicCollision_remainder: - -- :ref:`Vector3` **remainder** - The moving object's remaining movement vector. - - .. _class_KinematicCollision_travel: - -- :ref:`Vector3` **travel** - The distance the moving object traveled before collision. - - Description ----------- -Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody` is moved using :ref:`KinematicBody.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. +Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody` is moved using :ref:`KinematicBody.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. +Property Descriptions +--------------------- + + .. _class_KinematicCollision_collider: + +- :ref:`Object` **collider** - The colliding body. + + .. _class_KinematicCollision_collider_id: + +- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. + + .. _class_KinematicCollision_collider_metadata: + +- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. + + .. _class_KinematicCollision_collider_shape: + +- :ref:`Object` **collider_shape** - The colliding body's shape. + + .. _class_KinematicCollision_collider_shape_index: + +- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject`. + + .. _class_KinematicCollision_collider_velocity: + +- :ref:`Vector3` **collider_velocity** - The colliding object's velocity. + + .. _class_KinematicCollision_local_shape: + +- :ref:`Object` **local_shape** - The moving object's colliding shape. + + .. _class_KinematicCollision_normal: + +- :ref:`Vector3` **normal** - The colliding body's shape's normal at the point of collision. + + .. _class_KinematicCollision_position: + +- :ref:`Vector3` **position** - The point of collision. + + .. _class_KinematicCollision_remainder: + +- :ref:`Vector3` **remainder** - The moving object's remaining movement vector. + + .. _class_KinematicCollision_travel: + +- :ref:`Vector3` **travel** - The distance the moving object traveled before collision. + + diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 19131f7bc..1d22b80b1 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -7,8 +7,7 @@ KinematicCollision2D ==================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,58 +15,58 @@ Brief Description Collision data for KinematicBody2D collisions. -Member Variables ----------------- - - .. _class_KinematicCollision2D_collider: - -- :ref:`Object` **collider** - The colliding body. - - .. _class_KinematicCollision2D_collider_id: - -- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. - - .. _class_KinematicCollision2D_collider_metadata: - -- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. - - .. _class_KinematicCollision2D_collider_shape: - -- :ref:`Object` **collider_shape** - The colliding body's shape. - - .. _class_KinematicCollision2D_collider_shape_index: - -- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject2D`. - - .. _class_KinematicCollision2D_collider_velocity: - -- :ref:`Vector2` **collider_velocity** - The colliding object's velocity. - - .. _class_KinematicCollision2D_local_shape: - -- :ref:`Object` **local_shape** - The moving object's colliding shape. - - .. _class_KinematicCollision2D_normal: - -- :ref:`Vector2` **normal** - The colliding body's shape's normal at the point of collision. - - .. _class_KinematicCollision2D_position: - -- :ref:`Vector2` **position** - The point of collision. - - .. _class_KinematicCollision2D_remainder: - -- :ref:`Vector2` **remainder** - The moving object's remaining movement vector. - - .. _class_KinematicCollision2D_travel: - -- :ref:`Vector2` **travel** - The distance the moving object traveled before collision. - - Description ----------- -Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D` is moved using :ref:`KinematicBody2D.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. +Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D` is moved using :ref:`KinematicBody2D.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. +Property Descriptions +--------------------- + + .. _class_KinematicCollision2D_collider: + +- :ref:`Object` **collider** - The colliding body. + + .. _class_KinematicCollision2D_collider_id: + +- :ref:`int` **collider_id** - The colliding body's unique :ref:`RID`. + + .. _class_KinematicCollision2D_collider_metadata: + +- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See :ref:`Object`. + + .. _class_KinematicCollision2D_collider_shape: + +- :ref:`Object` **collider_shape** - The colliding body's shape. + + .. _class_KinematicCollision2D_collider_shape_index: + +- :ref:`int` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject2D`. + + .. _class_KinematicCollision2D_collider_velocity: + +- :ref:`Vector2` **collider_velocity** - The colliding object's velocity. + + .. _class_KinematicCollision2D_local_shape: + +- :ref:`Object` **local_shape** - The moving object's colliding shape. + + .. _class_KinematicCollision2D_normal: + +- :ref:`Vector2` **normal** - The colliding body's shape's normal at the point of collision. + + .. _class_KinematicCollision2D_position: + +- :ref:`Vector2` **position** - The point of collision. + + .. _class_KinematicCollision2D_remainder: + +- :ref:`Vector2` **remainder** - The moving object's remaining movement vector. + + .. _class_KinematicCollision2D_travel: + +- :ref:`Vector2` **travel** - The distance the moving object traveled before collision. + + diff --git a/classes/class_label.rst b/classes/class_label.rst index b1ec21bab..adac244ee 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -7,17 +7,16 @@ Label ===== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel`. +Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel`. -Member Functions ----------------- +Methods +------- +------------------------+-------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count` **(** **)** const | @@ -29,52 +28,8 @@ Member Functions | :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | +------------------------+-------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Label_align: - -- :ref:`Align` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. - - .. _class_Label_autowrap: - -- :ref:`bool` **autowrap** - If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. - - .. _class_Label_clip_text: - -- :ref:`bool` **clip_text** - If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. - - .. _class_Label_lines_skipped: - -- :ref:`int` **lines_skipped** - The node ignores the first ``lines_skipped`` lines before it starts to display text. - - .. _class_Label_max_lines_visible: - -- :ref:`int` **max_lines_visible** - Limits the lines of text the node shows on screen. - - .. _class_Label_percent_visible: - -- :ref:`float` **percent_visible** - Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. - - .. _class_Label_text: - -- :ref:`String` **text** - The text to display on screen. - - .. _class_Label_uppercase: - -- :ref:`bool` **uppercase** - If ``true``, all the text displays as UPPERCASE. - - .. _class_Label_valign: - -- :ref:`VAlign` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. - - .. _class_Label_visible_characters: - -- :ref:`int` **visible_characters** - Restricts the number of characters to display. Set to -1 to disable. - - -Enums ------ +Enumerations +------------ .. _enum_Label_Align: @@ -98,12 +53,56 @@ enum **VAlign** Description ----------- -Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use :ref:`RichTextLabel` instead. +Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use :ref:`RichTextLabel` instead. -Note that contrarily to most other :ref:`Control`\ s, Label's :ref:`Control.mouse_filter` defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). +Note that contrarily to most other :ref:`Control`\ s, Label's :ref:`Control.mouse_filter` defaults to MOUSE_FILTER_IGNORE (i.e. it doesn't react to mouse input events). -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Label_align: + +- :ref:`Align` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants. + + .. _class_Label_autowrap: + +- :ref:`bool` **autowrap** - If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. + + .. _class_Label_clip_text: + +- :ref:`bool` **clip_text** - If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. + + .. _class_Label_lines_skipped: + +- :ref:`int` **lines_skipped** - The node ignores the first ``lines_skipped`` lines before it starts to display text. + + .. _class_Label_max_lines_visible: + +- :ref:`int` **max_lines_visible** - Limits the lines of text the node shows on screen. + + .. _class_Label_percent_visible: + +- :ref:`float` **percent_visible** - Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. + + .. _class_Label_text: + +- :ref:`String` **text** - The text to display on screen. + + .. _class_Label_uppercase: + +- :ref:`bool` **uppercase** - If ``true``, all the text displays as UPPERCASE. + + .. _class_Label_valign: + +- :ref:`VAlign` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. + + .. _class_Label_visible_characters: + +- :ref:`int` **visible_characters** - Restricts the number of characters to display. Set to -1 to disable. + + +Method Descriptions +------------------- .. _class_Label_get_line_count: diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index eab4bf9a4..a50dcb673 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -7,8 +7,7 @@ LargeTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,25 +15,25 @@ Brief Description A Texture capable of storing many smaller Textures with offsets. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | +| :ref:`int` | :ref:`add_piece` **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_piece_count` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_piece_offset` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_piece_texture` **(** :ref:`int` idx **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | +| void | :ref:`set_piece_offset` **(** :ref:`int` idx, :ref:`Vector2` ofs **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +| void | :ref:`set_piece_texture` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -42,16 +41,16 @@ Description A Texture capable of storing many smaller Textures with offsets. -You can dynamically add pieces(:ref:`Texture`) to this ``LargeTexture`` using different offsets. +You can dynamically add pieces(:ref:`Texture`) to this ``LargeTexture`` using different offsets. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_LargeTexture_add_piece: -- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** +- :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** -Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". +Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". .. _class_LargeTexture_clear: @@ -67,31 +66,31 @@ Returns the number of pieces currently in this ``LargeTexture``. .. _class_LargeTexture_get_piece_offset: -- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const Returns the offset of the piece with index "idx". .. _class_LargeTexture_get_piece_texture: -- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const -Returns the :ref:`Texture` of the piece with index "idx". +Returns the :ref:`Texture` of the piece with index "idx". .. _class_LargeTexture_set_piece_offset: -- void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** +- void **set_piece_offset** **(** :ref:`int` idx, :ref:`Vector2` ofs **)** Sets the offset of the piece with index "idx" to "ofs". .. _class_LargeTexture_set_piece_texture: -- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** -Sets the :ref:`Texture` of the piece with index "idx" to "ofs". +Sets the :ref:`Texture` of the piece with index "idx" to "ofs". .. _class_LargeTexture_set_size: -- void **set_size** **(** :ref:`Vector2` size **)** +- void **set_size** **(** :ref:`Vector2` size **)** Sets the size of this ``LargeTexture``. diff --git a/classes/class_light.rst b/classes/class_light.rst index 8b92fa569..d21bb929a 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -7,10 +7,8 @@ Light ===== -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`SpotLight`, :ref:`OmniLight`, :ref:`DirectionalLight` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`SpotLight`, :ref:`OmniLight`, :ref:`DirectionalLight` **Category:** Core Brief Description @@ -18,64 +16,8 @@ Brief Description Provides a base class for different kinds of light nodes. -Member Variables ----------------- - - .. _class_Light_editor_only: - -- :ref:`bool` **editor_only** - If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. - - .. _class_Light_light_bake_mode: - -- :ref:`BakeMode` **light_bake_mode** - The light's bake mode. See :ref:`BakeMode`. - - .. _class_Light_light_color: - -- :ref:`Color` **light_color** - The light's color. - - .. _class_Light_light_cull_mask: - -- :ref:`int` **light_cull_mask** - The light will affect objects in the selected layers. - - .. _class_Light_light_energy: - -- :ref:`float` **light_energy** - The light's strength multiplier. - - .. _class_Light_light_indirect_energy: - -- :ref:`float` **light_indirect_energy** - Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. - - .. _class_Light_light_negative: - -- :ref:`bool` **light_negative** - If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. - - .. _class_Light_light_specular: - -- :ref:`float` **light_specular** - The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. - - .. _class_Light_shadow_bias: - -- :ref:`float` **shadow_bias** - Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. - - .. _class_Light_shadow_color: - -- :ref:`Color` **shadow_color** - The color of shadows cast by this light. - - .. _class_Light_shadow_contact: - -- :ref:`float` **shadow_contact** - Attempts to reduce :ref:`shadow_bias` gap. - - .. _class_Light_shadow_enabled: - -- :ref:`bool` **shadow_enabled** - If ``true`` the light will cast shadows. Default value: ``false``. - - .. _class_Light_shadow_reverse_cull_face: - -- :ref:`bool` **shadow_reverse_cull_face** - - -Enums ------ +Enumerations +------------ .. _enum_Light_BakeMode: @@ -117,3 +59,59 @@ Tutorials - :doc:`../tutorials/3d/lights_and_shadows` +Property Descriptions +--------------------- + + .. _class_Light_editor_only: + +- :ref:`bool` **editor_only** - If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. + + .. _class_Light_light_bake_mode: + +- :ref:`BakeMode` **light_bake_mode** - The light's bake mode. See :ref:`BakeMode`. + + .. _class_Light_light_color: + +- :ref:`Color` **light_color** - The light's color. + + .. _class_Light_light_cull_mask: + +- :ref:`int` **light_cull_mask** - The light will affect objects in the selected layers. + + .. _class_Light_light_energy: + +- :ref:`float` **light_energy** - The light's strength multiplier. + + .. _class_Light_light_indirect_energy: + +- :ref:`float` **light_indirect_energy** - Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. + + .. _class_Light_light_negative: + +- :ref:`bool` **light_negative** - If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. + + .. _class_Light_light_specular: + +- :ref:`float` **light_specular** - The intensity of the specular blob in objects affected by the light. At ``0`` the light becomes a pure diffuse light. + + .. _class_Light_shadow_bias: + +- :ref:`float` **shadow_bias** - Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. + + .. _class_Light_shadow_color: + +- :ref:`Color` **shadow_color** - The color of shadows cast by this light. + + .. _class_Light_shadow_contact: + +- :ref:`float` **shadow_contact** - Attempts to reduce :ref:`shadow_bias` gap. + + .. _class_Light_shadow_enabled: + +- :ref:`bool` **shadow_enabled** - If ``true`` the light will cast shadows. Default value: ``false``. + + .. _class_Light_shadow_reverse_cull_face: + +- :ref:`bool` **shadow_reverse_cull_face** + + diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index aefc4caae..256fb57c4 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -7,8 +7,7 @@ Light2D ======= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,41 @@ Brief Description Casts light in a 2D environment. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Light2D_Mode: + +enum **Mode** + +- **MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. +- **MODE_SUB** = **1** --- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. +- **MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. +- **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. + + .. _enum_Light2D_ShadowFilter: + +enum **ShadowFilter** + +- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. +- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. + + +Description +----------- + +Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + +Property Descriptions +--------------------- .. _class_Light2D_color: -- :ref:`Color` **color** - The Light2D's :ref:`Color`. +- :ref:`Color` **color** - The Light2D's :ref:`Color`. .. _class_Light2D_editor_only: @@ -37,11 +65,11 @@ Member Variables .. _class_Light2D_mode: -- :ref:`Mode` **mode** - The Light2D's mode. See MODE\_\* constants for values. +- :ref:`Mode` **mode** - The Light2D's mode. See MODE\_\* constants for values. .. _class_Light2D_offset: -- :ref:`Vector2` **offset** - The offset of the Light2D's ``texture``. +- :ref:`Vector2` **offset** - The offset of the Light2D's ``texture``. .. _class_Light2D_range_height: @@ -73,7 +101,7 @@ Member Variables .. _class_Light2D_shadow_color: -- :ref:`Color` **shadow_color** - :ref:`Color` of shadows cast by the Light2D. +- :ref:`Color` **shadow_color** - :ref:`Color` of shadows cast by the Light2D. .. _class_Light2D_shadow_enabled: @@ -81,7 +109,7 @@ Member Variables .. _class_Light2D_shadow_filter: -- :ref:`ShadowFilter` **shadow_filter** - Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. +- :ref:`ShadowFilter` **shadow_filter** - Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. .. _class_Light2D_shadow_filter_smooth: @@ -93,43 +121,14 @@ Member Variables .. _class_Light2D_shadow_item_cull_mask: -- :ref:`int` **shadow_item_cull_mask** - The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. +- :ref:`int` **shadow_item_cull_mask** - The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. .. _class_Light2D_texture: -- :ref:`Texture` **texture** - :ref:`Texture` used for the Light2D's appearance. +- :ref:`Texture` **texture** - :ref:`Texture` used for the Light2D's appearance. .. _class_Light2D_texture_scale: - :ref:`float` **texture_scale** - The ``texture``'s scale factor. -Enums ------ - - .. _enum_Light2D_Mode: - -enum **Mode** - -- **MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. -- **MODE_SUB** = **1** --- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. -- **MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. -- **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. - - .. _enum_Light2D_ShadowFilter: - -enum **ShadowFilter** - -- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF3** = **1** --- Percentage closer filtering (3 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF5** = **2** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF7** = **3** --- Percentage closer filtering (7 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF9** = **4** --- Percentage closer filtering (9 samples) applies to the shadow map. See :ref:`shadow_filter`. -- **SHADOW_FILTER_PCF13** = **5** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter`. - - -Description ------------ - -Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. - diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index ffb2b7e3f..95b03da1f 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -7,8 +7,7 @@ LightOccluder2D =============== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Occludes light cast by a Light2D, casting shadows. -Member Variables ----------------- +Description +----------- + +Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an :ref:`OccluderPolygon2D` in order for the shadow to be computed. + +Property Descriptions +--------------------- .. _class_LightOccluder2D_light_mask: @@ -25,11 +29,6 @@ Member Variables .. _class_LightOccluder2D_occluder: -- :ref:`OccluderPolygon2D` **occluder** - The :ref:`OccluderPolygon2D` used to compute the shadow. +- :ref:`OccluderPolygon2D` **occluder** - The :ref:`OccluderPolygon2D` used to compute the shadow. -Description ------------ - -Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an :ref:`OccluderPolygon2D` in order for the shadow to be computed. - diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 02e06bb13..719ab8883 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -7,8 +7,7 @@ Line2D ====== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,71 +15,23 @@ Brief Description A 2D line. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | +| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` i **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | +| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Line2D_begin_cap_mode: - -- :ref:`LineCapMode` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. - - .. _class_Line2D_default_color: - -- :ref:`Color` **default_color** - The line's color. Will not be used if a gradient is set. - - .. _class_Line2D_end_cap_mode: - -- :ref:`LineCapMode` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. - - .. _class_Line2D_gradient: - -- :ref:`Gradient` **gradient** - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. - - .. _class_Line2D_joint_mode: - -- :ref:`LineJointMode` **joint_mode** - The style for the points between the start and the end. - - .. _class_Line2D_points: - -- :ref:`PoolVector2Array` **points** - The points that form the lines. The line is drawn between every point set in this array. - - .. _class_Line2D_round_precision: - -- :ref:`int` **round_precision** - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. - - .. _class_Line2D_sharp_limit: - -- :ref:`float` **sharp_limit** - The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``. - - .. _class_Line2D_texture: - -- :ref:`Texture` **texture** - The texture used for the line's texture. Uses ``texture_mode`` for drawing style. - - .. _class_Line2D_texture_mode: - -- :ref:`LineTextureMode` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. - - .. _class_Line2D_width: - -- :ref:`float` **width** - The line's width. - - -Enums ------ +Enumerations +------------ .. _enum_Line2D_LineCapMode: @@ -112,12 +63,60 @@ Description A line through several points in 2D space. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Line2D_begin_cap_mode: + +- :ref:`LineCapMode` **begin_cap_mode** - Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. + + .. _class_Line2D_default_color: + +- :ref:`Color` **default_color** - The line's color. Will not be used if a gradient is set. + + .. _class_Line2D_end_cap_mode: + +- :ref:`LineCapMode` **end_cap_mode** - Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. + + .. _class_Line2D_gradient: + +- :ref:`Gradient` **gradient** - The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. + + .. _class_Line2D_joint_mode: + +- :ref:`LineJointMode` **joint_mode** - The style for the points between the start and the end. + + .. _class_Line2D_points: + +- :ref:`PoolVector2Array` **points** - The points that form the lines. The line is drawn between every point set in this array. + + .. _class_Line2D_round_precision: + +- :ref:`int` **round_precision** - The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. + + .. _class_Line2D_sharp_limit: + +- :ref:`float` **sharp_limit** - The direction difference in radians between vector points. This value is only used if ``joint mode`` is set to ``LINE_JOINT_SHARP``. + + .. _class_Line2D_texture: + +- :ref:`Texture` **texture** - The texture used for the line's texture. Uses ``texture_mode`` for drawing style. + + .. _class_Line2D_texture_mode: + +- :ref:`LineTextureMode` **texture_mode** - The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. + + .. _class_Line2D_width: + +- :ref:`float` **width** - The line's width. + + +Method Descriptions +------------------- .. _class_Line2D_add_point: -- void **add_point** **(** :ref:`Vector2` position **)** +- void **add_point** **(** :ref:`Vector2` position **)** Add a point at the ``position``. Appends the point at the end of the line. @@ -129,7 +128,7 @@ Returns the Line2D's amount of points. .. _class_Line2D_get_point_position: -- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i``'s position. @@ -141,7 +140,7 @@ Remove the point at index ``i`` from the line. .. _class_Line2D_set_point_position: -- void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** +- void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** Overwrites the position in point ``i`` with the supplied ``position``. diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 2d9f5b438..af6138039 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -7,8 +7,7 @@ LineEdit ======== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,17 @@ Brief Description Control that provides single line string editing. -Member Functions ----------------- +Methods +------- +------------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | +| void | :ref:`append_at_cursor` **(** :ref:`String` text **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`deselect` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------+ | void | :ref:`menu_option` **(** :ref:`int` option **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------+ @@ -40,23 +39,54 @@ Signals .. _class_LineEdit_text_changed: -- **text_changed** **(** :ref:`String` new_text **)** +- **text_changed** **(** :ref:`String` new_text **)** Emitted when the text changes. .. _class_LineEdit_text_entered: -- **text_entered** **(** :ref:`String` new_text **)** +- **text_entered** **(** :ref:`String` new_text **)** Emitted when the user presses KEY_ENTER on the ``LineEdit``. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_LineEdit_Align: + +enum **Align** + +- **ALIGN_LEFT** = **0** --- Aligns the text on the left hand side of the :ref:`LineEdit`. +- **ALIGN_CENTER** = **1** --- Centers the text in the middle of the :ref:`LineEdit`. +- **ALIGN_RIGHT** = **2** --- Aligns the text on the right hand side of the :ref:`LineEdit`. +- **ALIGN_FILL** = **3** --- Stretches whitespaces to fit the :ref:`LineEdit`'s width. + + .. _enum_LineEdit_MenuItems: + +enum **MenuItems** + +- **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. +- **MENU_COPY** = **1** --- Copies the selected text. +- **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position). +- **MENU_CLEAR** = **3** --- Erases the whole Linedit text. +- **MENU_SELECT_ALL** = **4** --- Selects the whole Linedit text. +- **MENU_UNDO** = **5** --- Undoes the previous action. +- **MENU_REDO** = **6** +- **MENU_MAX** = **7** + + +Description +----------- + +LineEdit provides a single line string editor, used for text fields. + +Property Descriptions +--------------------- .. _class_LineEdit_align: -- :ref:`Align` **align** - Text alignment as defined in the ALIGN\_\* enum. +- :ref:`Align` **align** - Text alignment as defined in the ALIGN\_\* enum. .. _class_LineEdit_caret_blink: @@ -84,15 +114,15 @@ Member Variables .. _class_LineEdit_expand_to_text_length: -- :ref:`bool` **expand_to_text_length** - If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +- :ref:`bool` **expand_to_text_length** - If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. .. _class_LineEdit_focus_mode: -- :ref:`FocusMode` **focus_mode** - Defines how the :ref:`LineEdit` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. +- :ref:`FocusMode` **focus_mode** - Defines how the :ref:`LineEdit` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. .. _class_LineEdit_max_length: -- :ref:`int` **max_length** - Maximum amount of characters that can be entered inside the :ref:`LineEdit`. If ``0``, there is no limit. +- :ref:`int` **max_length** - Maximum amount of characters that can be entered inside the :ref:`LineEdit`. If ``0``, there is no limit. .. _class_LineEdit_placeholder_alpha: @@ -100,7 +130,7 @@ Member Variables .. _class_LineEdit_placeholder_text: -- :ref:`String` **placeholder_text** - Text shown when the :ref:`LineEdit` is empty. It is **not** the :ref:`LineEdit`'s default value (see :ref:`text`). +- :ref:`String` **placeholder_text** - Text shown when the :ref:`LineEdit` is empty. It is **not** the :ref:`LineEdit`'s default value (see :ref:`text`). .. _class_LineEdit_secret: @@ -108,50 +138,19 @@ Member Variables .. _class_LineEdit_secret_character: -- :ref:`String` **secret_character** - The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. +- :ref:`String` **secret_character** - The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. .. _class_LineEdit_text: -- :ref:`String` **text** - String value of the :ref:`LineEdit`. +- :ref:`String` **text** - String value of the :ref:`LineEdit`. -Enums ------ - - .. _enum_LineEdit_Align: - -enum **Align** - -- **ALIGN_LEFT** = **0** --- Aligns the text on the left hand side of the :ref:`LineEdit`. -- **ALIGN_CENTER** = **1** --- Centers the text in the middle of the :ref:`LineEdit`. -- **ALIGN_RIGHT** = **2** --- Aligns the text on the right hand side of the :ref:`LineEdit`. -- **ALIGN_FILL** = **3** --- Stretches whitespaces to fit the :ref:`LineEdit`'s width. - - .. _enum_LineEdit_MenuItems: - -enum **MenuItems** - -- **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. -- **MENU_COPY** = **1** --- Copies the selected text. -- **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position). -- **MENU_CLEAR** = **3** --- Erases the whole Linedit text. -- **MENU_SELECT_ALL** = **4** --- Selects the whole Linedit text. -- **MENU_UNDO** = **5** --- Undoes the previous action. -- **MENU_REDO** = **6** -- **MENU_MAX** = **7** - - -Description ------------ - -LineEdit provides a single line string editor, used for text fields. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_LineEdit_append_at_cursor: -- void **append_at_cursor** **(** :ref:`String` text **)** +- void **append_at_cursor** **(** :ref:`String` text **)** Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length`, nothing happens. @@ -159,7 +158,7 @@ Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_ - void **clear** **(** **)** -Erases the :ref:`LineEdit` text. +Erases the :ref:`LineEdit` text. .. _class_LineEdit_deselect: @@ -169,9 +168,9 @@ Clears the current selection. .. _class_LineEdit_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** const -Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the :ref:`LineEdit`. +Returns the :ref:`PopupMenu` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the :ref:`LineEdit`. .. _class_LineEdit_menu_option: @@ -183,7 +182,7 @@ Executes a given action as defined in the MENU\_\* enum. - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** -Selects characters inside :ref:`LineEdit` between ``from`` and ``to``. By default ``from`` is at the beginning and ``to`` at the end. +Selects characters inside :ref:`LineEdit` between ``from`` and ``to``. By default ``from`` is at the beginning and ``to`` at the end. :: @@ -196,6 +195,6 @@ Selects characters inside :ref:`LineEdit` between ``from`` and ` - void **select_all** **(** **)** -Selects the whole :ref:`String`. +Selects the whole :ref:`String`. diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 4a4f54d44..c4b892721 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -7,8 +7,7 @@ LineShape2D =========== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Line shape for 2D collisions. -Member Variables ----------------- +Description +----------- + +Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + +Property Descriptions +--------------------- .. _class_LineShape2D_d: @@ -25,11 +29,6 @@ Member Variables .. _class_LineShape2D_normal: -- :ref:`Vector2` **normal** - The line's normal. +- :ref:`Vector2` **normal** - The line's normal. -Description ------------ - -Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. - diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index f99781662..100aa5d06 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -7,8 +7,7 @@ LinkButton ========== -**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description Simple button used to represent a link to some resource. -Member Variables ----------------- - - .. _class_LinkButton_text: - -- :ref:`String` **text** - - .. _class_LinkButton_underline: - -- :ref:`UnderlineMode` **underline** - - -Enums ------ +Enumerations +------------ .. _enum_LinkButton_UnderlineMode: @@ -45,3 +32,15 @@ Description This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). +Property Descriptions +--------------------- + + .. _class_LinkButton_text: + +- :ref:`String` **text** + + .. _class_LinkButton_underline: + +- :ref:`UnderlineMode` **underline** + + diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 3a348f07c..190caa12f 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -7,8 +7,7 @@ Listener ======== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------------+----------------------------------------------------------------------------------------+ | void | :ref:`clear_current` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** const | +| :ref:`Transform` | :ref:`get_listener_transform` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_current` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Listener_clear_current: @@ -38,7 +37,7 @@ Member Function Description .. _class_Listener_get_listener_transform: -- :ref:`Transform` **get_listener_transform** **(** **)** const +- :ref:`Transform` **get_listener_transform** **(** **)** const .. _class_Listener_is_current: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 277b4f63c..571e2ddb9 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -7,10 +7,8 @@ MainLoop ======== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`SceneTree` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`SceneTree` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description Main loop is the abstract main loop base class. -Member Functions ----------------- +Methods +------- +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | +| void | :ref:`_drop_files` **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_finalize` **(** **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,9 +28,9 @@ Member Functions +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_initialize` **(** **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`InputEvent` ev **)** virtual | +| void | :ref:`_input_event` **(** :ref:`InputEvent` event **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | +| void | :ref:`_input_text` **(** :ref:`String` text **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_iteration` **(** :ref:`float` delta **)** virtual | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,15 +40,15 @@ Member Functions +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`init` **(** **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | +| void | :ref:`input_event` **(** :ref:`InputEvent` event **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_text` **(** :ref:`String` text **)** | +| void | :ref:`input_text` **(** :ref:`String` text **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`iteration` **(** :ref:`float` delta **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ +Constants +--------- - **NOTIFICATION_WM_MOUSE_ENTER** = **2** - **NOTIFICATION_WM_MOUSE_EXIT** = **3** @@ -67,14 +65,14 @@ Numeric Constants Description ----------- -Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a ``MainLoop`` has to be provided to OS, else the application will exit. This happens automatically (and a :ref:`SceneTree` is created), unless a main :ref:`Script` is supplied, which may or not create and return a ``MainLoop``. +Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a ``MainLoop`` has to be provided to OS, else the application will exit. This happens automatically (and a :ref:`SceneTree` is created), unless a main :ref:`Script` is supplied, which may or not create and return a ``MainLoop``. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_MainLoop__drop_files: -- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual +- void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual .. _class_MainLoop__finalize: @@ -96,11 +94,11 @@ Called once during initialization. .. _class_MainLoop__input_event: -- void **_input_event** **(** :ref:`InputEvent` ev **)** virtual +- void **_input_event** **(** :ref:`InputEvent` event **)** virtual .. _class_MainLoop__input_text: -- void **_input_text** **(** :ref:`String` text **)** virtual +- void **_input_text** **(** :ref:`String` text **)** virtual .. _class_MainLoop__iteration: @@ -120,11 +118,11 @@ Called once during initialization. .. _class_MainLoop_input_event: -- void **input_event** **(** :ref:`InputEvent` ev **)** +- void **input_event** **(** :ref:`InputEvent` event **)** .. _class_MainLoop_input_text: -- void **input_text** **(** :ref:`String` text **)** +- void **input_text** **(** :ref:`String` text **)** .. _class_MainLoop_iteration: diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 64a9bd136..69038d110 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -7,8 +7,7 @@ MarginContainer =============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index be2090aad..aa12f97d1 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -7,8 +7,7 @@ Marshalls ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description Data transformation (marshalling) and encoding helpers. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | +| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ Description @@ -38,43 +37,43 @@ Description Provides data transformation and encoding utility functions. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Marshalls_base64_to_raw: -- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +- :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** -Return :ref:`PoolByteArray` of a given base64 encoded String. +Return :ref:`PoolByteArray` of a given base64 encoded String. .. _class_Marshalls_base64_to_utf8: -- :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** +- :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** Return utf8 String of a given base64 encoded String. .. _class_Marshalls_base64_to_variant: -- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** +- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** -Return :ref:`Variant` of a given base64 encoded String. +Return :ref:`Variant` of a given base64 encoded String. .. _class_Marshalls_raw_to_base64: -- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** +- :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** -Return base64 encoded String of a given :ref:`PoolByteArray`. +Return base64 encoded String of a given :ref:`PoolByteArray`. .. _class_Marshalls_utf8_to_base64: -- :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** +- :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** Return base64 encoded String of a given utf8 String. .. _class_Marshalls_variant_to_base64: -- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** +- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** -Return base64 encoded String of a given :ref:`Variant`. +Return base64 encoded String of a given :ref:`Variant`. diff --git a/classes/class_material.rst b/classes/class_material.rst index 350fb495f..1c8722514 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -7,31 +7,17 @@ Material ======== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial`, :ref:`CanvasItemMaterial` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial`, :ref:`CanvasItemMaterial` **Category:** Core Brief Description ----------------- -Abstract base :ref:`Resource` for coloring and shading geometry. +Abstract base :ref:`Resource` for coloring and shading geometry. -Member Variables ----------------- - - .. _class_Material_next_pass: - -- :ref:`Material` **next_pass** - - .. _class_Material_render_priority: - -- :ref:`int` **render_priority** - - -Numeric Constants ------------------ +Constants +--------- - **RENDER_PRIORITY_MAX** = **127** - **RENDER_PRIORITY_MIN** = **-128** @@ -39,5 +25,17 @@ Numeric Constants Description ----------- -Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. +Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. + +Property Descriptions +--------------------- + + .. _class_Material_next_pass: + +- :ref:`Material` **next_pass** + + .. _class_Material_render_priority: + +- :ref:`int` **render_priority** + diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 602ea7341..ae4149744 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -7,20 +7,19 @@ MenuButton ========== -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Special button that brings up a :ref:`PopupMenu` when clicked. +Special button that brings up a :ref:`PopupMenu` when clicked. -Member Functions ----------------- +Methods +------- +------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------+ @@ -32,22 +31,22 @@ Signals - **about_to_show** **(** **)** -Emitted when :ref:`PopupMenu` of this MenuButton is about to show. +Emitted when :ref:`PopupMenu` of this MenuButton is about to show. Description ----------- -Special button that brings up a :ref:`PopupMenu` when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. +Special button that brings up a :ref:`PopupMenu` when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_MenuButton_get_popup: -- :ref:`PopupMenu` **get_popup** **(** **)** const +- :ref:`PopupMenu` **get_popup** **(** **)** const -Return the :ref:`PopupMenu` contained in this button. +Return the :ref:`PopupMenu` contained in this button. .. _class_MenuButton_set_disable_shortcuts: diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index db4467d74..fdc28ea7e 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -7,42 +7,40 @@ Mesh ==== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`ArrayMesh`, :ref:`PrimitiveMesh` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`ArrayMesh`, :ref:`PrimitiveMesh` **Category:** Core Brief Description ----------------- -A :ref:`Resource` that contains vertex-array based geometry. +A :ref:`Resource` that contains vertex-array based geometry. -Member Functions ----------------- +Methods +------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_convex_shape` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Mesh_lightmap_size_hint: - -- :ref:`Vector2` **lightmap_size_hint** - - -Enums ------ +Enumerations +------------ .. _enum_Mesh_BlendShapeMode: @@ -55,15 +53,15 @@ enum **BlendShapeMode** enum **ArrayType** -- **ARRAY_VERTEX** = **0** -- **ARRAY_NORMAL** = **1** -- **ARRAY_TANGENT** = **2** -- **ARRAY_COLOR** = **3** -- **ARRAY_TEX_UV** = **4** -- **ARRAY_TEX_UV2** = **5** -- **ARRAY_BONES** = **6** -- **ARRAY_WEIGHTS** = **7** -- **ARRAY_INDEX** = **8** +- **ARRAY_VERTEX** = **0** --- Array of vertices. +- **ARRAY_NORMAL** = **1** --- Array of normals. +- **ARRAY_TANGENT** = **2** --- Array of tangents as an array of floats, 4 floats per tangent. +- **ARRAY_COLOR** = **3** --- Array of colors. +- **ARRAY_TEX_UV** = **4** --- Array of UV coordinates. +- **ARRAY_TEX_UV2** = **5** --- Array of second set of UV coordinates. +- **ARRAY_BONES** = **6** --- Array of bone data. +- **ARRAY_WEIGHTS** = **7** --- Array of weights. +- **ARRAY_INDEX** = **8** --- Array of indices. - **ARRAY_MAX** = **9** .. _enum_Mesh_ArrayFormat: @@ -109,39 +107,71 @@ enum **PrimitiveType** Description ----------- -Mesh is a type of :ref:`Resource` that contains vertex-array based geometry, divided in *surfaces*. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. +Mesh is a type of :ref:`Resource` that contains vertex-array based geometry, divided in *surfaces*. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Mesh_lightmap_size_hint: + +- :ref:`Vector2` **lightmap_size_hint** + + +Method Descriptions +------------------- .. _class_Mesh_create_convex_shape: -- :ref:`Shape` **create_convex_shape** **(** **)** const +- :ref:`Shape` **create_convex_shape** **(** **)** const -Calculate a :ref:`ConvexPolygonShape` from the mesh. +Calculate a :ref:`ConvexPolygonShape` from the mesh. .. _class_Mesh_create_outline: -- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const +- :ref:`Mesh` **create_outline** **(** :ref:`float` margin **)** const Calculate an outline mesh at a defined offset (margin) from the original mesh. Note: Typically returns the vertices in reverse order (e.g. clockwise to anti-clockwise). .. _class_Mesh_create_trimesh_shape: -- :ref:`Shape` **create_trimesh_shape** **(** **)** const +- :ref:`Shape` **create_trimesh_shape** **(** **)** const -Calculate a :ref:`ConcavePolygonShape` from the mesh. +Calculate a :ref:`ConcavePolygonShape` from the mesh. .. _class_Mesh_generate_triangle_mesh: -- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const -Generate a :ref:`TriangleMesh` from the mesh. +Generate a :ref:`TriangleMesh` from the mesh. .. _class_Mesh_get_faces: -- :ref:`PoolVector3Array` **get_faces** **(** **)** const +- :ref:`PoolVector3Array` **get_faces** **(** **)** const Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. +.. _class_Mesh_get_surface_count: + +- :ref:`int` **get_surface_count** **(** **)** const + +Return the amount of surfaces that the ``Mesh`` holds. + +.. _class_Mesh_surface_get_arrays: + +- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const + +Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see :ref:`ArrayMesh.add_surface_from_arrays`). + +.. _class_Mesh_surface_get_blend_shape_arrays: + +- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const + +Returns the blend shape arrays for the requested surface. + +.. _class_Mesh_surface_get_material: + +- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const + +Return a :ref:`Material` in a given surface. Surface is rendered using this material. + diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index bcc22221b..781e234c5 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -7,8 +7,7 @@ MeshDataTool ============ -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | +| :ref:`Error` | :ref:`commit_to_surface` **(** :ref:`ArrayMesh` mesh **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | +| :ref:`Error` | :ref:`create_from_surface` **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edge_count` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,67 +37,67 @@ Member Functions +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_face_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_format` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | +| :ref:`Material` | :ref:`get_material` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_vertex` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_bones` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | +| :ref:`Color` | :ref:`get_vertex_color` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_vertex_count` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_edges` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | +| :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | +| :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | +| :ref:`Plane` | :ref:`get_vertex_tangent` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_vertex_uv` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | +| :ref:`Vector2` | :ref:`get_vertex_uv2` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | +| :ref:`PoolRealArray` | :ref:`get_vertex_weights` **(** :ref:`int` idx **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +| void | :ref:`set_edge_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +| void | :ref:`set_face_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | +| void | :ref:`set_material` **(** :ref:`Material` material **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | +| void | :ref:`set_vertex` **(** :ref:`int` idx, :ref:`Vector3` vertex **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | +| void | :ref:`set_vertex_bones` **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | +| void | :ref:`set_vertex_color` **(** :ref:`int` idx, :ref:`Color` color **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +| void | :ref:`set_vertex_meta` **(** :ref:`int` idx, :ref:`Variant` meta **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | +| void | :ref:`set_vertex_normal` **(** :ref:`int` idx, :ref:`Vector3` normal **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | +| void | :ref:`set_vertex_tangent` **(** :ref:`int` idx, :ref:`Plane` tangent **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | +| void | :ref:`set_vertex_uv` **(** :ref:`int` idx, :ref:`Vector2` uv **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | +| void | :ref:`set_vertex_uv2` **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | +| void | :ref:`set_vertex_weights` **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_MeshDataTool_clear: @@ -106,11 +105,11 @@ Member Function Description .. _class_MeshDataTool_commit_to_surface: -- :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** +- :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** .. _class_MeshDataTool_create_from_surface: -- :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** +- :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** .. _class_MeshDataTool_get_edge_count: @@ -118,11 +117,11 @@ Member Function Description .. _class_MeshDataTool_get_edge_faces: -- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_meta: -- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_vertex: @@ -138,11 +137,11 @@ Member Function Description .. _class_MeshDataTool_get_face_meta: -- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_face_normal: -- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_face_vertex: @@ -154,19 +153,19 @@ Member Function Description .. _class_MeshDataTool_get_material: -- :ref:`Material` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const .. _class_MeshDataTool_get_vertex: -- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_bones: -- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_color: -- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const +- :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_count: @@ -174,82 +173,82 @@ Member Function Description .. _class_MeshDataTool_get_vertex_edges: -- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_faces: -- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const +- :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_meta: -- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_normal: -- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_tangent: -- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const +- :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_uv: -- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_uv2: -- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_weights: -- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const +- :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_set_edge_meta: -- void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_face_meta: -- void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** .. _class_MeshDataTool_set_vertex: -- void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** +- void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** .. _class_MeshDataTool_set_vertex_bones: -- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** +- void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** .. _class_MeshDataTool_set_vertex_color: -- void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** +- void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** .. _class_MeshDataTool_set_vertex_meta: -- void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** +- void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** .. _class_MeshDataTool_set_vertex_normal: -- void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** +- void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** .. _class_MeshDataTool_set_vertex_tangent: -- void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** +- void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** .. _class_MeshDataTool_set_vertex_uv: -- void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** +- void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** .. _class_MeshDataTool_set_vertex_uv2: -- void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** +- void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** .. _class_MeshDataTool_set_vertex_weights: -- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** +- void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 9bf5a3b1c..33f0d91a6 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -7,10 +7,8 @@ MeshInstance ============ -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`SoftBody` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`SoftBody` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Node that instances meshes into a scenario. -Member Functions ----------------- +Methods +------- +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_convex_collision` **(** **)** | @@ -28,59 +26,59 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_trimesh_collision` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | +| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_MeshInstance_mesh: - -- :ref:`Mesh` **mesh** - The :ref:`Mesh` resource for the instance. - - .. _class_MeshInstance_skeleton: - -- :ref:`NodePath` **skeleton** - :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. - - Description ----------- -MeshInstance is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single :ref:`Mesh` in many places. This allows to reuse geometry and save on resources. When a :ref:`Mesh` has to be instanced more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance` instead. +MeshInstance is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single :ref:`Mesh` in many places. This allows to reuse geometry and save on resources. When a :ref:`Mesh` has to be instanced more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance` instead. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_MeshInstance_mesh: + +- :ref:`Mesh` **mesh** - The :ref:`Mesh` resource for the instance. + + .. _class_MeshInstance_skeleton: + +- :ref:`NodePath` **skeleton** - :ref:`NodePath` to the :ref:`Skeleton` associated with the instance. + + +Method Descriptions +------------------- .. _class_MeshInstance_create_convex_collision: - void **create_convex_collision** **(** **)** -This helper creates a :ref:`StaticBody` child node with a :ref:`ConvexPolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. +This helper creates a :ref:`StaticBody` child node with a :ref:`ConvexPolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_create_debug_tangents: - void **create_debug_tangents** **(** **)** -This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. +This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_create_trimesh_collision: - void **create_trimesh_collision** **(** **)** -This helper creates a :ref:`StaticBody` child node with a :ref:`ConcavePolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. +This helper creates a :ref:`StaticBody` child node with a :ref:`ConcavePolygonShape` collision shape calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_get_surface_material: -- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const +- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const -Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. +Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. .. _class_MeshInstance_set_surface_material: -- void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** +- void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** -Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. +Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 004e8035e..c6d450727 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -7,8 +7,7 @@ MeshInstance2D ============== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_MeshInstance2D_mesh: -- :ref:`Mesh` **mesh** +- :ref:`Mesh` **mesh** .. _class_MeshInstance2D_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture` **normal_map** .. _class_MeshInstance2D_texture: -- :ref:`Texture` **texture** +- :ref:`Texture` **texture** diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 50b8c1eea..a0157aaa2 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -7,8 +7,7 @@ MeshLibrary =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,50 +15,50 @@ Brief Description Library of meshes. -Member Functions ----------------- +Methods +------- +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_item` **(** :ref:`int` id **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | +| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | +| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` id **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | +| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | +| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | +| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Library of meshes. Contains a list of :ref:`Mesh` resources, each with name and ID. Useful for GridMap or painting Terrain. +Library of meshes. Contains a list of :ref:`Mesh` resources, each with name and ID. Useful for GridMap or painting Terrain. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_MeshLibrary_clear: @@ -75,37 +74,37 @@ Create a new item in the library, supplied an id. .. _class_MeshLibrary_find_item_by_name: -- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const .. _class_MeshLibrary_get_item_list: -- :ref:`PoolIntArray` **get_item_list** **(** **)** const +- :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. .. _class_MeshLibrary_get_item_mesh: -- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const +- :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const Return the mesh of the item. .. _class_MeshLibrary_get_item_name: -- :ref:`String` **get_item_name** **(** :ref:`int` id **)** const +- :ref:`String` **get_item_name** **(** :ref:`int` id **)** const Return the name of the item. .. _class_MeshLibrary_get_item_navmesh: -- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const +- :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_item_preview: -- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const +- :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_item_shapes: -- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const .. _class_MeshLibrary_get_last_unused_item_id: @@ -121,26 +120,26 @@ Remove the item. .. _class_MeshLibrary_set_item_mesh: -- void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** +- void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** Set the mesh of the item. .. _class_MeshLibrary_set_item_name: -- void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** +- void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the item. .. _class_MeshLibrary_set_item_navmesh: -- void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** +- void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** .. _class_MeshLibrary_set_item_preview: -- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** .. _class_MeshLibrary_set_item_shapes: -- void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** +- void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 8dd04977b..aa9d08d27 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -7,8 +7,7 @@ MobileVRInterface ================= -**Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`ARVRInterface` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,15 @@ Brief Description Generic mobile VR implementation -Member Variables ----------------- +Description +----------- + +This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect you do need a mobile phone with a gyroscope and accelerometer. + +Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters. + +Property Descriptions +--------------------- .. _class_MobileVRInterface_display_to_lens: @@ -44,10 +50,3 @@ Member Variables - :ref:`float` **oversample** - The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. -Description ------------ - -This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect you do need a mobile phone with a gyroscope and accelerometer. - -Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters. - diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 3fa2dae05..5e5277068 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -7,8 +7,7 @@ MultiMesh ========= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,27 @@ Brief Description Provides high performance mesh instancing. -Member Functions ----------------- +Methods +------- +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | +| :ref:`Color` | :ref:`get_instance_color` **(** :ref:`int` instance **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | +| :ref:`Color` | :ref:`get_instance_custom_data` **(** :ref:`int` instance **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | +| :ref:`Transform` | :ref:`get_instance_transform` **(** :ref:`int` instance **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | +| void | :ref:`set_instance_color` **(** :ref:`int` instance, :ref:`Color` color **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_custom_data` **(** :ref:`int` instance, :ref:`Color` custom_data **)** | ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_transform` **(** :ref:`int` instance, :ref:`Transform` transform **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_MultiMesh_color_format: - -- :ref:`ColorFormat` **color_format** - - .. _class_MultiMesh_instance_count: - -- :ref:`int` **instance_count** - - .. _class_MultiMesh_mesh: - -- :ref:`Mesh` **mesh** - - .. _class_MultiMesh_transform_format: - -- :ref:`TransformFormat` **transform_format** - - -Enums ------ +Enumerations +------------ .. _enum_MultiMesh_TransformFormat: @@ -69,11 +52,19 @@ enum **ColorFormat** - **COLOR_8BIT** = **1** - **COLOR_FLOAT** = **2** + .. _enum_MultiMesh_CustomDataFormat: + +enum **CustomDataFormat** + +- **CUSTOM_DATA_NONE** = **0** +- **CUSTOM_DATA_8BIT** = **1** +- **CUSTOM_DATA_FLOAT** = **2** + Description ----------- -MultiMesh provides low level mesh instancing. If the amount of :ref:`Mesh` instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of :ref:`MeshInstance` nodes may affect performance by using too much CPU or video memory. +MultiMesh provides low level mesh instancing. If the amount of :ref:`Mesh` instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of :ref:`MeshInstance` nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. @@ -81,36 +72,68 @@ As a drawback, if the instances are too far away of each other, performance may Since instances may have any behavior, the AABB used for visibility must be provided by the user. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_MultiMesh_color_format: + +- :ref:`ColorFormat` **color_format** + + .. _class_MultiMesh_custom_data_format: + +- :ref:`CustomDataFormat` **custom_data_format** + + .. _class_MultiMesh_instance_count: + +- :ref:`int` **instance_count** + + .. _class_MultiMesh_mesh: + +- :ref:`Mesh` **mesh** + + .. _class_MultiMesh_transform_format: + +- :ref:`TransformFormat` **transform_format** + + +Method Descriptions +------------------- .. _class_MultiMesh_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** const Return the visibility AABB. .. _class_MultiMesh_get_instance_color: -- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const +- :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const Get the color of a specific instance. +.. _class_MultiMesh_get_instance_custom_data: + +- :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const + .. _class_MultiMesh_get_instance_transform: -- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const +- :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Return the transform of a specific instance. .. _class_MultiMesh_set_instance_color: -- void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** +- void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Set the color of a specific instance. +.. _class_MultiMesh_set_instance_custom_data: + +- void **set_instance_custom_data** **(** :ref:`int` instance, :ref:`Color` custom_data **)** + .. _class_MultiMesh_set_instance_transform: -- void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** +- void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** Set the transform for a specific instance. diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index cdec7888b..77db6b8db 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -7,27 +7,26 @@ MultiMeshInstance ================= -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Node that instances a :ref:`MultiMesh`. - -Member Variables ----------------- - - .. _class_MultiMeshInstance_multimesh: - -- :ref:`MultiMesh` **multimesh** - The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. - +Node that instances a :ref:`MultiMesh`. Description ----------- -``MultiMeshInstance`` is a specialized node to instance :ref:`GeometryInstance`\ s based on a :ref:`MultiMesh` resource. +``MultiMeshInstance`` is a specialized node to instance :ref:`GeometryInstance`\ s based on a :ref:`MultiMesh` resource. This is useful to optimize the rendering of a high amount of instances of a given mesh (for example tree in a forest or grass strands). +Property Descriptions +--------------------- + + .. _class_MultiMeshInstance_multimesh: + +- :ref:`MultiMesh` **multimesh** - The :ref:`MultiMesh` resource that will be used and shared among all instances of the ``MultiMeshInstance``. + + diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 2ff4537fe..b9c7f6d8b 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -7,8 +7,7 @@ MultiplayerAPI ============== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description High Level Multiplayer API. -Member Functions ----------------- +Methods +------- +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,9 +33,9 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | +| :ref:`Error` | :ref:`send_bytes` **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | +| void | :ref:`set_root_node` **(** :ref:`Node` node **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -68,7 +67,7 @@ Emitted whenever this MultiplayerAPI's :ref:`network_peer` id, :ref:`PoolByteArray` packet **)** +- **network_peer_packet** **(** :ref:`int` id, :ref:`PoolByteArray` packet **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` receive a ``packet`` with custom data (see :ref:`send_bytes`). ID is the peer ID of the peer that sent the packet. @@ -79,20 +78,8 @@ Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from server. Only emitted on clients. -Member Variables ----------------- - - .. _class_MultiplayerAPI_network_peer: - -- :ref:`NetworkedMultiplayerPeer` **network_peer** - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with :ref:`is_network_server`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. - - .. _class_MultiplayerAPI_refuse_new_network_connections: - -- :ref:`bool` **refuse_new_network_connections** - If ``true`` the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. - - -Enums ------ +Enumerations +------------ .. _enum_MultiplayerAPI_RPCMode: @@ -113,12 +100,24 @@ Description This class implements most of the logic behind the high level multiplayer API. -By default, :ref:`SceneTree` has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene. +By default, :ref:`SceneTree` has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene. It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the :ref:`Node.custom_multiplayer` property, effectively allowing to run both client and server in the same scene. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_MultiplayerAPI_network_peer: + +- :ref:`NetworkedMultiplayerPeer` **network_peer** - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with :ref:`is_network_server`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. + + .. _class_MultiplayerAPI_refuse_new_network_connections: + +- :ref:`bool` **refuse_new_network_connections** - If ``true`` the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. + + +Method Descriptions +------------------- .. _class_MultiplayerAPI_clear: @@ -128,7 +127,7 @@ Clears the current MultiplayerAPI network state (you shouldn't call this unless .. _class_MultiplayerAPI_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. @@ -162,19 +161,19 @@ Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` override or you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default :ref:`SceneTree` will poll its MultiplayerAPI for you. +Method used for polling the MultiplayerAPI. You only need to worry about this if you are using :ref:`Node.custom_multiplayer` override or you set :ref:`SceneTree.multiplayer_poll` to ``false``. By default :ref:`SceneTree` will poll its MultiplayerAPI for you. -NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. ``_process``, ``physics``, :ref:`Thread`). +NOTE: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. ``_process``, ``physics``, :ref:`Thread`). .. _class_MultiplayerAPI_send_bytes: -- :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** +- :ref:`Error` **send_bytes** **(** :ref:`PoolByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2 **)** Sends the given raw ``bytes`` to a specific peer identified by ``id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Default ID is ``0``, i.e. broadcast to all peers. .. _class_MultiplayerAPI_set_root_node: -- void **set_root_node** **(** :ref:`Node` node **)** +- void **set_root_node** **(** :ref:`Node` node **)** Sets the base root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. diff --git a/classes/class_multiplayerpeergdnative.rst b/classes/class_multiplayerpeergdnative.rst index 9142794fc..b9193a19b 100644 --- a/classes/class_multiplayerpeergdnative.rst +++ b/classes/class_multiplayerpeergdnative.rst @@ -7,8 +7,7 @@ MultiplayerPeerGDNative ======================= -**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 9b3fb4e09..406b57b9f 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -7,8 +7,7 @@ Mutex ===== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description A synchronization Mutex. -Member Functions ----------------- +Methods +------- +----------------------------------------+---------------------------------------------------+ | void | :ref:`lock` **(** **)** | +----------------------------------------+---------------------------------------------------+ -| :ref:`Error` | :ref:`try_lock` **(** **)** | +| :ref:`Error` | :ref:`try_lock` **(** **)** | +----------------------------------------+---------------------------------------------------+ | void | :ref:`unlock` **(** **)** | +----------------------------------------+---------------------------------------------------+ @@ -30,10 +29,10 @@ Member Functions Description ----------- -A synchronization Mutex. Element used to synchronize multiple :ref:`Thread`\ s. Basically a binary :ref:`Semaphore`. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks. +A synchronization Mutex. Element used to synchronize multiple :ref:`Thread`\ s. Basically a binary :ref:`Semaphore`. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Mutex_lock: @@ -43,7 +42,7 @@ Lock this ``Mutex``, blocks until it is unlocked by the current owner. .. _class_Mutex_try_lock: -- :ref:`Error` **try_lock** **(** **)** +- :ref:`Error` **try_lock** **(** **)** Try locking this ``Mutex``, does not block. Returns OK on success, ERR_BUSY otherwise. diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index 3095562e9..88c82f9a2 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -7,8 +7,7 @@ NativeScript ============ -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,71 +15,71 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | +| :ref:`String` | :ref:`get_class_documentation` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** const | +| :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** const | +| :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`new` **(** **)** vararg | +| :ref:`Object` | :ref:`new` **(** **)** vararg | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_NativeScript_class_name: -- :ref:`String` **class_name** +- :ref:`String` **class_name** .. _class_NativeScript_library: -- :ref:`GDNativeLibrary` **library** +- :ref:`GDNativeLibrary` **library** .. _class_NativeScript_script_class_icon_path: -- :ref:`String` **script_class_icon_path** +- :ref:`String` **script_class_icon_path** .. _class_NativeScript_script_class_name: -- :ref:`String` **script_class_name** +- :ref:`String` **script_class_name** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_NativeScript_get_class_documentation: -- :ref:`String` **get_class_documentation** **(** **)** const +- :ref:`String` **get_class_documentation** **(** **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. .. _class_NativeScript_get_method_documentation: -- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const +- :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. .. _class_NativeScript_get_property_documentation: -- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const +- :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. .. _class_NativeScript_get_signal_documentation: -- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const +- :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** const Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. .. _class_NativeScript_new: -- :ref:`Object` **new** **(** **)** vararg +- :ref:`Object` **new** **(** **)** vararg Constructs a new object of the base type with a script of this type already attached. diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index 2660fdda3..dde1ee6a2 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -7,8 +7,7 @@ Navigation ========== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,89 +15,89 @@ Brief Description Mesh-based navigation and pathfinding node. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | +| :ref:`Vector3` | :ref:`get_closest_point` **(** :ref:`Vector3` to_point **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | +| :ref:`Vector3` | :ref:`get_closest_point_normal` **(** :ref:`Vector3` to_point **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector3` to_point **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | +| :ref:`PoolVector3Array` | :ref:`get_simple_path` **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navmesh_add` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | +| :ref:`int` | :ref:`navmesh_add` **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`navmesh_remove` **(** :ref:`int` id **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | +| void | :ref:`navmesh_set_transform` **(** :ref:`int` id, :ref:`Transform` xform **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Navigation_up_vector: - -- :ref:`Vector3` **up_vector** - Defines which direction is up. By default this is ``(0, 1, 0)``, which is the world up direction. - - Description ----------- -Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. By default these will be automatically collected from child :ref:`NavigationMeshInstance` nodes, but they can also be added on the fly with :ref:`navmesh_add`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. +Provides navigation and pathfinding within a collection of :ref:`NavigationMesh`\ es. By default these will be automatically collected from child :ref:`NavigationMeshInstance` nodes, but they can also be added on the fly with :ref:`navmesh_add`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Navigation_up_vector: + +- :ref:`Vector3` **up_vector** - Defines which direction is up. By default this is ``(0, 1, 0)``, which is the world up direction. + + +Method Descriptions +------------------- .. _class_Navigation_get_closest_point: -- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** Returns the navigation point closest to the point given. Points are in local coordinate space. .. _class_Navigation_get_closest_point_normal: -- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** +- :ref:`Vector3` **get_closest_point_normal** **(** :ref:`Vector3` to_point **)** Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. .. _class_Navigation_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** +- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector3` to_point **)** -Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a NavigtionMeshInstance. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner of the :ref:`NavigationMesh` which contains the navigation point closest to the point given. This is usually a NavigtionMeshInstance. For meshes added via :ref:`navmesh_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). .. _class_Navigation_get_closest_point_to_segment: -- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** +- :ref:`Vector3` **get_closest_point_to_segment** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` use_collision=false **)** Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. .. _class_Navigation_get_simple_path: -- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector3Array` **get_simple_path** **(** :ref:`Vector3` start, :ref:`Vector3` end, :ref:`bool` optimize=true **)** -Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh` (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored. +Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh` (raidus, height, etc.) are considered in the path calculation, otherwise they are ignored. .. _class_Navigation_navmesh_add: -- :ref:`int` **navmesh_add** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** +- :ref:`int` **navmesh_add** **(** :ref:`NavigationMesh` mesh, :ref:`Transform` xform, :ref:`Object` owner=null **)** -Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +Adds a :ref:`NavigationMesh`. Returns an ID for use with :ref:`navmesh_remove` or :ref:`navmesh_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. .. _class_Navigation_navmesh_remove: - void **navmesh_remove** **(** :ref:`int` id **)** -Removes the :ref:`NavigationMesh` with the given ID. +Removes the :ref:`NavigationMesh` with the given ID. .. _class_Navigation_navmesh_set_transform: -- void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** +- void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** -Sets the transform applied to the :ref:`NavigationMesh` with the given ID. +Sets the transform applied to the :ref:`NavigationMesh` with the given ID. diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 137f4ae20..51d4bd267 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -7,8 +7,7 @@ Navigation2D ============ -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,65 +15,65 @@ Brief Description 2D navigation and pathfinding node. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` to_point **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | +| :ref:`Object` | :ref:`get_closest_point_owner` **(** :ref:`Vector2` to_point **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | +| :ref:`PoolVector2Array` | :ref:`get_simple_path` **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navpoly_add` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | +| :ref:`int` | :ref:`navpoly_add` **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`navpoly_remove` **(** :ref:`int` id **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | +| void | :ref:`navpoly_set_transform` **(** :ref:`int` id, :ref:`Transform2D` xform **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. By default these are automatically collected from child :ref:`NavigationPolygonInstance` nodes, but they can also be added on the fly with :ref:`navpoly_add`. +Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of :ref:`NavigationPolygon` resources. By default these are automatically collected from child :ref:`NavigationPolygonInstance` nodes, but they can also be added on the fly with :ref:`navpoly_add`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Navigation2D_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** Returns the navigation point closest to the point given. Points are in local coordinate space. .. _class_Navigation2D_get_closest_point_owner: -- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** +- :ref:`Object` **get_closest_point_owner** **(** :ref:`Vector2` to_point **)** -Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a NavigtionPolygonInstance. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). +Returns the owner of the :ref:`NavigationPolygon` which contains the navigation point closest to the point given. This is usually a NavigtionPolygonInstance. For polygons added via :ref:`navpoly_add`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted). .. _class_Navigation2D_get_simple_path: -- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** +- :ref:`PoolVector2Array` **get_simple_path** **(** :ref:`Vector2` start, :ref:`Vector2` end, :ref:`bool` optimize=true **)** Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the path is smoothed by merging path segments where possible. .. _class_Navigation2D_navpoly_add: -- :ref:`int` **navpoly_add** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** +- :ref:`int` **navpoly_add** **(** :ref:`NavigationPolygon` mesh, :ref:`Transform2D` xform, :ref:`Object` owner=null **)** -Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. +Adds a :ref:`NavigationPolygon`. Returns an ID for use with :ref:`navpoly_remove` or :ref:`navpoly_set_transform`. If given, a :ref:`Transform2D` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner`. .. _class_Navigation2D_navpoly_remove: - void **navpoly_remove** **(** :ref:`int` id **)** -Removes the :ref:`NavigationPolygon` with the given ID. +Removes the :ref:`NavigationPolygon` with the given ID. .. _class_Navigation2D_navpoly_set_transform: -- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** +- void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** -Sets the transform applied to the :ref:`NavigationPolygon` with the given ID. +Sets the transform applied to the :ref:`NavigationPolygon` with the given ID. diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index a5e7eea5e..605a20285 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -7,8 +7,7 @@ NavigationMesh ============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,34 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- + +- **SAMPLE_PARTITION_WATERSHED** = **0** +- **SAMPLE_PARTITION_MONOTONE** = **1** +- **SAMPLE_PARTITION_LAYERS** = **2** + +Property Descriptions +--------------------- .. _class_NavigationMesh_agent/height: @@ -107,19 +113,12 @@ Member Variables - :ref:`int` **sample_partition_type/sample_partition_type** -Numeric Constants ------------------ - -- **SAMPLE_PARTITION_WATERSHED** = **0** -- **SAMPLE_PARTITION_MONOTONE** = **1** -- **SAMPLE_PARTITION_LAYERS** = **2** - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_NavigationMesh_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationMesh_clear_polygons: @@ -127,11 +126,11 @@ Member Function Description .. _class_NavigationMesh_create_from_mesh: -- void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +- void **create_from_mesh** **(** :ref:`Mesh` mesh **)** .. _class_NavigationMesh_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationMesh_get_polygon_count: @@ -139,10 +138,10 @@ Member Function Description .. _class_NavigationMesh_get_vertices: -- :ref:`PoolVector3Array` **get_vertices** **(** **)** const +- :ref:`PoolVector3Array` **get_vertices** **(** **)** const .. _class_NavigationMesh_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index cc4b5347e..a6bc9aa52 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -7,8 +7,7 @@ NavigationMeshInstance ====================== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_NavigationMeshInstance_enabled: @@ -25,6 +24,6 @@ Member Variables .. _class_NavigationMeshInstance_navmesh: -- :ref:`NavigationMesh` **navmesh** +- :ref:`NavigationMesh` **navmesh** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index fa0fe3d72..3688b5720 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -7,8 +7,7 @@ NavigationPolygon ================= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,53 +15,53 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | +| void | :ref:`add_outline` **(** :ref:`PoolVector2Array` outline **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | +| void | :ref:`add_outline_at_index` **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_outlines` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_polygons` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | +| :ref:`PoolVector2Array` | :ref:`get_outline` **(** :ref:`int` idx **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_outline_count` **(** **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_polygon_count` **(** **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | +| :ref:`PoolVector2Array` | :ref:`get_vertices` **(** **)** const | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_polygons_from_outlines` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_outline` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | +| void | :ref:`set_outline` **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | +| void | :ref:`set_vertices` **(** :ref:`PoolVector2Array` vertices **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_NavigationPolygon_add_outline: -- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** +- void **add_outline** **(** :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_add_outline_at_index: -- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** +- void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** .. _class_NavigationPolygon_add_polygon: -- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** +- void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** .. _class_NavigationPolygon_clear_outlines: @@ -74,7 +73,7 @@ Member Function Description .. _class_NavigationPolygon_get_outline: -- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const +- :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const .. _class_NavigationPolygon_get_outline_count: @@ -82,7 +81,7 @@ Member Function Description .. _class_NavigationPolygon_get_polygon: -- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** +- :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** .. _class_NavigationPolygon_get_polygon_count: @@ -90,7 +89,7 @@ Member Function Description .. _class_NavigationPolygon_get_vertices: -- :ref:`PoolVector2Array` **get_vertices** **(** **)** const +- :ref:`PoolVector2Array` **get_vertices** **(** **)** const .. _class_NavigationPolygon_make_polygons_from_outlines: @@ -102,10 +101,10 @@ Member Function Description .. _class_NavigationPolygon_set_outline: -- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** +- void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** .. _class_NavigationPolygon_set_vertices: -- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** +- void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index 37a15dc31..fc1f0d2d2 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -7,8 +7,7 @@ NavigationPolygonInstance ========================= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_NavigationPolygonInstance_enabled: @@ -25,6 +24,6 @@ Member Variables .. _class_NavigationPolygonInstance_navpoly: -- :ref:`NavigationPolygon` **navpoly** +- :ref:`NavigationPolygon` **navpoly** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index bbf4356a8..c6a957811 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -7,8 +7,7 @@ NetworkedMultiplayerENet ======================== -**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description PacketPeer implementation using the ENet library. -Member Functions ----------------- +Methods +------- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close_connection` **(** :ref:`int` wait_usec=100 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_client` **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** | +| :ref:`Error` | :ref:`create_client` **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | +| :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` id, :ref:`bool` now=false **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -32,35 +31,15 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_channel` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | +| void | :ref:`set_bind_ip` **(** :ref:`String` ip **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_NetworkedMultiplayerENet_always_ordered: - -- :ref:`bool` **always_ordered** - Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. This is the only way to use ordering with the RPC system. - - .. _class_NetworkedMultiplayerENet_channel_count: - -- :ref:`int` **channel_count** - The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. - - .. _class_NetworkedMultiplayerENet_compression_mode: - -- :ref:`CompressionMode` **compression_mode** - The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. - - .. _class_NetworkedMultiplayerENet_transfer_channel: - -- :ref:`int` **transfer_channel** - Set the default channel to be used to transfer data. By default this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. - - -Enums ------ +Enumerations +------------ .. _enum_NetworkedMultiplayerENet_CompressionMode: @@ -76,7 +55,7 @@ enum **CompressionMode** Description ----------- -A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. +A PacketPeer implementation that should be passed to :ref:`SceneTree.set_network_peer` after being initialized as either a client or server. Events can then be handled by connecting to :ref:`SceneTree` signals. Tutorials --------- @@ -84,8 +63,28 @@ Tutorials - :doc:`../tutorials/networking/high_level_multiplayer` - `http://enet.bespin.org/usergroup0.html `_ -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_NetworkedMultiplayerENet_always_ordered: + +- :ref:`bool` **always_ordered** - Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. This is the only way to use ordering with the RPC system. + + .. _class_NetworkedMultiplayerENet_channel_count: + +- :ref:`int` **channel_count** - The number of channels to be used by ENet. Default: ``3``. Channels are used to separate different kinds of data. In realiable or ordered mode, for example, the packet delivery order is ensured on a per channel basis. + + .. _class_NetworkedMultiplayerENet_compression_mode: + +- :ref:`CompressionMode` **compression_mode** - The compression method used for network packets. Default is no compression. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all. + + .. _class_NetworkedMultiplayerENet_transfer_channel: + +- :ref:`int` **transfer_channel** - Set the default channel to be used to transfer data. By default this value is ``-1`` which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel ``0`` is reserved, and cannot be used. Setting this member to any value between ``0`` and :ref:`channel_count` (excluded) will force ENet to use that channel for sending data. + + +Method Descriptions +------------------- .. _class_NetworkedMultiplayerENet_close_connection: @@ -95,13 +94,13 @@ Closes the connection. Ignored if no connection is currently established. If thi .. _class_NetworkedMultiplayerENet_create_client: -- :ref:`Error` **create_client** **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** +- :ref:`Error` **create_client** **(** :ref:`String` address, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0, :ref:`int` client_port=0 **)** Create client that connects to a server at ``address`` using specified ``port``. The given address needs to be either a fully qualified domain nome (e.g. ``www.example.com``) or an IP address in IPv4 or IPv6 format (e.g. ``192.168.1.1``). The ``port`` is the port the server is listening on. The ``in_bandwidth`` and ``out_bandwidth`` parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns ``OK`` if a client was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the client could not be created. If ``client_port`` is specified, the client will also listen to the given port, this is useful in some NAT traveral technique. .. _class_NetworkedMultiplayerENet_create_server: -- :ref:`Error` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +- :ref:`Error` **create_server** **(** :ref:`int` port, :ref:`int` max_clients=32, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** Create server that listens to connections via ``port``. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use :ref:`set_bind_ip`. The default IP is the wildcard ``*``, which listens on all available interfaces. ``max_clients`` is the maximum number of clients that are allowed at once, any number up to 4096 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see :ref:`create_client`. Returns ``OK`` if a server was created, ``ERR_ALREADY_IN_USE`` if this NetworkedMultiplayerEnet instance already has an open connection (in which case you need to call :ref:`close_connection` first) or ``ERR_CANT_CREATE`` if the server could not be created. @@ -125,7 +124,7 @@ Returns the channel of the next packet that will be retrieved via :ref:`PacketPe .. _class_NetworkedMultiplayerENet_get_peer_address: -- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. @@ -137,7 +136,7 @@ Returns the remote port of the given peer. .. _class_NetworkedMultiplayerENet_set_bind_ip: -- void **set_bind_ip** **(** :ref:`String` ip **)** +- void **set_bind_ip** **(** :ref:`String` ip **)** The IP used when creating a server. This is set to the wildcard ``*`` by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: ``192.168.1.1``. diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index eb6728227..5259d870f 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -7,10 +7,8 @@ NetworkedMultiplayerPeer ======================== -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`MultiplayerPeerGDNative`, :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` - +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`MultiplayerPeerGDNative`, :ref:`NetworkedMultiplayerENet`, :ref:`WebSocketMultiplayerPeer` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description A high-level network interface to simplify multiplayer interactions. -Member Functions ----------------- +Methods +------- +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** const | +| :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** const | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_peer` **(** **)** const | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ @@ -67,26 +65,8 @@ Emitted by the server when a client disconnects. Emitted by clients when the server disconnects. -Member Variables ----------------- - - .. _class_NetworkedMultiplayerPeer_refuse_new_connections: - -- :ref:`bool` **refuse_new_connections** - If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. - - .. _class_NetworkedMultiplayerPeer_transfer_mode: - -- :ref:`TransferMode` **transfer_mode** - The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. - - -Numeric Constants ------------------ - -- **TARGET_PEER_BROADCAST** = **0** --- Packets are sent to the server and then redistributed to other peers. -- **TARGET_PEER_SERVER** = **1** --- Packets are sent to the server alone. - -Enums ------ +Enumerations +------------ .. _enum_NetworkedMultiplayerPeer_TransferMode: @@ -105,6 +85,12 @@ enum **ConnectionStatus** - **CONNECTION_CONNECTED** = **2** --- The connection attempt succeeded. +Constants +--------- + +- **TARGET_PEER_BROADCAST** = **0** --- Packets are sent to the server and then redistributed to other peers. +- **TARGET_PEER_SERVER** = **1** --- Packets are sent to the server alone. + Description ----------- @@ -115,14 +101,26 @@ Tutorials - :doc:`../tutorials/networking/high_level_multiplayer` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_NetworkedMultiplayerPeer_refuse_new_connections: + +- :ref:`bool` **refuse_new_connections** - If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. + + .. _class_NetworkedMultiplayerPeer_transfer_mode: + +- :ref:`TransferMode` **transfer_mode** - The manner in which to send packets to the ``target_peer``. See :ref:`TransferMode`. + + +Method Descriptions +------------------- .. _class_NetworkedMultiplayerPeer_get_connection_status: -- :ref:`ConnectionStatus` **get_connection_status** **(** **)** const +- :ref:`ConnectionStatus` **get_connection_status** **(** **)** const -Returns the current state of the connection. See :ref:`ConnectionStatus`. +Returns the current state of the connection. See :ref:`ConnectionStatus`. .. _class_NetworkedMultiplayerPeer_get_packet_peer: diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 5dc12db1f..6f0276b24 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -14,55 +14,55 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolColorArray` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolVector3Array` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolVector2Array` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolStringArray` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolRealArray` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolIntArray` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | +| void | :ref:`Nil` **(** :ref:`PoolByteArray` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Array` from **)** | +| void | :ref:`Nil` **(** :ref:`Array` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | +| void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Object` from **)** | +| void | :ref:`Nil` **(** :ref:`Object` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`RID` from **)** | +| void | :ref:`Nil` **(** :ref:`RID` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | +| void | :ref:`Nil` **(** :ref:`NodePath` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Color` from **)** | +| void | :ref:`Nil` **(** :ref:`Color` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform` from **)** | +| void | :ref:`Nil` **(** :ref:`Transform` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Basis` from **)** | +| void | :ref:`Nil` **(** :ref:`Basis` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`AABB` from **)** | +| void | :ref:`Nil` **(** :ref:`AABB` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Quat` from **)** | +| void | :ref:`Nil` **(** :ref:`Quat` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Plane` from **)** | +| void | :ref:`Nil` **(** :ref:`Plane` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | +| void | :ref:`Nil` **(** :ref:`Transform2D` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | +| void | :ref:`Nil` **(** :ref:`Vector3` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | +| void | :ref:`Nil` **(** :ref:`Rect2` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | +| void | :ref:`Nil` **(** :ref:`Vector2` from **)** | +-------+--------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`String` from **)** | +| void | :ref:`Nil` **(** :ref:`String` from **)** | +-------+--------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`float` from **)** | +-------+--------------------------------------------------------------------------------------------+ @@ -71,100 +71,100 @@ Member Functions | void | :ref:`Nil` **(** :ref:`bool` from **)** | +-------+--------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolColorArray` from **)** +- void **Nil** **(** :ref:`PoolColorArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolVector3Array` from **)** +- void **Nil** **(** :ref:`PoolVector3Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolVector2Array` from **)** +- void **Nil** **(** :ref:`PoolVector2Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolStringArray` from **)** +- void **Nil** **(** :ref:`PoolStringArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolRealArray` from **)** +- void **Nil** **(** :ref:`PoolRealArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolIntArray` from **)** +- void **Nil** **(** :ref:`PoolIntArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`PoolByteArray` from **)** +- void **Nil** **(** :ref:`PoolByteArray` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Array` from **)** +- void **Nil** **(** :ref:`Array` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Dictionary` from **)** +- void **Nil** **(** :ref:`Dictionary` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Object` from **)** +- void **Nil** **(** :ref:`Object` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`RID` from **)** +- void **Nil** **(** :ref:`RID` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`NodePath` from **)** +- void **Nil** **(** :ref:`NodePath` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Color` from **)** +- void **Nil** **(** :ref:`Color` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Transform` from **)** +- void **Nil** **(** :ref:`Transform` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Basis` from **)** +- void **Nil** **(** :ref:`Basis` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`AABB` from **)** +- void **Nil** **(** :ref:`AABB` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Quat` from **)** +- void **Nil** **(** :ref:`Quat` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Plane` from **)** +- void **Nil** **(** :ref:`Plane` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Transform2D` from **)** +- void **Nil** **(** :ref:`Transform2D` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector3` from **)** +- void **Nil** **(** :ref:`Vector3` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Rect2` from **)** +- void **Nil** **(** :ref:`Rect2` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Vector2` from **)** +- void **Nil** **(** :ref:`Vector2` from **)** .. _class_Nil_Nil: -- void **Nil** **(** :ref:`String` from **)** +- void **Nil** **(** :ref:`String` from **)** .. _class_Nil_Nil: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index c0ee8b3b9..af1ea93c4 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -7,8 +7,7 @@ NinePatchRect ============= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -26,16 +25,33 @@ Signals Fired when the node's texture changes. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_NinePatchRect_AxisStretchMode: + +enum **AxisStretchMode** + +- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``. +- **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing. +- **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Doesn't do anything at the time of writing. + + +Description +----------- + +Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. + +Property Descriptions +--------------------- .. _class_NinePatchRect_axis_stretch_horizontal: -- :ref:`AxisStretchMode` **axis_stretch_horizontal** - Doesn't do anything at the time of writing. +- :ref:`AxisStretchMode` **axis_stretch_horizontal** - Doesn't do anything at the time of writing. .. _class_NinePatchRect_axis_stretch_vertical: -- :ref:`AxisStretchMode` **axis_stretch_vertical** - Doesn't do anything at the time of writing. +- :ref:`AxisStretchMode` **axis_stretch_vertical** - Doesn't do anything at the time of writing. .. _class_NinePatchRect_draw_center: @@ -59,27 +75,10 @@ Member Variables .. _class_NinePatchRect_region_rect: -- :ref:`Rect2` **region_rect** - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. +- :ref:`Rect2` **region_rect** - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. .. _class_NinePatchRect_texture: -- :ref:`Texture` **texture** - The node's texture resource. +- :ref:`Texture` **texture** - The node's texture resource. -Enums ------ - - .. _enum_NinePatchRect_AxisStretchMode: - -enum **AxisStretchMode** - -- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``. -- **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing. -- **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Doesn't do anything at the time of writing. - - -Description ------------ - -Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. - diff --git a/classes/class_node.rst b/classes/class_node.rst index 93ef5602c..ff7699069 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -7,10 +7,8 @@ Node ==== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`SkeletonIK`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`AnimationTree`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`SkeletonIK`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`AnimationTree`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` **Category:** Core Brief Description @@ -18,17 +16,17 @@ Brief Description Base class for all *scene* objects. -Member Functions ----------------- +Methods +------- +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_enter_tree` **(** **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_exit_tree` **(** **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | +| :ref:`String` | :ref:`_get_configuration_warning` **(** **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_physics_process` **(** :ref:`float` delta **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,43 +34,43 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_ready` **(** **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | +| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_process` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_child_count` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | +| :ref:`Array` | :ref:`get_children` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | +| :ref:`Array` | :ref:`get_groups` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_index` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_network_master` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | +| :ref:`Node` | :ref:`get_parent` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_physics_process_delta_time` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,21 +80,21 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -116,7 +114,7 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_stray_nodes` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -124,7 +122,7 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_tree_pretty` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`propagate_notification` **(** :ref:`int` what **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -134,33 +132,33 @@ Member Functions +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_and_skip` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`request_ready` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`RPCMode` mode **)** | +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`RPCMode` mode **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`RPCMode` mode **)** | +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`RPCMode` mode **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -219,65 +217,16 @@ Emitted after the node exits the tree and is no longer active. Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization (or a "destructor", if you will). -Member Variables ----------------- - - .. _class_Node_custom_multiplayer: - -- :ref:`MultiplayerAPI` **custom_multiplayer** - The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. - - .. _class_Node_filename: - -- :ref:`String` **filename** - When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. - - .. _class_Node_multiplayer: - -- :ref:`MultiplayerAPI` **multiplayer** - The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). - - .. _class_Node_name: - -- :ref:`String` **name** - The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed - - .. _class_Node_owner: - -- :ref:`Node` **owner** - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene`) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree`\ s, with instancing and subinstancing. - - .. _class_Node_pause_mode: - -- :ref:`PauseMode` **pause_mode** - Pause mode. How the node will behave if the :ref:`SceneTree` is paused. - - -Numeric Constants ------------------ - -- **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree`. -- **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree`. -- **NOTIFICATION_MOVED_IN_PARENT** = **12** --- Notification received when the node is moved in the parent. -- **NOTIFICATION_READY** = **13** --- Notification received when the node is ready. See :ref:`_ready`. -- **NOTIFICATION_PAUSED** = **14** --- Notification received when the node is paused. -- **NOTIFICATION_UNPAUSED** = **15** --- Notification received when the node is unpaused. -- **NOTIFICATION_PHYSICS_PROCESS** = **16** --- Notification received every frame when the physics process flag is set (see :ref:`set_physics_process`). -- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). -- **NOTIFICATION_PARENTED** = **18** --- Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree. -- **NOTIFICATION_UNPARENTED** = **19** --- Notification received when a node is unparented (parent removed it from the list of children). -- **NOTIFICATION_INSTANCED** = **20** --- Notification received when the node is instanced. -- **NOTIFICATION_DRAG_BEGIN** = **21** --- Notification received when a drag begins. -- **NOTIFICATION_DRAG_END** = **22** --- Notification received when a drag ends. -- **NOTIFICATION_PATH_CHANGED** = **23** --- Notification received when the node's :ref:`NodePath` changed. -- **NOTIFICATION_TRANSLATION_CHANGED** = **24** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. -- **NOTIFICATION_INTERNAL_PROCESS** = **25** --- Notification received every frame when the internal process flag is set (see :ref:`set_process_internal`). -- **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). - -Enums ------ +Enumerations +------------ .. _enum_Node_PauseMode: enum **PauseMode** - **PAUSE_MODE_INHERIT** = **0** --- Inherits pause mode from the node's parent. For the root node, it is equivalent to PAUSE_MODE_STOP. Default. -- **PAUSE_MODE_STOP** = **1** --- Stop processing when the :ref:`SceneTree` is paused. -- **PAUSE_MODE_PROCESS** = **2** --- Continue to process regardless of the :ref:`SceneTree` pause state. +- **PAUSE_MODE_STOP** = **1** --- Stop processing when the :ref:`SceneTree` is paused. +- **PAUSE_MODE_PROCESS** = **2** --- Continue to process regardless of the :ref:`SceneTree` pause state. .. _enum_Node_DuplicateFlags: @@ -289,6 +238,27 @@ enum **DuplicateFlags** - **DUPLICATE_USE_INSTANCING** = **8** --- Duplicate using instancing. +Constants +--------- + +- **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree`. +- **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree`. +- **NOTIFICATION_MOVED_IN_PARENT** = **12** --- Notification received when the node is moved in the parent. +- **NOTIFICATION_READY** = **13** --- Notification received when the node is ready. See :ref:`_ready`. +- **NOTIFICATION_PAUSED** = **14** --- Notification received when the node is paused. +- **NOTIFICATION_UNPAUSED** = **15** --- Notification received when the node is unpaused. +- **NOTIFICATION_PHYSICS_PROCESS** = **16** --- Notification received every frame when the physics process flag is set (see :ref:`set_physics_process`). +- **NOTIFICATION_PROCESS** = **17** --- Notification received every frame when the process flag is set (see :ref:`set_process`). +- **NOTIFICATION_PARENTED** = **18** --- Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree. +- **NOTIFICATION_UNPARENTED** = **19** --- Notification received when a node is unparented (parent removed it from the list of children). +- **NOTIFICATION_INSTANCED** = **20** --- Notification received when the node is instanced. +- **NOTIFICATION_DRAG_BEGIN** = **21** --- Notification received when a drag begins. +- **NOTIFICATION_DRAG_END** = **22** --- Notification received when a drag ends. +- **NOTIFICATION_PATH_CHANGED** = **23** --- Notification received when the node's :ref:`NodePath` changed. +- **NOTIFICATION_TRANSLATION_CHANGED** = **24** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. +- **NOTIFICATION_INTERNAL_PROCESS** = **25** --- Notification received every frame when the internal process flag is set (see :ref:`set_process_internal`). +- **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). + Description ----------- @@ -296,7 +266,7 @@ Nodes are Godot's building blocks. They can be assigned as the child of another A tree of nodes is called a *scene*. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. -**Scene tree:** The :ref:`SceneTree` contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its :ref:`_enter_tree` callback is triggered. Child nodes are always added *after* their parent node, i.e. the :ref:`_enter_tree` callback of a parent node will be triggered before its child's. +**Scene tree:** The :ref:`SceneTree` contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its :ref:`_enter_tree` callback is triggered. Child nodes are always added *after* their parent node, i.e. the :ref:`_enter_tree` callback of a parent node will be triggered before its child's. Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective :ref:`_ready` callbacks are triggered. For groups of nodes, the :ref:`_ready` callback is called in reverse order, starting with the children and moving up to the parent nodes. @@ -304,29 +274,57 @@ This means that when adding a node to the scene tree, the following order will b **Processing:** Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback :ref:`_process`, toggled with :ref:`set_process`) happens as fast as possible and is dependent on the frame rate, so the processing time *delta* is passed as an argument. Physics processing (callback :ref:`_physics_process`, toggled with :ref:`set_physics_process`) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine. -Nodes can also process input events. When present, the :ref:`_input` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control` nodes), ensuring that the node only receives the events that were meant for it. +Nodes can also process input events. When present, the :ref:`_input` function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the :ref:`_unhandled_input` function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI :ref:`Control` nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with :ref:`set_owner`. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with :ref:`free` or :ref:`queue_free`, it will also free all its children. -**Groups:** Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See :ref:`add_to_group`, :ref:`is_in_group` and :ref:`remove_from_group`. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on :ref:`SceneTree`. +**Groups:** Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See :ref:`add_to_group`, :ref:`is_in_group` and :ref:`remove_from_group`. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on :ref:`SceneTree`. -**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call Godot will use its :ref:`NodePath` (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. +**Networking with nodes:** After connecting to a server (or making one, see :ref:`NetworkedMultiplayerENet`) it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling :ref:`rpc` with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call Godot will use its :ref:`NodePath` (make sure node names are the same on all peers). Also take a look at the high-level networking tutorial and corresponding demos. Tutorials --------- - :doc:`../getting_started/step_by_step/scenes_and_nodes` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Node_custom_multiplayer: + +- :ref:`MultiplayerAPI` **custom_multiplayer** - The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. + + .. _class_Node_filename: + +- :ref:`String` **filename** - When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. + + .. _class_Node_multiplayer: + +- :ref:`MultiplayerAPI` **multiplayer** - The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). + + .. _class_Node_name: + +- :ref:`String` **name** - The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed + + .. _class_Node_owner: + +- :ref:`Node` **owner** - The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using :ref:`PackedScene`) all the nodes it owns will be saved with it. This allows for the creation of complex :ref:`SceneTree`\ s, with instancing and subinstancing. + + .. _class_Node_pause_mode: + +- :ref:`PauseMode` **pause_mode** - Pause mode. How the node will behave if the :ref:`SceneTree` is paused. + + +Method Descriptions +------------------- .. _class_Node__enter_tree: - void **_enter_tree** **(** **)** virtual -Called when the node enters the :ref:`SceneTree` (e.g. upon instancing, scene changing, or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. +Called when the node enters the :ref:`SceneTree` (e.g. upon instancing, scene changing, or after calling :ref:`add_child` in a script). If the node has children, its :ref:`_enter_tree` callback will be called first, and then that of the children. Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notification`. @@ -334,19 +332,19 @@ Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notific - void **_exit_tree** **(** **)** virtual -Called when the node is about to leave the :ref:`SceneTree` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. +Called when the node is about to leave the :ref:`SceneTree` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child` in a script). If the node has children, its :ref:`_exit_tree` callback will be called last, after all its children have left the tree. Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification` and signal :ref:`tree_exiting`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited` .. _class_Node__get_configuration_warning: -- :ref:`String` **_get_configuration_warning** **(** **)** virtual +- :ref:`String` **_get_configuration_warning** **(** **)** virtual .. _class_Node__input: -- void **_input** **(** :ref:`InputEvent` event **)** virtual +- void **_input** **(** :ref:`InputEvent` event **)** virtual -Called when there is an input event. The input event propagates through the node tree until a node consumes it. +Called when there is an input event. The input event propagates up through the node tree until a node consumes it. It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_input`. @@ -386,9 +384,9 @@ Usually used for initialization. For even earlier initialization, :ref:`Object._ .. _class_Node__unhandled_input: -- void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual +- void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual -Propagated to all nodes when the previous :ref:`InputEvent` is not consumed by any nodes. +Called when an :ref:`InputEvent` hasn't been consumed by :ref:`_input` or any GUI. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_input`. @@ -398,9 +396,9 @@ For gameplay input, this and :ref:`_unhandled_key_input` event **)** virtual +- void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual -Propagated to all nodes when the previous :ref:`InputEventKey` is not consumed by any nodes. +Called when an :ref:`InputEventKey` hasn't been consumed by :ref:`_input` or any GUI. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with :ref:`set_process_unhandled_key_input`. @@ -410,7 +408,7 @@ For gameplay input, this and :ref:`_unhandled_input .. _class_Node_add_child: -- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** +- void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. @@ -418,7 +416,7 @@ Setting "legible_unique_name" ``true`` creates child nodes with human-readable n .. _class_Node_add_child_below_node: -- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** +- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** Adds a child node. The child is placed below the given node in the list of children. @@ -426,9 +424,9 @@ Setting "legible_unique_name" ``true`` creates child nodes with human-readable n .. _class_Node_add_to_group: -- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** +- void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** -Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. +Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. .. _class_Node_can_process: @@ -438,7 +436,7 @@ Returns ``true`` if the node can process while the scene tree is paused (see :re .. _class_Node_duplicate: -- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const +- :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const Duplicates the node, returning a new node. @@ -446,13 +444,13 @@ You can fine-tune the behavior using the ``flags``. See DUPLICATE\_\* constants. .. _class_Node_find_node: -- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const +- :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const Finds a descendant of this node whose name matches ``mask`` as in :ref:`String.match` (i.e. case sensitive, but '\*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. .. _class_Node_get_child: -- :ref:`Node` **get_child** **(** :ref:`int` idx **)** const +- :ref:`Node` **get_child** **(** :ref:`int` idx **)** const Returns a child node by its index (see :ref:`get_child_count`). This method is often used for iterating all children of a node. @@ -464,13 +462,13 @@ Returns the number of child nodes. .. _class_Node_get_children: -- :ref:`Array` **get_children** **(** **)** const +- :ref:`Array` **get_children** **(** **)** const Returns an array of references to node's children. .. _class_Node_get_groups: -- :ref:`Array` **get_groups** **(** **)** const +- :ref:`Array` **get_groups** **(** **)** const Returns an array listing the groups that the node is a member of. @@ -488,9 +486,9 @@ Returns the peer ID of the network master for this node. See :ref:`set_network_m .. _class_Node_get_node: -- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const +- :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const -Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and attempts to access it will result in an "Attempt to call on a null instance." error. +Fetches a node. The :ref:`NodePath` can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a ``null instance`` is returned and attempts to access it will result in an "Attempt to call on a null instance." error. **Note:** Fetching absolute paths only works when the node is inside the scene tree (see :ref:`is_inside_tree`). @@ -518,31 +516,31 @@ Possible paths are: .. _class_Node_get_node_and_resource: -- :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** +- :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** .. _class_Node_get_parent: -- :ref:`Node` **get_parent** **(** **)** const +- :ref:`Node` **get_parent** **(** **)** const Returns the parent node of the current node, or an empty ``Node`` if the node lacks a parent. .. _class_Node_get_path: -- :ref:`NodePath` **get_path** **(** **)** const +- :ref:`NodePath` **get_path** **(** **)** const Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see :ref:`is_inside_tree`). .. _class_Node_get_path_to: -- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const +- :ref:`NodePath` **get_path_to** **(** :ref:`Node` node **)** const -Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same scene or the function will fail. +Returns the relative :ref:`NodePath` from this node to the specified ``node``. Both nodes must be in the same scene or the function will fail. .. _class_Node_get_physics_process_delta_time: - :ref:`float` **get_physics_process_delta_time** **(** **)** const -Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed in :ref:`OS`. +Returns the time elapsed since the last physics-bound frame (see :ref:`_physics_process`). This is always a constant value in physics processing unless the frames per second is changed in :ref:`OS`. .. _class_Node_get_position_in_parent: @@ -560,33 +558,33 @@ Returns the time elapsed (in seconds) since the last process callback. This valu - :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const -Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. +Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. .. _class_Node_get_tree: -- :ref:`SceneTree` **get_tree** **(** **)** const +- :ref:`SceneTree` **get_tree** **(** **)** const -Returns the :ref:`SceneTree` that contains this node. +Returns the :ref:`SceneTree` that contains this node. .. _class_Node_get_viewport: -- :ref:`Viewport` **get_viewport** **(** **)** const +- :ref:`Viewport` **get_viewport** **(** **)** const -Returns the node's :ref:`Viewport`. +Returns the node's :ref:`Viewport`. .. _class_Node_has_node: -- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const -Returns ``true`` if the node that the :ref:`NodePath` points to exists. +Returns ``true`` if the node that the :ref:`NodePath` points to exists. .. _class_Node_has_node_and_resource: -- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const +- :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const .. _class_Node_is_a_parent_of: -- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_a_parent_of** **(** :ref:`Node` node **)** const Returns ``true`` if the given node is a direct or indirect child of the current node. @@ -598,21 +596,21 @@ Returns ``true`` if the node is folded (collapsed) in the Scene dock. .. _class_Node_is_greater_than: -- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const +- :ref:`bool` **is_greater_than** **(** :ref:`Node` node **)** const Returns ``true`` if the given node occurs later in the scene hierarchy than the current node. .. _class_Node_is_in_group: -- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const +- :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const -Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree`. +Returns ``true`` if this node is in the specified group. See notes in the description, and the group methods in :ref:`SceneTree`. .. _class_Node_is_inside_tree: - :ref:`bool` **is_inside_tree** **(** **)** const -Returns ``true`` if this node is currently inside a :ref:`SceneTree`. +Returns ``true`` if this node is currently inside a :ref:`SceneTree`. .. _class_Node_is_network_master: @@ -664,7 +662,7 @@ Returns ``true`` if the node is processing unhandled key input (see :ref:`set_pr .. _class_Node_move_child: -- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** +- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** Moves a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. @@ -672,7 +670,7 @@ Moves a child node to a different position (order) amongst the other children. S - void **print_stray_nodes** **(** **)** -Prints all stray nodes (nodes outside the :ref:`SceneTree`). Used for debugging. Works only in debug builds. +Prints all stray nodes (nodes outside the :ref:`SceneTree`). Used for debugging. Works only in debug builds. .. _class_Node_print_tree: @@ -706,7 +704,7 @@ Similar to :ref:`print_tree`, this prints the tree to std .. _class_Node_propagate_call: -- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** +- void **propagate_call** **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** Calls the given method (if present) with the arguments given in ``args`` on this node and recursively on all its children. If the parent_first argument is ``true`` then the method will be called on the current node first, then on all children. If it is ``false`` then the children will be called first. @@ -726,7 +724,7 @@ Queues a node for deletion at the end of the current frame. When deleted, all of - void **raise** **(** **)** -Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs (:ref:`Control` nodes), because their order of drawing depends on their order in the tree. +Moves this node to the top of the array of nodes of the parent node. This is often useful in GUIs (:ref:`Control` nodes), because their order of drawing depends on their order in the tree. .. _class_Node_remove_and_skip: @@ -736,19 +734,19 @@ Removes a node and sets all its children as children of the parent node (if it e .. _class_Node_remove_child: -- void **remove_child** **(** :ref:`Node` node **)** +- void **remove_child** **(** :ref:`Node` node **)** Removes a child node. The node is NOT deleted and must be deleted manually. .. _class_Node_remove_from_group: -- void **remove_from_group** **(** :ref:`String` group **)** +- void **remove_from_group** **(** :ref:`String` group **)** -Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. +Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. .. _class_Node_replace_by: -- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** +- void **replace_by** **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. @@ -760,61 +758,61 @@ Requests that ``_ready`` be called again. .. _class_Node_rpc: -- :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg -Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config`. Methods are not exposed to RPCs by default. Also see :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree`. You also need to keep track of the connection state, either by the :ref:`SceneTree` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``. +Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config`. Methods are not exposed to RPCs by default. Also see :ref:`rset` and :ref:`rset_config` for properties. Returns an empty :ref:`Variant`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree`. You also need to keep track of the connection state, either by the :ref:`SceneTree` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``. .. _class_Node_rpc_config: -- void **rpc_config** **(** :ref:`String` method, :ref:`RPCMode` mode **)** +- void **rpc_config** **(** :ref:`String` method, :ref:`RPCMode` mode **)** -Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. +Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. .. _class_Node_rpc_id: -- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg -Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. +Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. .. _class_Node_rpc_unreliable: -- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg -Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. +Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. .. _class_Node_rpc_unreliable_id: -- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg +- :ref:`Variant` **rpc_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` method **)** vararg -Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. +Sends a :ref:`rpc` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). Returns an empty :ref:`Variant`. .. _class_Node_rset: -- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see :ref:`rset_config`. Also see :ref:`rpc` for RPCs for methods, most information applies to this method as well. .. _class_Node_rset_config: -- void **rset_config** **(** :ref:`String` property, :ref:`RPCMode` mode **)** +- void **rset_config** **(** :ref:`String` property, :ref:`RPCMode` mode **)** -Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. +Changes the RPC mode for the given ``property`` to the given ``mode``. See :ref:`RPCMode`. An alternative is annotating methods and properties with the corresponding keywords (``remote``, ``sync``, ``master``, ``slave``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. .. _class_Node_rset_id: -- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely changes the property's value on a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). .. _class_Node_rset_unreliable: -- void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable** **(** :ref:`String` property, :ref:`Variant` value **)** Remotely changes the property's value on other peers (and locally) using an unreliable protocol. .. _class_Node_rset_unreliable_id: -- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** +- void **rset_unreliable_id** **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** Remotely changes property's value on a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer`). @@ -834,7 +832,7 @@ Sets the node's network master to the peer with the given peer ID. The network m - void **set_physics_process** **(** :ref:`bool` enable **)** -Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see :ref:`OS` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, see :ref:`OS` to change) interval (and the :ref:`_physics_process` callback will be called if exists). Enabled automatically if :ref:`_physics_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. .. _class_Node_set_physics_process_internal: @@ -868,7 +866,7 @@ Enables or disabled internal processing for this node. Internal processing happe - void **set_process_unhandled_input** **(** :ref:`bool` enable **)** -Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). Enabled automatically if :ref:`_unhandled_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. +Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a :ref:`Control`). Enabled automatically if :ref:`_unhandled_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. .. _class_Node_set_process_unhandled_key_input: @@ -880,6 +878,6 @@ Enables unhandled key input processing. Enabled automatically if :ref:`_unhandle - void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** -Sets whether this is an instance load placeholder. See :ref:`InstancePlaceholder`. +Sets whether this is an instance load placeholder. See :ref:`InstancePlaceholder`. diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 835f8842d..8b00da04b 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -7,10 +7,8 @@ Node2D ====== -**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`Skeleton2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`MeshInstance2D`, :ref:`YSort`, :ref:`TileMap`, :ref:`Bone2D`, :ref:`Camera2D` - +**Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`Skeleton2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CPUParticles2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`MeshInstance2D`, :ref:`YSort`, :ref:`TileMap`, :ref:`Bone2D`, :ref:`Camera2D` **Category:** Core Brief Description @@ -18,19 +16,19 @@ Brief Description A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | +| void | :ref:`apply_scale` **(** :ref:`Vector2` ratio **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | +| :ref:`float` | :ref:`get_angle_to` **(** :ref:`Vector2` point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | +| :ref:`Transform2D` | :ref:`get_relative_transform_to_parent` **(** :ref:`Node` parent **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | +| void | :ref:`global_translate` **(** :ref:`Vector2` offset **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | +| void | :ref:`look_at` **(** :ref:`Vector2` point **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_local_x` **(** :ref:`float` delta, :ref:`bool` scaled=false **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,65 +36,13 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate` **(** :ref:`float` radians **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | +| :ref:`Vector2` | :ref:`to_global` **(** :ref:`Vector2` local_point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | +| :ref:`Vector2` | :ref:`to_local` **(** :ref:`Vector2` global_point **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | +| void | :ref:`translate` **(** :ref:`Vector2` offset **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Node2D_global_position: - -- :ref:`Vector2` **global_position** - Global position. - - .. _class_Node2D_global_rotation: - -- :ref:`float` **global_rotation** - Global rotation in radians. - - .. _class_Node2D_global_rotation_degrees: - -- :ref:`float` **global_rotation_degrees** - Global rotation in degrees. - - .. _class_Node2D_global_scale: - -- :ref:`Vector2` **global_scale** - Global scale. - - .. _class_Node2D_global_transform: - -- :ref:`Transform2D` **global_transform** - Global :ref:`Transform2D`. - - .. _class_Node2D_position: - -- :ref:`Vector2` **position** - Position, relative to the node's parent. - - .. _class_Node2D_rotation: - -- :ref:`float` **rotation** - Rotation in radians, relative to the node's parent. - - .. _class_Node2D_rotation_degrees: - -- :ref:`float` **rotation_degrees** - Rotation in degrees, relative to the node's parent. - - .. _class_Node2D_scale: - -- :ref:`Vector2` **scale** - The node's scale. Unscaled value: ``(1, 1)`` - - .. _class_Node2D_transform: - -- :ref:`Transform2D` **transform** - Local :ref:`Transform2D`. - - .. _class_Node2D_z_as_relative: - -- :ref:`bool` **z_as_relative** - If ``true`` the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. - - .. _class_Node2D_z_index: - -- :ref:`int` **z_index** - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. - - Description ----------- @@ -107,36 +53,88 @@ Tutorials - :doc:`../tutorials/2d/custom_drawing_in_2d` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Node2D_global_position: + +- :ref:`Vector2` **global_position** - Global position. + + .. _class_Node2D_global_rotation: + +- :ref:`float` **global_rotation** - Global rotation in radians. + + .. _class_Node2D_global_rotation_degrees: + +- :ref:`float` **global_rotation_degrees** - Global rotation in degrees. + + .. _class_Node2D_global_scale: + +- :ref:`Vector2` **global_scale** - Global scale. + + .. _class_Node2D_global_transform: + +- :ref:`Transform2D` **global_transform** - Global :ref:`Transform2D`. + + .. _class_Node2D_position: + +- :ref:`Vector2` **position** - Position, relative to the node's parent. + + .. _class_Node2D_rotation: + +- :ref:`float` **rotation** - Rotation in radians, relative to the node's parent. + + .. _class_Node2D_rotation_degrees: + +- :ref:`float` **rotation_degrees** - Rotation in degrees, relative to the node's parent. + + .. _class_Node2D_scale: + +- :ref:`Vector2` **scale** - The node's scale. Unscaled value: ``(1, 1)`` + + .. _class_Node2D_transform: + +- :ref:`Transform2D` **transform** - Local :ref:`Transform2D`. + + .. _class_Node2D_z_as_relative: + +- :ref:`bool` **z_as_relative** - If ``true`` the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. + + .. _class_Node2D_z_index: + +- :ref:`int` **z_index** - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. + + +Method Descriptions +------------------- .. _class_Node2D_apply_scale: -- void **apply_scale** **(** :ref:`Vector2` ratio **)** +- void **apply_scale** **(** :ref:`Vector2` ratio **)** Multiplies the current scale by the 'ratio' vector. .. _class_Node2D_get_angle_to: -- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const +- :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const Returns the angle between the node and the 'point' in radians. .. _class_Node2D_get_relative_transform_to_parent: -- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const +- :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const -Returns the :ref:`Transform2D` relative to this node's parent. +Returns the :ref:`Transform2D` relative to this node's parent. .. _class_Node2D_global_translate: -- void **global_translate** **(** :ref:`Vector2` offset **)** +- void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. .. _class_Node2D_look_at: -- void **look_at** **(** :ref:`Vector2` point **)** +- void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. @@ -160,19 +158,19 @@ Applies a rotation to the node, in radians, starting from its current rotation. .. _class_Node2D_to_global: -- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const +- :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const Converts a local point's coordinates to global coordinates. .. _class_Node2D_to_local: -- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const +- :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const Converts a global point's coordinates to local coordinates. .. _class_Node2D_translate: -- void **translate** **(** :ref:`Vector2` offset **)** +- void **translate** **(** :ref:`Vector2` offset **)** Translates the node by the given ``offset`` in local coordinates. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index b5863e65f..1d388825f 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -14,21 +14,21 @@ Brief Description Pre-parsed scene tree path. -Member Functions ----------------- +Methods +------- +----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | +| :ref:`NodePath` | :ref:`NodePath` **(** :ref:`String` from **)** | +----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** | +| :ref:`NodePath` | :ref:`get_as_property_path` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_concatenated_subnames` **(** **)** | +| :ref:`String` | :ref:`get_concatenated_subnames` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | +| :ref:`String` | :ref:`get_name` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_name_count` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | +| :ref:`String` | :ref:`get_subname` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_subname_count` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------+ @@ -46,26 +46,26 @@ You will usually just pass a string to :ref:`Node.get_node` A ``NodePath`` is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_NodePath_NodePath: -- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** +- :ref:`NodePath` **NodePath** **(** :ref:`String` from **)** Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, ``"."`` and ``".."`` indicate the current node and its parent. .. _class_NodePath_get_as_property_path: -- :ref:`NodePath` **get_as_property_path** **(** **)** +- :ref:`NodePath` **get_as_property_path** **(** **)** .. _class_NodePath_get_concatenated_subnames: -- :ref:`String` **get_concatenated_subnames** **(** **)** +- :ref:`String` **get_concatenated_subnames** **(** **)** .. _class_NodePath_get_name: -- :ref:`String` **get_name** **(** :ref:`int` idx **)** +- :ref:`String` **get_name** **(** :ref:`int` idx **)** Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) @@ -77,7 +77,7 @@ Get the number of node names which make up the path. .. _class_NodePath_get_subname: -- :ref:`String` **get_subname** **(** :ref:`int` idx **)** +- :ref:`String` **get_subname** **(** :ref:`int` idx **)** Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) diff --git a/classes/class_object.rst b/classes/class_object.rst index 11179f18d..217332b38 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -7,8 +7,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`ProjectSettings`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` - +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`JavaScript`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`ProjectSettings`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`GodotSharp`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`VisualScriptEditor`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core Brief Description @@ -16,73 +15,73 @@ Brief Description Base class for all non built-in types. -Member Functions ----------------- +Methods +------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | +| :ref:`Variant` | :ref:`_get` **(** :ref:`String` property **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_init` **(** **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_notification` **(** :ref:`int` what **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | +| :ref:`bool` | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | +| :ref:`Error` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | +| :ref:`Variant` | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`free` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | +| :ref:`String` | :ref:`get_class` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | +| :ref:`Variant` | :ref:`get_indexed` **(** :ref:`NodePath` property **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_instance_id` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Reference` | :ref:`get_script` **(** **)** const | +| :ref:`Reference` | :ref:`get_script` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,19 +89,19 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`property_list_changed_notify` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | +| void | :ref:`set_indexed` **(** :ref:`NodePath` property, :ref:`Variant` value **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Reference` script **)** | +| void | :ref:`set_script` **(** :ref:`Reference` script **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | +| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -115,14 +114,8 @@ Signals Emitted whenever the script of the Object is changed. -Numeric Constants ------------------ - -- **NOTIFICATION_POSTINITIALIZE** = **0** --- Called right when the object is initialized. Not available in script. -- **NOTIFICATION_PREDELETE** = **1** --- Called before the object is about to be deleted. - -Enums ------ +Enumerations +------------ .. _enum_Object_ConnectFlags: @@ -134,6 +127,12 @@ enum **ConnectFlags** - **CONNECT_REFERENCE_COUNTED** = **8** +Constants +--------- + +- **NOTIFICATION_POSTINITIALIZE** = **0** --- Called right when the object is initialized. Not available in script. +- **NOTIFICATION_PREDELETE** = **1** --- Called before the object is about to be deleted. + Description ----------- @@ -141,26 +140,26 @@ Base class for all non built-in types. Everything not a built-in type starts the Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). -Some derivatives add memory management, such as :ref:`Reference` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node`, which deletes the children tree when deleted. +Some derivatives add memory management, such as :ref:`Reference` (which keeps a reference count and deletes itself automatically when no longer referenced) and :ref:`Node`, which deletes the children tree when deleted. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in :ref:`_get_property_list` and handled in :ref:`_get` and :ref:`_set`. However, scripting languages and C++ have simpler means to export them. Objects also receive notifications (:ref:`_notification`). Notifications are a simple way to notify the object about simple events, so they can all be handled together. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Object__get: -- :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual +- :ref:`Variant` **_get** **(** :ref:`String` property **)** virtual Returns the given property. Returns ``null`` if the ``property`` does not exist. .. _class_Object__get_property_list: -- :ref:`Array` **_get_property_list** **(** **)** virtual +- :ref:`Array` **_get_property_list** **(** **)** virtual -Returns the object's property list as an :ref:`Array` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). +Returns the object's property list as an :ref:`Array` of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). .. _class_Object__init: @@ -176,33 +175,33 @@ Notify the object internally using an ID. .. _class_Object__set: -- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual +- :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual Sets a property. Returns ``true`` if the ``property`` exists. .. _class_Object_add_user_signal: -- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** +- void **add_user_signal** **(** :ref:`String` signal, :ref:`Array` arguments=[ ] **)** -Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing "name" and "type" (from :ref:`@GlobalScope` TYPE\_\*). +Adds a user-defined ``signal``. Arguments are optional, but can be added as an :ref:`Array` of dictionaries, each containing "name" and "type" (from :ref:`@GlobalScope` TYPE\_\*). .. _class_Object_call: -- :ref:`Variant` **call** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **call** **(** :ref:`String` method **)** vararg Calls the ``method`` on the object and returns a result. Pass parameters as a comma separated list. .. _class_Object_call_deferred: -- :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg +- :ref:`Variant` **call_deferred** **(** :ref:`String` method **)** vararg Calls the ``method`` on the object during idle time and returns a result. Pass parameters as a comma separated list. .. _class_Object_callv: -- :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** +- :ref:`Variant` **callv** **(** :ref:`String` method, :ref:`Array` arg_array **)** -Calls the ``method`` on the object and returns a result. Pass parameters as an :ref:`Array`. +Calls the ``method`` on the object and returns a result. Pass parameters as an :ref:`Array`. .. _class_Object_can_translate_messages: @@ -212,19 +211,19 @@ Returns ``true`` if the object can translate strings. .. _class_Object_connect: -- :ref:`Error` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** +- :ref:`Error` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[ ], :ref:`int` flags=0 **)** Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call. Use ``flags`` to set deferred or one shot connections. See ``CONNECT_*`` constants. A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected. To avoid this, first use :ref:`is_connected` to check for existing connections. .. _class_Object_disconnect: -- void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** +- void **disconnect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** Disconnects a ``signal`` from a ``method`` on the given ``target``. .. _class_Object_emit_signal: -- :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg +- :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg Emits the given ``signal``. @@ -236,23 +235,23 @@ Deletes the object from memory. .. _class_Object_get: -- :ref:`Variant` **get** **(** :ref:`String` property **)** const +- :ref:`Variant` **get** **(** :ref:`String` property **)** const -Returns a :ref:`Variant` for a ``property``. +Returns a :ref:`Variant` for a ``property``. .. _class_Object_get_class: -- :ref:`String` **get_class** **(** **)** const +- :ref:`String` **get_class** **(** **)** const -Returns the object's class as a :ref:`String`. +Returns the object's class as a :ref:`String`. .. _class_Object_get_incoming_connections: -- :ref:`Array` **get_incoming_connections** **(** **)** const +- :ref:`Array` **get_incoming_connections** **(** **)** const -Returns an :ref:`Array` of dictionaries with information about signals that are connected to the object. +Returns an :ref:`Array` of dictionaries with information about signals that are connected to the object. -Inside each :ref:`Dictionary` there are 3 fields: +Inside each :ref:`Dictionary` there are 3 fields: - "source" is a reference to signal emitter. @@ -262,7 +261,7 @@ Inside each :ref:`Dictionary` there are 3 fields: .. _class_Object_get_indexed: -- :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const +- :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const Get indexed object property by String. @@ -276,61 +275,61 @@ Returns the object's unique instance ID. .. _class_Object_get_meta: -- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Returns the object's metadata for the given ``name``. .. _class_Object_get_meta_list: -- :ref:`PoolStringArray` **get_meta_list** **(** **)** const +- :ref:`PoolStringArray` **get_meta_list** **(** **)** const -Returns the object's metadata as a :ref:`PoolStringArray`. +Returns the object's metadata as a :ref:`PoolStringArray`. .. _class_Object_get_method_list: -- :ref:`Array` **get_method_list** **(** **)** const +- :ref:`Array` **get_method_list** **(** **)** const -Returns the object's methods and their signatures as an :ref:`Array`. +Returns the object's methods and their signatures as an :ref:`Array`. .. _class_Object_get_property_list: -- :ref:`Array` **get_property_list** **(** **)** const +- :ref:`Array` **get_property_list** **(** **)** const -Returns the list of properties as an :ref:`Array` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). +Returns the list of properties as an :ref:`Array` of dictionaries. Dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@GlobalScope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@GlobalScope`). .. _class_Object_get_script: -- :ref:`Reference` **get_script** **(** **)** const +- :ref:`Reference` **get_script** **(** **)** const -Returns the object's :ref:`Script` or ``null`` if one doesn't exist. +Returns the object's :ref:`Script` or ``null`` if one doesn't exist. .. _class_Object_get_signal_connection_list: -- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const +- :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const -Returns an :ref:`Array` of connections for the given ``signal``. +Returns an :ref:`Array` of connections for the given ``signal``. .. _class_Object_get_signal_list: -- :ref:`Array` **get_signal_list** **(** **)** const +- :ref:`Array` **get_signal_list** **(** **)** const -Returns the list of signals as an :ref:`Array` of dictionaries. +Returns the list of signals as an :ref:`Array` of dictionaries. .. _class_Object_has_meta: -- :ref:`bool` **has_meta** **(** :ref:`String` name **)** const +- :ref:`bool` **has_meta** **(** :ref:`String` name **)** const Returns ``true`` if a metadata is found with the given ``name``. .. _class_Object_has_method: -- :ref:`bool` **has_method** **(** :ref:`String` method **)** const +- :ref:`bool` **has_method** **(** :ref:`String` method **)** const Returns ``true`` if the object contains the given ``method``. .. _class_Object_has_user_signal: -- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const +- :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const Returns ``true`` if the given user-defined ``signal`` exists. @@ -342,13 +341,13 @@ Returns ``true`` if signal emission blocking is enabled. .. _class_Object_is_class: -- :ref:`bool` **is_class** **(** :ref:`String` type **)** const +- :ref:`bool` **is_class** **(** :ref:`String` type **)** const Returns ``true`` if the object inherits from the given ``type``. .. _class_Object_is_connected: -- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const +- :ref:`bool` **is_connected** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const Returns ``true`` if a connection exists for a given ``signal``, ``target``, and ``method``. @@ -370,7 +369,7 @@ Notify the object of something. .. _class_Object_set: -- void **set** **(** :ref:`String` property, :ref:`Variant` value **)** +- void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Set property into the object. @@ -382,7 +381,7 @@ If set to true, signal emission is blocked. .. _class_Object_set_indexed: -- void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** +- void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** .. _class_Object_set_message_translation: @@ -392,19 +391,19 @@ Define whether the object can translate strings (with calls to :ref:`tr` name, :ref:`Variant` value **)** +- void **set_meta** **(** :ref:`String` name, :ref:`Variant` value **)** Set a metadata into the object. Metadata is serialized. Metadata can be *anything*. .. _class_Object_set_script: -- void **set_script** **(** :ref:`Reference` script **)** +- void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. .. _class_Object_tr: -- :ref:`String` **tr** **(** :ref:`String` message **)** const +- :ref:`String` **tr** **(** :ref:`String` message **)** const Translate a message. Only works if message translation is enabled (which it is by default). See :ref:`set_message_translation`. diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 72dcfa8e6..9004e9723 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -7,8 +7,7 @@ OccluderPolygon2D ================= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,8 @@ Brief Description Defines a 2D polygon for LightOccluder2D. -Member Variables ----------------- - - .. _class_OccluderPolygon2D_closed: - -- :ref:`bool` **closed** - If ``true`` closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``. - - .. _class_OccluderPolygon2D_cull_mode: - -- :ref:`CullMode` **cull_mode** - Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. - - .. _class_OccluderPolygon2D_polygon: - -- :ref:`PoolVector2Array` **polygon** - A :ref:`Vector2` array with the index for polygon's vertices positions. - - -Enums ------ +Enumerations +------------ .. _enum_OccluderPolygon2D_CullMode: @@ -47,5 +30,21 @@ enum **CullMode** Description ----------- -Editor facility that helps you draw a 2D polygon used as resource for :ref:`LightOccluder2D`. +Editor facility that helps you draw a 2D polygon used as resource for :ref:`LightOccluder2D`. + +Property Descriptions +--------------------- + + .. _class_OccluderPolygon2D_closed: + +- :ref:`bool` **closed** - If ``true`` closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``. + + .. _class_OccluderPolygon2D_cull_mode: + +- :ref:`CullMode` **cull_mode** - Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. + + .. _class_OccluderPolygon2D_polygon: + +- :ref:`PoolVector2Array` **polygon** - A :ref:`Vector2` array with the index for polygon's vertices positions. + diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 58a29835a..6aae95610 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -7,8 +7,7 @@ OmniLight ========= -**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,28 +15,8 @@ Brief Description Omnidirectional light, such as a light bulb or a candle. -Member Variables ----------------- - - .. _class_OmniLight_omni_attenuation: - -- :ref:`float` **omni_attenuation** - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. - - .. _class_OmniLight_omni_range: - -- :ref:`float` **omni_range** - Maximum distance the light affects. - - .. _class_OmniLight_omni_shadow_detail: - -- :ref:`ShadowDetail` **omni_shadow_detail** - See :ref:`ShadowDetail`. - - .. _class_OmniLight_omni_shadow_mode: - -- :ref:`ShadowMode` **omni_shadow_mode** - See :ref:`ShadowMode`. - - -Enums ------ +Enumerations +------------ .. _enum_OmniLight_ShadowDetail: @@ -57,10 +36,30 @@ enum **ShadowMode** Description ----------- -An Omnidirectional light is a type of :ref:`Light` that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. +An Omnidirectional light is a type of :ref:`Light` that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` +Property Descriptions +--------------------- + + .. _class_OmniLight_omni_attenuation: + +- :ref:`float` **omni_attenuation** - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. + + .. _class_OmniLight_omni_range: + +- :ref:`float` **omni_range** - Maximum distance the light affects. + + .. _class_OmniLight_omni_shadow_detail: + +- :ref:`ShadowDetail` **omni_shadow_detail** - See :ref:`ShadowDetail`. + + .. _class_OmniLight_omni_shadow_mode: + +- :ref:`ShadowMode` **omni_shadow_mode** - See :ref:`ShadowMode`. + + diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index eb1fff746..289f6f43b 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -7,8 +7,7 @@ OptionButton ============ -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Button control that provides selectable options when pressed. -Member Functions ----------------- +Methods +------- +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1 **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_separator` **(** **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,19 +29,19 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_popup` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_id` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -52,13 +51,13 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` texture **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -77,31 +76,31 @@ This signal is emitted when user navigated to an item using ``ui_up`` or ``ui_do This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). -Member Variables ----------------- +Description +----------- + +OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. + +Property Descriptions +--------------------- .. _class_OptionButton_selected: - :ref:`int` **selected** -Description ------------ - -OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_OptionButton_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. .. _class_OptionButton_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1 **)** Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. @@ -125,7 +124,7 @@ Return the amount of items in the OptionButton. .. _class_OptionButton_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". @@ -137,19 +136,19 @@ Return the ID of the item at index "idx". .. _class_OptionButton_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_OptionButton_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". .. _class_OptionButton_get_popup: -- :ref:`PopupMenu` **get_popup** **(** **)** const +- :ref:`PopupMenu` **get_popup** **(** **)** const -Return the :ref:`PopupMenu` contained in this button. +Return the :ref:`PopupMenu` contained in this button. .. _class_OptionButton_get_selected_id: @@ -157,7 +156,7 @@ Return the :ref:`PopupMenu` contained in this button. .. _class_OptionButton_get_selected_metadata: -- :ref:`Variant` **get_selected_metadata** **(** **)** const +- :ref:`Variant` **get_selected_metadata** **(** **)** const .. _class_OptionButton_is_item_disabled: @@ -179,7 +178,7 @@ Select an item by index and make it the current item. .. _class_OptionButton_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". @@ -191,11 +190,11 @@ Set the ID of an item at index "idx". .. _class_OptionButton_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** .. _class_OptionButton_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of an item at index "idx". diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index d18b3a0c8..00a46923a 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -7,23 +7,29 @@ OrientedPathFollow ================== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Oriented point sampler for a :ref:`Path`. +Oriented point sampler for a :ref:`Path`. -Member Variables ----------------- +Description +----------- + +This node behaves like :ref:`PathFollow`, except it uses its parent :ref:`Path` up vector information to enforce orientation. + +Make sure to check if the curve of this node's parent :ref:`Path` has up vectors enabled. See :ref:`PathFollow` and :ref:`Curve3D` for further information. + +Property Descriptions +--------------------- .. _class_OrientedPathFollow_cubic_interp: - :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. -The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. +The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. @@ -48,10 +54,3 @@ There are two answers to this problem: Either increase the number of cached poin - :ref:`float` **v_offset** - The node's offset perpendicular to the curve. -Description ------------ - -This node behaves like :ref:`PathFollow`, except it uses its parent :ref:`Path` up vector information to enforce orientation. - -Make sure to check if the curve of this node's parent :ref:`Path` has up vectors enabled. See :ref:`PathFollow` and :ref:`Curve3D` for further information. - diff --git a/classes/class_os.rst b/classes/class_os.rst index 483517c08..7d876c646 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -7,8 +7,7 @@ OS == -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description Operating System functions. -Member Functions ----------------- +Methods +------- +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | +| void | :ref:`alert` **(** :ref:`String` text, :ref:`String` title="Alert!" **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_draw` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,67 +27,69 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_window` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close_midi_inputs` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`delay_msec` **(** :ref:`int` msec **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`delay_usec` **(** :ref:`int` usec **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | +| void | :ref:`dump_memory_to_file` **(** :ref:`String` file **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | +| void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +| :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_audio_driver_count` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | +| :ref:`String` | :ref:`get_audio_driver_name` **(** :ref:`int` driver **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | +| :ref:`PoolStringArray` | :ref:`get_cmdline_args` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | +| :ref:`PoolStringArray` | :ref:`get_connected_midi_inputs` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_date` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_datetime` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | +| :ref:`Dictionary` | :ref:`get_datetime_from_unix_time` **(** :ref:`int` unix_time_val **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_dynamic_memory_usage` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | +| :ref:`String` | :ref:`get_environment` **(** :ref:`String` environment **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_executable_path` **(** **)** const | +| :ref:`String` | :ref:`get_executable_path` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | +| :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | +| :ref:`String` | :ref:`get_locale` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_model_name` **(** **)** const | +| :ref:`String` | :ref:`get_model_name` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | +| :ref:`String` | :ref:`get_name` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_power_percent_left` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_power_seconds_left` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | +| :ref:`PowerState` | :ref:`get_power_state` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_process_id` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_processor_count` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_real_window_size` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | +| :ref:`String` | :ref:`get_scancode_string` **(** :ref:`int` code **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_screen_count` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_screen_dpi` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | +| :ref:`Vector2` | :ref:`get_screen_position` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | +| :ref:`Vector2` | :ref:`get_screen_size` **(** :ref:`int` screen=-1 **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_splash_tick_msec` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,7 +97,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_static_memory_usage` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | +| :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,29 +105,29 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_ticks_usec` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | +| :ref:`Dictionary` | :ref:`get_time` **(** :ref:`bool` utc=false **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_time_zone_info` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_unique_id` **(** **)** const | +| :ref:`String` | :ref:`get_unique_id` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unix_time` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | +| :ref:`int` | :ref:`get_unix_time_from_datetime` **(** :ref:`Dictionary` datetime **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | +| :ref:`String` | :ref:`get_user_data_dir` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_video_driver_count` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`int` driver **)** const | +| :ref:`String` | :ref:`get_video_driver_name` **(** :ref:`int` driver **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_virtual_keyboard_height` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | +| :ref:`Rect2` | :ref:`get_window_safe_area` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | +| :ref:`bool` | :ref:`has_environment` **(** :ref:`String` environment **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | +| :ref:`bool` | :ref:`has_feature` **(** :ref:`String` tag_name **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_touchscreen_ui_hint` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,111 +147,49 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_window_always_on_top` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | +| :ref:`Error` | :ref:`kill` **(** :ref:`int` pid **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`native_video_is_playing` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`native_video_pause` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | +| :ref:`Error` | :ref:`native_video_play` **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`native_video_stop` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`native_video_unpause` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | +| void | :ref:`open_midi_inputs` **(** **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_all_resources` **(** :ref:`String` tofile="" **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_all_textures_by_size` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | +| void | :ref:`print_resources_by_type` **(** :ref:`PoolStringArray` types **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_resources_in_use` **(** :ref:`bool` short=false **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`request_attention` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | +| void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | +| :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_file_access_save_and_swap` **(** :ref:`bool` enabled **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_window_always_on_top` **(** :ref:`bool` enabled **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_window_title` **(** :ref:`String` title **)** | +| void | :ref:`set_window_title` **(** :ref:`String` title **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | +| :ref:`Error` | :ref:`shell_open` **(** :ref:`String` uri **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | +| void | :ref:`show_virtual_keyboard` **(** :ref:`String` existing_text="" **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_OS_clipboard: - -- :ref:`String` **clipboard** - The clipboard from the host OS. Might be unavailable on some platforms. - - .. _class_OS_current_screen: - -- :ref:`int` **current_screen** - The current screen index (starting from 0). - - .. _class_OS_exit_code: - -- :ref:`int` **exit_code** - The exit code passed to the OS when the main loop exits. - - .. _class_OS_keep_screen_on: - -- :ref:`bool` **keep_screen_on** - If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. - - .. _class_OS_low_processor_usage_mode: - -- :ref:`bool` **low_processor_usage_mode** - If ``true`` the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. - - .. _class_OS_screen_orientation: - -- _OS.ScreenOrientation **screen_orientation** - The current screen orientation. - - .. _class_OS_vsync_enabled: - -- :ref:`bool` **vsync_enabled** - If ``true`` vertical synchronization (Vsync) is enabled. - - .. _class_OS_window_borderless: - -- :ref:`bool` **window_borderless** - If ``true`` removes the window frame. - - .. _class_OS_window_fullscreen: - -- :ref:`bool` **window_fullscreen** - If ``true`` the window is fullscreen. - - .. _class_OS_window_maximized: - -- :ref:`bool` **window_maximized** - If ``true`` the window is maximized. - - .. _class_OS_window_minimized: - -- :ref:`bool` **window_minimized** - If ``true`` the window is minimized. - - .. _class_OS_window_per_pixel_transparency_enabled: - -- :ref:`bool` **window_per_pixel_transparency_enabled** - - .. _class_OS_window_position: - -- :ref:`Vector2` **window_position** - The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. - - .. _class_OS_window_resizable: - -- :ref:`bool` **window_resizable** - If ``true``, the window is resizable by the user. - - .. _class_OS_window_size: - -- :ref:`Vector2` **window_size** - The size of the window (without counting window manager decorations). - - -Enums ------ +Enumerations +------------ .. _enum_OS_SystemDir: @@ -322,12 +261,76 @@ Description Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: mouse grabbing, mouse cursors, clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_OS_clipboard: + +- :ref:`String` **clipboard** - The clipboard from the host OS. Might be unavailable on some platforms. + + .. _class_OS_current_screen: + +- :ref:`int` **current_screen** - The current screen index (starting from 0). + + .. _class_OS_exit_code: + +- :ref:`int` **exit_code** - The exit code passed to the OS when the main loop exits. + + .. _class_OS_keep_screen_on: + +- :ref:`bool` **keep_screen_on** - If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. + + .. _class_OS_low_processor_usage_mode: + +- :ref:`bool` **low_processor_usage_mode** - If ``true`` the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. + + .. _class_OS_screen_orientation: + +- _OS.ScreenOrientation **screen_orientation** - The current screen orientation. + + .. _class_OS_vsync_enabled: + +- :ref:`bool` **vsync_enabled** - If ``true`` vertical synchronization (Vsync) is enabled. + + .. _class_OS_window_borderless: + +- :ref:`bool` **window_borderless** - If ``true`` removes the window frame. + + .. _class_OS_window_fullscreen: + +- :ref:`bool` **window_fullscreen** - If ``true`` the window is fullscreen. + + .. _class_OS_window_maximized: + +- :ref:`bool` **window_maximized** - If ``true`` the window is maximized. + + .. _class_OS_window_minimized: + +- :ref:`bool` **window_minimized** - If ``true`` the window is minimized. + + .. _class_OS_window_per_pixel_transparency_enabled: + +- :ref:`bool` **window_per_pixel_transparency_enabled** + + .. _class_OS_window_position: + +- :ref:`Vector2` **window_position** - The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. + + .. _class_OS_window_resizable: + +- :ref:`bool` **window_resizable** - If ``true``, the window is resizable by the user. + + .. _class_OS_window_size: + +- :ref:`Vector2` **window_size** - The size of the window (without counting window manager decorations). + + +Method Descriptions +------------------- .. _class_OS_alert: -- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** +- void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** Displays a modal dialog box utilizing the host OS. @@ -349,6 +352,10 @@ Returns ``true`` if the current host platform is using multiple threads. Centers the window on the screen if in windowed mode. +.. _class_OS_close_midi_inputs: + +- void **close_midi_inputs** **(** **)** + .. _class_OS_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const @@ -363,7 +370,7 @@ Delay execution of the current thread by given microseconds. .. _class_OS_dump_memory_to_file: -- void **dump_memory_to_file** **(** :ref:`String` file **)** +- void **dump_memory_to_file** **(** :ref:`String` file **)** Dumps the memory allocation ringlist to a file (only works in debug). @@ -371,7 +378,7 @@ Entry format per line: "Address - Size - Description". .. _class_OS_dump_resources_to_file: -- void **dump_resources_to_file** **(** :ref:`String` file **)** +- void **dump_resources_to_file** **(** :ref:`String` file **)** Dumps all used resources to file (only works in debug). @@ -381,7 +388,7 @@ At the end of the file is a statistic of all used Resource Types. .. _class_OS_execute: -- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. @@ -416,7 +423,7 @@ If you wish to access a shell built-in or perform a composite command, a platfor .. _class_OS_find_scancode_from_string: -- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const +- :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const Returns the scancode of the given string (e.g. "Escape") @@ -428,35 +435,35 @@ Returns the total number of available audio drivers. .. _class_OS_get_audio_driver_name: -- :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const +- :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const Returns the audio driver name for the given index. .. _class_OS_get_cmdline_args: -- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** +- :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. .. _class_OS_get_connected_midi_inputs: -- :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** +- :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** .. _class_OS_get_date: -- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_date** **(** :ref:`bool` utc=false **)** const Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). .. _class_OS_get_datetime: -- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_datetime** **(** :ref:`bool` utc=false **)** const Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. .. _class_OS_get_datetime_from_unix_time: -- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const +- :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const Get a dictionary of time values when given epoch time. @@ -470,19 +477,19 @@ Returns the total amount of dynamic memory used (only works in debug). .. _class_OS_get_environment: -- :ref:`String` **get_environment** **(** :ref:`String` environment **)** const +- :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. .. _class_OS_get_executable_path: -- :ref:`String` **get_executable_path** **(** **)** const +- :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. .. _class_OS_get_latin_keyboard_variant: -- :ref:`String` **get_latin_keyboard_variant** **(** **)** const +- :ref:`String` **get_latin_keyboard_variant** **(** **)** const Returns the current latin keyboard variant as a String. @@ -490,19 +497,19 @@ Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLE .. _class_OS_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. .. _class_OS_get_model_name: -- :ref:`String` **get_model_name** **(** **)** const +- :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. .. _class_OS_get_name: -- :ref:`String` **get_name** **(** **)** const +- :ref:`String` **get_name** **(** **)** const Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". @@ -520,7 +527,7 @@ Returns the time in seconds before the device runs out of battery. .. _class_OS_get_power_state: -- :ref:`PowerState` **get_power_state** **(** **)** +- :ref:`PowerState` **get_power_state** **(** **)** Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants. @@ -538,13 +545,13 @@ Returns the number of cores available in the host machine. .. _class_OS_get_real_window_size: -- :ref:`Vector2` **get_real_window_size** **(** **)** const +- :ref:`Vector2` **get_real_window_size** **(** **)** const Returns the window size including decorations like window borders. .. _class_OS_get_scancode_string: -- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const +- :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). @@ -576,13 +583,13 @@ xxxhdpi - 640 dpi .. _class_OS_get_screen_position: -- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_position** **(** :ref:`int` screen=-1 **)** const Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used. .. _class_OS_get_screen_size: -- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const +- :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. @@ -604,7 +611,7 @@ Returns the amount of static memory being used by the program in bytes. .. _class_OS_get_system_dir: -- :ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir **)** const +- :ref:`String` **get_system_dir** **(** :ref:`SystemDir` dir **)** const Returns the actual path to commonly used folders across different platforms. Available locations are specified in OS.SystemDir. @@ -628,19 +635,19 @@ Returns the amount of time passed in microseconds since the engine started. .. _class_OS_get_time: -- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const +- :ref:`Dictionary` **get_time** **(** :ref:`bool` utc=false **)** const Returns current time as a dictionary of keys: hour, minute, second. .. _class_OS_get_time_zone_info: -- :ref:`Dictionary` **get_time_zone_info** **(** **)** const +- :ref:`Dictionary` **get_time_zone_info** **(** **)** const Returns the current time zone as a dictionary with the keys: bias and name. .. _class_OS_get_unique_id: -- :ref:`String` **get_unique_id** **(** **)** const +- :ref:`String` **get_unique_id** **(** **)** const Returns a string that is unique to the device. @@ -654,7 +661,7 @@ Returns the current unix epoch timestamp. .. _class_OS_get_unix_time_from_datetime: -- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const +- :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const Get an epoch time value from a dictionary of time values. @@ -664,7 +671,7 @@ You can pass the output from :ref:`get_datetime_from_unix_time` **get_user_data_dir** **(** **)** const +- :ref:`String` **get_user_data_dir** **(** **)** const Returns the absolute directory path where user data is written (``user://``). @@ -682,7 +689,7 @@ If the project name is empty, ``user://`` falls back to ``res://``. .. _class_OS_get_video_driver_name: -- :ref:`String` **get_video_driver_name** **(** :ref:`int` driver **)** const +- :ref:`String` **get_video_driver_name** **(** :ref:`int` driver **)** const .. _class_OS_get_virtual_keyboard_height: @@ -692,17 +699,17 @@ Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyb .. _class_OS_get_window_safe_area: -- :ref:`Rect2` **get_window_safe_area** **(** **)** const +- :ref:`Rect2` **get_window_safe_area** **(** **)** const .. _class_OS_has_environment: -- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const +- :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. .. _class_OS_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const +- :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** const Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. See feature tags documentation. @@ -766,7 +773,7 @@ Returns ``true`` if the window should always be on top of other windows. .. _class_OS_kill: -- :ref:`Error` **kill** **(** :ref:`int` pid **)** +- :ref:`Error` **kill** **(** :ref:`int` pid **)** Kill (terminate) the process identified by the given process ID (``pid``), e.g. the one returned by :ref:`execute` in non-blocking mode. @@ -786,7 +793,7 @@ Pauses native video playback. .. _class_OS_native_video_play: -- :ref:`Error` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** +- :ref:`Error` **native_video_play** **(** :ref:`String` path, :ref:`float` volume, :ref:`String` audio_track, :ref:`String` subtitle_track **)** Plays native video from the specified path, at the given volume and with audio and subtitle tracks. @@ -802,9 +809,13 @@ Stops native video playback. Resumes native video playback. +.. _class_OS_open_midi_inputs: + +- void **open_midi_inputs** **(** **)** + .. _class_OS_print_all_resources: -- void **print_all_resources** **(** :ref:`String` tofile="" **)** +- void **print_all_resources** **(** :ref:`String` tofile="" **)** Shows all resources in the game. Optionally the list can be written to a file. @@ -816,7 +827,7 @@ Shows the list of loaded textures sorted by size in memory. .. _class_OS_print_resources_by_type: -- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** +- void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** Shows the number of resources loaded by the game of the given types. @@ -834,17 +845,17 @@ Request the user attention to the window. It'll flash the taskbar button on Wind .. _class_OS_set_icon: -- void **set_icon** **(** :ref:`Image` icon **)** +- void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. .. _class_OS_set_ime_position: -- void **set_ime_position** **(** :ref:`Vector2` position **)** +- void **set_ime_position** **(** :ref:`Vector2` position **)** .. _class_OS_set_thread_name: -- :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** +- :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** Sets the name of the current thread. @@ -862,13 +873,13 @@ Sets whether the window should always be on top. .. _class_OS_set_window_title: -- void **set_window_title** **(** :ref:`String` title **)** +- void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. .. _class_OS_shell_open: -- :ref:`Error` **shell_open** **(** :ref:`String` uri **)** +- :ref:`Error` **shell_open** **(** :ref:`String` uri **)** Requests the OS to open a resource with the most appropriate program. For example. @@ -878,7 +889,7 @@ Requests the OS to open a resource with the most appropriate program. For exampl .. _class_OS_show_virtual_keyboard: -- void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** +- void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** Shows the virtual keyboard if the platform has one. The *existing_text* parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 15346b4bd..25eadcbd6 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -7,8 +7,7 @@ PackedDataContainer =================== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,29 +15,29 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | +| :ref:`Error` | :ref:`pack` **(** :ref:`Variant` value **)** | +----------------------------------------+---------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_PackedDataContainer___data__: -- :ref:`PoolByteArray` **__data__** +- :ref:`PoolByteArray` **__data__** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PackedDataContainer_pack: -- :ref:`Error` **pack** **(** :ref:`Variant` value **)** +- :ref:`Error` **pack** **(** :ref:`Variant` value **)** .. _class_PackedDataContainer_size: diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 9a2560a74..54b69ee45 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -7,8 +7,7 @@ PackedDataContainerRef ====================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------+------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** const | +------------------------+------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PackedDataContainerRef_size: diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 22b2aff25..9cdf93f18 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -7,8 +7,7 @@ PackedScene =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,21 @@ Brief Description An abstraction of a serialized scene. -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_instance` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneState` | :ref:`get_state` **(** **)** | +| :ref:`SceneState` | :ref:`get_state` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`instance` **(** :ref:`GenEditState` edit_state=0 **)** const | +| :ref:`Node` | :ref:`instance` **(** :ref:`GenEditState` edit_state=0 **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | +| :ref:`Error` | :ref:`pack` **(** :ref:`Node` path **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_PackedScene__bundled: - -- :ref:`Dictionary` **_bundled** - A dictionary representation of the scene contents. - -Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. - - -Enums ------ +Enumerations +------------ .. _enum_PackedScene_GenEditState: @@ -56,7 +45,7 @@ Description A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. -Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see ``owner`` property on :ref:`Node`). Note that the node doesn't need to own itself. +Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see ``owner`` property on :ref:`Node`). Note that the node doesn't need to own itself. Example of saving a node: @@ -67,8 +56,18 @@ Example of saving a node: if result == OK: ResourceSaver.save("res://path/name.scn", scene) // or user://... -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_PackedScene__bundled: + +- :ref:`Dictionary` **_bundled** - A dictionary representation of the scene contents. + +Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene. + + +Method Descriptions +------------------- .. _class_PackedScene_can_instance: @@ -78,19 +77,19 @@ Returns ``true`` if the scene file has nodes. .. _class_PackedScene_get_state: -- :ref:`SceneState` **get_state** **(** **)** +- :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. .. _class_PackedScene_instance: -- :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const +- :ref:`Node` **instance** **(** :ref:`GenEditState` edit_state=0 **)** const -Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED` notification on the root node. +Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED` notification on the root node. .. _class_PackedScene_pack: -- :ref:`Error` **pack** **(** :ref:`Node` path **)** +- :ref:`Error` **pack** **(** :ref:`Node` path **)** Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner`. diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index d32df0a93..d5adbfcbe 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -7,10 +7,8 @@ PacketPeer ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`PacketPeerGDNative`, :ref:`NetworkedMultiplayerPeer` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer`, :ref:`PacketPeerGDNative`, :ref:`NetworkedMultiplayerPeer` **Category:** Core Brief Description @@ -18,38 +16,38 @@ Brief Description Abstraction and base class for packet-based protocols. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | +| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | +| :ref:`Variant` | :ref:`get_var` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var **)** | +| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_PacketPeer_allow_object_decoding: - -- :ref:`bool` **allow_object_decoding** - - Description ----------- PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_PacketPeer_allow_object_decoding: + +- :ref:`bool` **allow_object_decoding** + + +Method Descriptions +------------------- .. _class_PacketPeer_get_available_packet_count: @@ -59,31 +57,31 @@ Return the number of packets currently available in the ring-buffer. .. _class_PacketPeer_get_packet: -- :ref:`PoolByteArray` **get_packet** **(** **)** +- :ref:`PoolByteArray` **get_packet** **(** **)** Get a raw packet. .. _class_PacketPeer_get_packet_error: -- :ref:`Error` **get_packet_error** **(** **)** const +- :ref:`Error` **get_packet_error** **(** **)** const Return the error state of the last packet received (via :ref:`get_packet` and :ref:`get_var`). .. _class_PacketPeer_get_var: -- :ref:`Variant` **get_var** **(** **)** +- :ref:`Variant` **get_var** **(** **)** Get a Variant. .. _class_PacketPeer_put_packet: -- :ref:`Error` **put_packet** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. .. _class_PacketPeer_put_var: -- :ref:`Error` **put_var** **(** :ref:`Variant` var **)** +- :ref:`Error` **put_var** **(** :ref:`Variant` var **)** Send a Variant as a packet. diff --git a/classes/class_packetpeergdnative.rst b/classes/class_packetpeergdnative.rst index c181f0def..7060b3733 100644 --- a/classes/class_packetpeergdnative.rst +++ b/classes/class_packetpeergdnative.rst @@ -7,8 +7,7 @@ PacketPeerGDNative ================== -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 81693c933..5dd179be1 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -7,8 +7,7 @@ PacketPeerStream ================ -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Wrapper to use a PacketPeer over a StreamPeer. -Member Variables ----------------- +Description +----------- + +PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. + +Property Descriptions +--------------------- .. _class_PacketPeerStream_input_buffer_max_size: @@ -29,11 +33,6 @@ Member Variables .. _class_PacketPeerStream_stream_peer: -- :ref:`StreamPeer` **stream_peer** - The wrapped :ref:`StreamPeer` object. +- :ref:`StreamPeer` **stream_peer** - The wrapped :ref:`StreamPeer` object. -Description ------------ - -PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. - diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 60d89c220..a736be5b3 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -7,8 +7,7 @@ PacketPeerUDP ============= -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,32 +15,32 @@ Brief Description UDP packet peer. -Member Functions ----------------- +Methods +------- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | +| :ref:`String` | :ref:`get_packet_ip` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_port` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_listening` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | +| :ref:`Error` | :ref:`set_dest_address` **(** :ref:`String` host, :ref:`int` port **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | +| :ref:`Error` | :ref:`wait` **(** **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant`\ s. +UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant`\ s. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PacketPeerUDP_close: @@ -51,7 +50,7 @@ Close the UDP socket the ``PacketPeerUDP`` is currently listening on. .. _class_PacketPeerUDP_get_packet_ip: -- :ref:`String` **get_packet_ip** **(** **)** const +- :ref:`String` **get_packet_ip** **(** **)** const Return the IP of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). @@ -69,7 +68,7 @@ Return whether this ``PacketPeerUDP`` is listening. .. _class_PacketPeerUDP_listen: -- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** +- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** Make this ``PacketPeerUDP`` listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". @@ -81,13 +80,13 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc) .. _class_PacketPeerUDP_set_dest_address: -- :ref:`Error` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`Error` **set_dest_address** **(** :ref:`String` host, :ref:`int` port **)** Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. .. _class_PacketPeerUDP_wait: -- :ref:`Error` **wait** **(** **)** +- :ref:`Error` **wait** **(** **)** Wait for a packet to arrive on the listening port, see :ref:`listen`. diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 9d995d307..a715df69e 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -7,17 +7,16 @@ Panel ===== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Provides an opaque background for :ref:`Control` children. +Provides an opaque background for :ref:`Control` children. Description ----------- -Panel is a :ref:`Control` that displays an opaque background. It's commonly used as a parent and container for other types of :ref:`Control` nodes. +Panel is a :ref:`Control` that displays an opaque background. It's commonly used as a parent and container for other types of :ref:`Control` nodes. diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index d3c6173f3..74208c221 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -7,10 +7,8 @@ PanelContainer ============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`ScriptEditor` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ScriptEditor` **Category:** Core Brief Description diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 78acff8a2..fca9577db 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -7,25 +7,24 @@ PanoramaSky =========== -**Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A type of :ref:`Sky` used to draw a background texture. - -Member Variables ----------------- - - .. _class_PanoramaSky_panorama: - -- :ref:`Texture` **panorama** - :ref:`Texture` to be applied to the PanoramaSky. - +A type of :ref:`Sky` used to draw a background texture. Description ----------- -A resource referenced in an :ref:`Environment` that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map. +A resource referenced in an :ref:`Environment` that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map. + +Property Descriptions +--------------------- + + .. _class_PanoramaSky_panorama: + +- :ref:`Texture` **panorama** - :ref:`Texture` to be applied to the PanoramaSky. + diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 622d4dc82..a92ec841c 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -7,8 +7,7 @@ ParallaxBackground ================== -**Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,36 +15,36 @@ Brief Description A node used to create a parallax scrolling background. -Member Variables ----------------- - - .. _class_ParallaxBackground_scroll_base_offset: - -- :ref:`Vector2` **scroll_base_offset** - Base position offset of all :ref:`ParallaxLayer` children. - - .. _class_ParallaxBackground_scroll_base_scale: - -- :ref:`Vector2` **scroll_base_scale** - Base motion scale of all :ref:`ParallaxLayer` children. - - .. _class_ParallaxBackground_scroll_ignore_camera_zoom: - -- :ref:`bool` **scroll_ignore_camera_zoom** - If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. - - .. _class_ParallaxBackground_scroll_limit_begin: - -- :ref:`Vector2` **scroll_limit_begin** - Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. - - .. _class_ParallaxBackground_scroll_limit_end: - -- :ref:`Vector2` **scroll_limit_end** - Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. - - .. _class_ParallaxBackground_scroll_offset: - -- :ref:`Vector2` **scroll_offset** - The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. - - Description ----------- -A ParallaxBackground uses one or more :ref:`ParallaxLayer` child nodes to create a parallax effect. Each :ref:`ParallaxLayer` can move at a different speed using :ref:`ParallaxLayer.motion_offset`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D`, you must manually calculate the :ref:`scroll_offset`. +A ParallaxBackground uses one or more :ref:`ParallaxLayer` child nodes to create a parallax effect. Each :ref:`ParallaxLayer` can move at a different speed using :ref:`ParallaxLayer.motion_offset`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D`, you must manually calculate the :ref:`scroll_offset`. + +Property Descriptions +--------------------- + + .. _class_ParallaxBackground_scroll_base_offset: + +- :ref:`Vector2` **scroll_base_offset** - Base position offset of all :ref:`ParallaxLayer` children. + + .. _class_ParallaxBackground_scroll_base_scale: + +- :ref:`Vector2` **scroll_base_scale** - Base motion scale of all :ref:`ParallaxLayer` children. + + .. _class_ParallaxBackground_scroll_ignore_camera_zoom: + +- :ref:`bool` **scroll_ignore_camera_zoom** - If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. + + .. _class_ParallaxBackground_scroll_limit_begin: + +- :ref:`Vector2` **scroll_limit_begin** - Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end` to work. + + .. _class_ParallaxBackground_scroll_limit_end: + +- :ref:`Vector2` **scroll_limit_end** - Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin` to work. + + .. _class_ParallaxBackground_scroll_offset: + +- :ref:`Vector2` **scroll_offset** - The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D`, but can be used to manually manage scrolling when no camera is present. + diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 6a7fe8de9..9ebea6812 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -7,35 +7,34 @@ ParallaxLayer ============= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A parallax scrolling layer to be used with :ref:`ParallaxBackground`. - -Member Variables ----------------- - - .. _class_ParallaxLayer_motion_mirroring: - -- :ref:`Vector2` **motion_mirroring** - The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0`` the :ref:`Texture` will not be mirrored. Default value: ``(0, 0)``. - - .. _class_ParallaxLayer_motion_offset: - -- :ref:`Vector2` **motion_offset** - The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. - - .. _class_ParallaxLayer_motion_scale: - -- :ref:`Vector2` **motion_scale** - Multiplies the ParallaxLayer's motion. If an axis is set to ``0`` it will not scroll. - +A parallax scrolling layer to be used with :ref:`ParallaxBackground`. Description ----------- -A ParallaxLayer must be the child of a :ref:`ParallaxBackground` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset` value. +A ParallaxLayer must be the child of a :ref:`ParallaxBackground` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset` value. This node's children will be affected by its scroll offset. +Property Descriptions +--------------------- + + .. _class_ParallaxLayer_motion_mirroring: + +- :ref:`Vector2` **motion_mirroring** - The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0`` the :ref:`Texture` will not be mirrored. Default value: ``(0, 0)``. + + .. _class_ParallaxLayer_motion_offset: + +- :ref:`Vector2` **motion_offset** - The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. + + .. _class_ParallaxLayer_motion_scale: + +- :ref:`Vector2` **motion_scale** - Multiplies the ParallaxLayer's motion. If an axis is set to ``0`` it will not scroll. + + diff --git a/classes/class_particles.rst b/classes/class_particles.rst index fd6d68f71..5802aac5e 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -7,8 +7,7 @@ Particles ========= -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,41 @@ Brief Description 3D particle emitter. -Member Functions ----------------- +Methods +------- +--------------------------+---------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`capture_aabb` **(** **)** const | +--------------------------+---------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +--------------------------+---------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Particles_DrawOrder: + +enum **DrawOrder** + +- **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. +- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. +- **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth. + + +Constants +--------- + +- **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. + +Description +----------- + +3D particle node used to create a variety of particle systems and effects. ``Particles`` features an emitter that generates some number of particles at a given rate. + +Use the ``process_material`` property to add a :ref:`ParticlesMaterial` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial` which will be applied to all particles. + +Property Descriptions +--------------------- .. _class_Particles_amount: @@ -34,23 +57,23 @@ Member Variables .. _class_Particles_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles_draw_pass_1: -- :ref:`Mesh` **draw_pass_1** - :ref:`Mesh` that is drawn for the first draw pass. +- :ref:`Mesh` **draw_pass_1** - :ref:`Mesh` that is drawn for the first draw pass. .. _class_Particles_draw_pass_2: -- :ref:`Mesh` **draw_pass_2** - :ref:`Mesh` that is drawn for the second draw pass. +- :ref:`Mesh` **draw_pass_2** - :ref:`Mesh` that is drawn for the second draw pass. .. _class_Particles_draw_pass_3: -- :ref:`Mesh` **draw_pass_3** - :ref:`Mesh` that is drawn for the third draw pass. +- :ref:`Mesh` **draw_pass_3** - :ref:`Mesh` that is drawn for the third draw pass. .. _class_Particles_draw_pass_4: -- :ref:`Mesh` **draw_pass_4** - :ref:`Mesh` that is drawn for the fourth draw pass. +- :ref:`Mesh` **draw_pass_4** - :ref:`Mesh` that is drawn for the fourth draw pass. .. _class_Particles_draw_passes: @@ -90,7 +113,7 @@ Member Variables .. _class_Particles_process_material: -- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. .. _class_Particles_randomness: @@ -98,43 +121,19 @@ Member Variables .. _class_Particles_speed_scale: -- :ref:`float` **speed_scale** - Speed scaling ratio. Default value: ``1``. +- :ref:`float` **speed_scale** - Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. .. _class_Particles_visibility_aabb: -- :ref:`AABB` **visibility_aabb** - The :ref:`AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active. +- :ref:`AABB` **visibility_aabb** - The :ref:`AABB` that determines the area of the world part of which needs to be visible on screen for the particle system to be active. -Numeric Constants ------------------ - -- **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. - -Enums ------ - - .. _enum_Particles_DrawOrder: - -enum **DrawOrder** - -- **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. -- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. -- **DRAW_ORDER_VIEW_DEPTH** = **2** --- Particles are drawn in order of depth. - - -Description ------------ - -3D particle node used to create a variety of particle systems and effects. ``Particles`` features an emitter that generates some number of particles at a given rate. - -Use the ``process_material`` property to add a :ref:`ParticlesMaterial` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial` which will be applied to all particles. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Particles_capture_aabb: -- :ref:`AABB` **capture_aabb** **(** **)** const +- :ref:`AABB` **capture_aabb** **(** **)** const .. _class_Particles_restart: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 2b98620d0..112e30511 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -7,8 +7,7 @@ Particles2D =========== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,35 @@ Brief Description 2D particle emitter. -Member Functions ----------------- +Methods +------- +----------------------------+-----------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | +----------------------------+-----------------------------------------------------------------------+ | void | :ref:`restart` **(** **)** | +----------------------------+-----------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Particles2D_DrawOrder: + +enum **DrawOrder** + +- **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. +- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. + + +Description +----------- + +2D particle node used to create a variety of particle systems and effects. ``Particles2D`` features an emitter that generates some number of particles at a given rate. + +Use the ``process_material`` property to add a :ref:`ParticlesMaterial` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial` which will be applied to all particles. + +Property Descriptions +--------------------- .. _class_Particles2D_amount: @@ -34,7 +51,7 @@ Member Variables .. _class_Particles2D_draw_order: -- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. +- :ref:`DrawOrder` **draw_order** - Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. .. _class_Particles2D_emitting: @@ -66,7 +83,7 @@ Member Variables .. _class_Particles2D_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture` **normal_map** .. _class_Particles2D_one_shot: @@ -78,7 +95,7 @@ Member Variables .. _class_Particles2D_process_material: -- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. +- :ref:`Material` **process_material** - :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. .. _class_Particles2D_randomness: @@ -86,11 +103,11 @@ Member Variables .. _class_Particles2D_speed_scale: -- :ref:`float` **speed_scale** - Particle system's running speed scaling ratio. Default value: ``1``. +- :ref:`float` **speed_scale** - Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. .. _class_Particles2D_texture: -- :ref:`Texture` **texture** - Particle texture. If ``null`` particles will be squares. +- :ref:`Texture` **texture** - Particle texture. If ``null`` particles will be squares. .. _class_Particles2D_v_frames: @@ -98,33 +115,15 @@ Member Variables .. _class_Particles2D_visibility_rect: -- :ref:`Rect2` **visibility_rect** - Editor visibility helper. +- :ref:`Rect2` **visibility_rect** - Editor visibility helper. -Enums ------ - - .. _enum_Particles2D_DrawOrder: - -enum **DrawOrder** - -- **DRAW_ORDER_INDEX** = **0** --- Particles are drawn in the order emitted. -- **DRAW_ORDER_LIFETIME** = **1** --- Particles are drawn in order of remaining lifetime. - - -Description ------------ - -2D particle node used to create a variety of particle systems and effects. ``Particles2D`` features an emitter that generates some number of particles at a given rate. - -Use the ``process_material`` property to add a :ref:`ParticlesMaterial` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial` which will be applied to all particles. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Particles2D_capture_rect: -- :ref:`Rect2` **capture_rect** **(** **)** const +- :ref:`Rect2` **capture_rect** **(** **)** const .. _class_Particles2D_restart: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index d8f929ca5..e4e14f2a6 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -7,237 +7,16 @@ ParticlesMaterial ================= -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Particle properties for :ref:`Particles` and :ref:`Particles2D` nodes. +Particle properties for :ref:`Particles` and :ref:`Particles2D` nodes. -Member Variables ----------------- - - .. _class_ParticlesMaterial_angle: - -- :ref:`float` **angle** - Initial rotation applied to each particle. - - .. _class_ParticlesMaterial_angle_curve: - -- :ref:`Texture` **angle_curve** - Each particle's rotation will be animated along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_angle_random: - -- :ref:`float` **angle_random** - Rotation randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_angular_velocity: - -- :ref:`float` **angular_velocity** - Initial angular velocity applied to each particle. - - .. _class_ParticlesMaterial_angular_velocity_curve: - -- :ref:`Texture` **angular_velocity_curve** - Each particle's angular velocity will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_angular_velocity_random: - -- :ref:`float` **angular_velocity_random** - Angular velocity randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_anim_loop: - -- :ref:`bool` **anim_loop** - If ``true`` animation will loop. Default value: ``false``. - - .. _class_ParticlesMaterial_anim_offset: - -- :ref:`float` **anim_offset** - Particle animation offset. - - .. _class_ParticlesMaterial_anim_offset_curve: - -- :ref:`Texture` **anim_offset_curve** - Each particle's animation offset will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_anim_offset_random: - -- :ref:`float` **anim_offset_random** - Animation offset randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_anim_speed: - -- :ref:`float` **anim_speed** - Particle animation speed. - - .. _class_ParticlesMaterial_anim_speed_curve: - -- :ref:`Texture` **anim_speed_curve** - Each particle's animation speed will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_anim_speed_random: - -- :ref:`float` **anim_speed_random** - Animation speed randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_color: - -- :ref:`Color` **color** - Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. - - .. _class_ParticlesMaterial_color_ramp: - -- :ref:`Texture` **color_ramp** - Each particle's color will vary along this :ref:`GradientTexture`. - - .. _class_ParticlesMaterial_damping: - -- :ref:`float` **damping** - The rate at which particles lose velocity. - - .. _class_ParticlesMaterial_damping_curve: - -- :ref:`Texture` **damping_curve** - Damping will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_damping_random: - -- :ref:`float` **damping_random** - Damping randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_emission_box_extents: - -- :ref:`Vector3` **emission_box_extents** - The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. - - .. _class_ParticlesMaterial_emission_color_texture: - -- :ref:`Texture` **emission_color_texture** - - .. _class_ParticlesMaterial_emission_normal_texture: - -- :ref:`Texture` **emission_normal_texture** - - .. _class_ParticlesMaterial_emission_point_count: - -- :ref:`int` **emission_point_count** - The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. - - .. _class_ParticlesMaterial_emission_point_texture: - -- :ref:`Texture` **emission_point_texture** - - .. _class_ParticlesMaterial_emission_shape: - -- :ref:`EmissionShape` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. - - .. _class_ParticlesMaterial_emission_sphere_radius: - -- :ref:`float` **emission_sphere_radius** - The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. - - .. _class_ParticlesMaterial_flag_align_y: - -- :ref:`bool` **flag_align_y** - - .. _class_ParticlesMaterial_flag_disable_z: - -- :ref:`bool` **flag_disable_z** - If ``true`` particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. - - .. _class_ParticlesMaterial_flag_rotate_y: - -- :ref:`bool` **flag_rotate_y** - - .. _class_ParticlesMaterial_flatness: - -- :ref:`float` **flatness** - - .. _class_ParticlesMaterial_gravity: - -- :ref:`Vector3` **gravity** - Gravity applied to every particle. Default value: ``(0, 98, 0)``. - - .. _class_ParticlesMaterial_hue_variation: - -- :ref:`float` **hue_variation** - Initial hue variation applied to each particle. - - .. _class_ParticlesMaterial_hue_variation_curve: - -- :ref:`Texture` **hue_variation_curve** - Each particle's hue will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_hue_variation_random: - -- :ref:`float` **hue_variation_random** - Hue variation randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_initial_velocity: - -- :ref:`float` **initial_velocity** - Initial velocity for each particle. - - .. _class_ParticlesMaterial_initial_velocity_random: - -- :ref:`float` **initial_velocity_random** - Initial velocity randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_linear_accel: - -- :ref:`float` **linear_accel** - Linear acceleration applied to each particle. - - .. _class_ParticlesMaterial_linear_accel_curve: - -- :ref:`Texture` **linear_accel_curve** - Each particle's linear acceleration will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_linear_accel_random: - -- :ref:`float` **linear_accel_random** - Linear acceleration randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_orbit_velocity: - -- :ref:`float` **orbit_velocity** - Orbital velocity applied to each particle. - - .. _class_ParticlesMaterial_orbit_velocity_curve: - -- :ref:`Texture` **orbit_velocity_curve** - Each particle's orbital velocity will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_orbit_velocity_random: - -- :ref:`float` **orbit_velocity_random** - Orbital velocity randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_radial_accel: - -- :ref:`float` **radial_accel** - Radial acceleration applied to each particle. - - .. _class_ParticlesMaterial_radial_accel_curve: - -- :ref:`Texture` **radial_accel_curve** - Each particle's radial acceleration will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_radial_accel_random: - -- :ref:`float` **radial_accel_random** - Radial acceleration randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_scale: - -- :ref:`float` **scale** - Initial scale applied to each particle. - - .. _class_ParticlesMaterial_scale_curve: - -- :ref:`Texture` **scale_curve** - Each particle's scale will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_scale_random: - -- :ref:`float` **scale_random** - Scale randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_spread: - -- :ref:`float` **spread** - Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. - - .. _class_ParticlesMaterial_tangential_accel: - -- :ref:`float` **tangential_accel** - Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. - - .. _class_ParticlesMaterial_tangential_accel_curve: - -- :ref:`Texture` **tangential_accel_curve** - Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. - - .. _class_ParticlesMaterial_tangential_accel_random: - -- :ref:`float` **tangential_accel_random** - Tangential acceleration randomness ratio. Default value: ``0``. - - .. _class_ParticlesMaterial_trail_color_modifier: - -- :ref:`GradientTexture` **trail_color_modifier** - Trail particles' color will vary along this :ref:`GradientTexture`. - - .. _class_ParticlesMaterial_trail_divisor: - -- :ref:`int` **trail_divisor** - Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). - - .. _class_ParticlesMaterial_trail_size_modifier: - -- :ref:`CurveTexture` **trail_size_modifier** - Trail particles' size will vary along this :ref:`CurveTexture`. - - -Enums ------ +Enumerations +------------ .. _enum_ParticlesMaterial_Flags: @@ -279,7 +58,227 @@ enum **EmissionShape** Description ----------- -ParticlesMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`Particles` and :ref:`Particles2D` emitter nodes. +ParticlesMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`Particles` and :ref:`Particles2D` emitter nodes. + +Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` applied to vary values over the lifetime of the particle. + +Property Descriptions +--------------------- + + .. _class_ParticlesMaterial_angle: + +- :ref:`float` **angle** - Initial rotation applied to each particle. + + .. _class_ParticlesMaterial_angle_curve: + +- :ref:`Texture` **angle_curve** - Each particle's rotation will be animated along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_angle_random: + +- :ref:`float` **angle_random** - Rotation randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_angular_velocity: + +- :ref:`float` **angular_velocity** - Initial angular velocity applied to each particle. + + .. _class_ParticlesMaterial_angular_velocity_curve: + +- :ref:`Texture` **angular_velocity_curve** - Each particle's angular velocity will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_angular_velocity_random: + +- :ref:`float` **angular_velocity_random** - Angular velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_anim_loop: + +- :ref:`bool` **anim_loop** - If ``true`` animation will loop. Default value: ``false``. + + .. _class_ParticlesMaterial_anim_offset: + +- :ref:`float` **anim_offset** - Particle animation offset. + + .. _class_ParticlesMaterial_anim_offset_curve: + +- :ref:`Texture` **anim_offset_curve** - Each particle's animation offset will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_anim_offset_random: + +- :ref:`float` **anim_offset_random** - Animation offset randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_anim_speed: + +- :ref:`float` **anim_speed** - Particle animation speed. + + .. _class_ParticlesMaterial_anim_speed_curve: + +- :ref:`Texture` **anim_speed_curve** - Each particle's animation speed will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_anim_speed_random: + +- :ref:`float` **anim_speed_random** - Animation speed randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_color: + +- :ref:`Color` **color** - Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. + + .. _class_ParticlesMaterial_color_ramp: + +- :ref:`Texture` **color_ramp** - Each particle's color will vary along this :ref:`GradientTexture`. + + .. _class_ParticlesMaterial_damping: + +- :ref:`float` **damping** - The rate at which particles lose velocity. + + .. _class_ParticlesMaterial_damping_curve: + +- :ref:`Texture` **damping_curve** - Damping will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_damping_random: + +- :ref:`float` **damping_random** - Damping randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_emission_box_extents: + +- :ref:`Vector3` **emission_box_extents** - The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. + + .. _class_ParticlesMaterial_emission_color_texture: + +- :ref:`Texture` **emission_color_texture** + + .. _class_ParticlesMaterial_emission_normal_texture: + +- :ref:`Texture` **emission_normal_texture** + + .. _class_ParticlesMaterial_emission_point_count: + +- :ref:`int` **emission_point_count** - The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. + + .. _class_ParticlesMaterial_emission_point_texture: + +- :ref:`Texture` **emission_point_texture** + + .. _class_ParticlesMaterial_emission_shape: + +- :ref:`EmissionShape` **emission_shape** - Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. + + .. _class_ParticlesMaterial_emission_sphere_radius: + +- :ref:`float` **emission_sphere_radius** - The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. + + .. _class_ParticlesMaterial_flag_align_y: + +- :ref:`bool` **flag_align_y** + + .. _class_ParticlesMaterial_flag_disable_z: + +- :ref:`bool` **flag_disable_z** - If ``true`` particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. + + .. _class_ParticlesMaterial_flag_rotate_y: + +- :ref:`bool` **flag_rotate_y** + + .. _class_ParticlesMaterial_flatness: + +- :ref:`float` **flatness** + + .. _class_ParticlesMaterial_gravity: + +- :ref:`Vector3` **gravity** - Gravity applied to every particle. Default value: ``(0, 98, 0)``. + + .. _class_ParticlesMaterial_hue_variation: + +- :ref:`float` **hue_variation** - Initial hue variation applied to each particle. + + .. _class_ParticlesMaterial_hue_variation_curve: + +- :ref:`Texture` **hue_variation_curve** - Each particle's hue will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_hue_variation_random: + +- :ref:`float` **hue_variation_random** - Hue variation randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_initial_velocity: + +- :ref:`float` **initial_velocity** - Initial velocity for each particle. + + .. _class_ParticlesMaterial_initial_velocity_random: + +- :ref:`float` **initial_velocity_random** - Initial velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_linear_accel: + +- :ref:`float` **linear_accel** - Linear acceleration applied to each particle. + + .. _class_ParticlesMaterial_linear_accel_curve: + +- :ref:`Texture` **linear_accel_curve** - Each particle's linear acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_linear_accel_random: + +- :ref:`float` **linear_accel_random** - Linear acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_orbit_velocity: + +- :ref:`float` **orbit_velocity** - Orbital velocity applied to each particle. + + .. _class_ParticlesMaterial_orbit_velocity_curve: + +- :ref:`Texture` **orbit_velocity_curve** - Each particle's orbital velocity will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_orbit_velocity_random: + +- :ref:`float` **orbit_velocity_random** - Orbital velocity randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_radial_accel: + +- :ref:`float` **radial_accel** - Radial acceleration applied to each particle. + + .. _class_ParticlesMaterial_radial_accel_curve: + +- :ref:`Texture` **radial_accel_curve** - Each particle's radial acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_radial_accel_random: + +- :ref:`float` **radial_accel_random** - Radial acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_scale: + +- :ref:`float` **scale** - Initial scale applied to each particle. + + .. _class_ParticlesMaterial_scale_curve: + +- :ref:`Texture` **scale_curve** - Each particle's scale will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_scale_random: + +- :ref:`float` **scale_random** - Scale randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_spread: + +- :ref:`float` **spread** - Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. + + .. _class_ParticlesMaterial_tangential_accel: + +- :ref:`float` **tangential_accel** - Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. + + .. _class_ParticlesMaterial_tangential_accel_curve: + +- :ref:`Texture` **tangential_accel_curve** - Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. + + .. _class_ParticlesMaterial_tangential_accel_random: + +- :ref:`float` **tangential_accel_random** - Tangential acceleration randomness ratio. Default value: ``0``. + + .. _class_ParticlesMaterial_trail_color_modifier: + +- :ref:`GradientTexture` **trail_color_modifier** - Trail particles' color will vary along this :ref:`GradientTexture`. + + .. _class_ParticlesMaterial_trail_divisor: + +- :ref:`int` **trail_divisor** - Emitter will emit ``amount`` divided by ``trail_divisor`` particles. The remaining particles will be used as trail(s). + + .. _class_ParticlesMaterial_trail_size_modifier: + +- :ref:`CurveTexture` **trail_size_modifier** - Trail particles' size will vary along this :ref:`CurveTexture`. -Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` applied to vary values over the lifetime of the particle. diff --git a/classes/class_path.rst b/classes/class_path.rst index 55f40909c..11aeb922d 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -7,14 +7,13 @@ Path ==== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Container for a :ref:`Curve3D`. +Container for a :ref:`Curve3D`. Signals ------- @@ -24,16 +23,16 @@ Signals - **curve_changed** **(** **)** -Member Variables ----------------- - - .. _class_Path_curve: - -- :ref:`Curve3D` **curve** - - Description ----------- -This class is a container/Node-ification of a :ref:`Curve3D`, so it can have :ref:`Spatial` properties and :ref:`Node` info. +This class is a container/Node-ification of a :ref:`Curve3D`, so it can have :ref:`Spatial` properties and :ref:`Node` info. + +Property Descriptions +--------------------- + + .. _class_Path_curve: + +- :ref:`Curve3D` **curve** + diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 12db32aa3..15a4ebddb 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -7,25 +7,24 @@ Path2D ====== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` nodes to follow. - -Member Variables ----------------- - - .. _class_Path2D_curve: - -- :ref:`Curve2D` **curve** - A :ref:`Curve2D` describing the path. - +Contains a :ref:`Curve2D` path for :ref:`PathFollow2D` nodes to follow. Description ----------- -Can have :ref:`PathFollow2D` child-nodes moving along the :ref:`Curve2D`. See :ref:`PathFollow2D` for more information on this usage. +Can have :ref:`PathFollow2D` child-nodes moving along the :ref:`Curve2D`. See :ref:`PathFollow2D` for more information on this usage. + +Property Descriptions +--------------------- + + .. _class_Path2D_curve: + +- :ref:`Curve2D` **curve** - A :ref:`Curve2D` describing the path. + diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index cd38cb484..916bd8697 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -7,23 +7,42 @@ PathFollow ========== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Point sampler for a :ref:`Path`. +Point sampler for a :ref:`Path`. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_PathFollow_RotationMode: + +enum **RotationMode** + +- **ROTATION_NONE** = **0** --- Forbids the PathFollow to rotate. +- **ROTATION_Y** = **1** --- Allows the PathFollow to rotate in the Y axis only. +- **ROTATION_XY** = **2** --- Allows the PathFollow to rotate in both the X, and Y axes. +- **ROTATION_XYZ** = **3** --- Allows the PathFollow to rotate in any axis. + + +Description +----------- + +This node takes its parent :ref:`Path`, and returns the coordinates of a point within it, given a distance from the first vertex. + +It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + +Property Descriptions +--------------------- .. _class_PathFollow_cubic_interp: - :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. -The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. +The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. @@ -41,7 +60,7 @@ There are two answers to this problem: Either increase the number of cached poin .. _class_PathFollow_rotation_mode: -- :ref:`RotationMode` **rotation_mode** - Allows or forbids rotation on one or more axes, depending on the constants being used. +- :ref:`RotationMode` **rotation_mode** - Allows or forbids rotation on one or more axes, depending on the constants being used. .. _class_PathFollow_unit_offset: @@ -52,23 +71,3 @@ There are two answers to this problem: Either increase the number of cached poin - :ref:`float` **v_offset** - The node's offset perpendicular to the curve. -Enums ------ - - .. _enum_PathFollow_RotationMode: - -enum **RotationMode** - -- **ROTATION_NONE** = **0** --- Forbids the PathFollow to rotate. -- **ROTATION_Y** = **1** --- Allows the PathFollow to rotate in the Y axis only. -- **ROTATION_XY** = **2** --- Allows the PathFollow to rotate in both the X, and Y axes. -- **ROTATION_XYZ** = **3** --- Allows the PathFollow to rotate in any axis. - - -Description ------------ - -This node takes its parent :ref:`Path`, and returns the coordinates of a point within it, given a distance from the first vertex. - -It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. - diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index fdab602af..af38e46fe 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -7,23 +7,29 @@ PathFollow2D ============ -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Point sampler for a :ref:`Path2D`. +Point sampler for a :ref:`Path2D`. -Member Variables ----------------- +Description +----------- + +This node takes its parent :ref:`Path2D`, and returns the coordinates of a point within it, given a distance from the first vertex. + +It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + +Property Descriptions +--------------------- .. _class_PathFollow2D_cubic_interp: - :ref:`bool` **cubic_interp** - If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. -The points along the :ref:`Curve2D` of the :ref:`Path2D` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. +The points along the :ref:`Curve2D` of the :ref:`Path2D` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. @@ -56,10 +62,3 @@ There are two answers to this problem: Either increase the number of cached poin - :ref:`float` **v_offset** - The node's offset perpendicular to the curve. -Description ------------ - -This node takes its parent :ref:`Path2D`, and returns the coordinates of a point within it, given a distance from the first vertex. - -It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. - diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 91dd7d630..a076fb26e 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -7,8 +7,7 @@ PCKPacker ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,30 +15,30 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | +| :ref:`Error` | :ref:`add_file` **(** :ref:`String` pck_path, :ref:`String` source_path **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`flush` **(** :ref:`bool` verbose **)** | +| :ref:`Error` | :ref:`flush` **(** :ref:`bool` verbose **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | +| :ref:`Error` | :ref:`pck_start` **(** :ref:`String` pck_name, :ref:`int` alignment **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PCKPacker_add_file: -- :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** +- :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** .. _class_PCKPacker_flush: -- :ref:`Error` **flush** **(** :ref:`bool` verbose **)** +- :ref:`Error` **flush** **(** :ref:`bool` verbose **)** .. _class_PCKPacker_pck_start: -- :ref:`Error` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** +- :ref:`Error` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 729d1b3a1..320e794a6 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -7,8 +7,7 @@ Performance =========== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Exposes performance related data. -Member Functions ----------------- +Methods +------- +----------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** const | +| :ref:`float` | :ref:`get_monitor` **(** :ref:`Monitor` monitor **)** const | +----------------------------+----------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_Performance_Monitor: @@ -51,10 +50,10 @@ enum **Monitor** - **RENDER_TEXTURE_MEM_USED** = **18** --- Texture memory used. - **RENDER_VERTEX_MEM_USED** = **19** --- Vertex memory used. - **RENDER_USAGE_VIDEO_MEM_TOTAL** = **20** -- **PHYSICS_2D_ACTIVE_OBJECTS** = **21** --- Number of active :ref:`RigidBody2D` nodes in the game. +- **PHYSICS_2D_ACTIVE_OBJECTS** = **21** --- Number of active :ref:`RigidBody2D` nodes in the game. - **PHYSICS_2D_COLLISION_PAIRS** = **22** --- Number of collision pairs in the 2D physics engine. - **PHYSICS_2D_ISLAND_COUNT** = **23** --- Number of islands in the 2D physics engine. -- **PHYSICS_3D_ACTIVE_OBJECTS** = **24** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. +- **PHYSICS_3D_ACTIVE_OBJECTS** = **24** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. - **PHYSICS_3D_COLLISION_PAIRS** = **25** --- Number of collision pairs in the 3D physics engine. - **PHYSICS_3D_ISLAND_COUNT** = **26** --- Number of islands in the 3D physics engine. - **AUDIO_OUTPUT_LATENCY** = **27** @@ -68,12 +67,12 @@ This class provides access to a number of different monitors related to performa Many of these monitors are not updated in real-time, so there may be a short delay between changes. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Performance_get_monitor: -- :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const +- :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const Returns the value of one of the available monitors. You should provide one of this class's constants as the argument, like this: diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index b1b7a0231..a4ae078e9 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -7,8 +7,7 @@ PHashTranslation ================ -**Inherits:** :ref:`Translation` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Translation` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description Optimized translation. -Member Functions ----------------- +Methods +------- +-------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate` **(** :ref:`Translation` from **)** | +| void | :ref:`generate` **(** :ref:`Translation` from **)** | +-------+---------------------------------------------------------------------------------------------------------+ Description @@ -28,11 +27,11 @@ Description Optimized translation. Uses real-time compressed translations, which results in very small dictionaries. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PHashTranslation_generate: -- void **generate** **(** :ref:`Translation` from **)** +- void **generate** **(** :ref:`Translation` from **)** diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index 81113d3c4..47e2d86e5 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -7,8 +7,7 @@ PhysicalBone ============ -**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------+------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_id` **(** **)** const | @@ -29,12 +28,27 @@ Member Functions | :ref:`bool` | :ref:`is_static_body` **(** **)** | +--------------------------+------------------------------------------------------------------------------------+ -Member Variables ----------------- +Enumerations +------------ + + .. _enum_PhysicalBone_JointType: + +enum **JointType** + +- **JOINT_TYPE_NONE** = **0** +- **JOINT_TYPE_PIN** = **1** +- **JOINT_TYPE_CONE** = **2** +- **JOINT_TYPE_HINGE** = **3** +- **JOINT_TYPE_SLIDER** = **4** +- **JOINT_TYPE_6DOF** = **5** + + +Property Descriptions +--------------------- .. _class_PhysicalBone_body_offset: -- :ref:`Transform` **body_offset** +- :ref:`Transform` **body_offset** .. _class_PhysicalBone_bounce: @@ -50,11 +64,11 @@ Member Variables .. _class_PhysicalBone_joint_offset: -- :ref:`Transform` **joint_offset** +- :ref:`Transform` **joint_offset** .. _class_PhysicalBone_joint_type: -- :ref:`JointType` **joint_type** +- :ref:`JointType` **joint_type** .. _class_PhysicalBone_mass: @@ -65,23 +79,8 @@ Member Variables - :ref:`float` **weight** -Enums ------ - - .. _enum_PhysicalBone_JointType: - -enum **JointType** - -- **JOINT_TYPE_NONE** = **0** -- **JOINT_TYPE_PIN** = **1** -- **JOINT_TYPE_CONE** = **2** -- **JOINT_TYPE_HINGE** = **3** -- **JOINT_TYPE_SLIDER** = **4** -- **JOINT_TYPE_6DOF** = **5** - - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicalBone_get_bone_id: diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index a69431527..0c5aeb879 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -7,62 +7,65 @@ Physics2DDirectBodyState ======================== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`Physics2DDirectBodyStateSW` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`Physics2DDirectBodyStateSW` **Category:** Core Brief Description ----------------- -Direct access object to a physics body in the :ref:`Physics2DServer`. +Direct access object to a physics body in the :ref:`Physics2DServer`. -Member Functions ----------------- +Methods +------- +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | +| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | +| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_torque` **(** :ref:`float` torque **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | +| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`float` impulse **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | +| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_count` **(** **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | +| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`integrate_forces` **(** **)** | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Direct access object to a physics body in the :ref:`Physics2DServer`. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. + +Property Descriptions +--------------------- .. _class_Physics2DDirectBodyState_angular_velocity: @@ -78,7 +81,7 @@ Member Variables .. _class_Physics2DDirectBodyState_linear_velocity: -- :ref:`Vector2` **linear_velocity** - The linear velocity of the body. +- :ref:`Vector2` **linear_velocity** - The linear velocity of the body. .. _class_Physics2DDirectBodyState_sleeping: @@ -94,7 +97,7 @@ Member Variables .. _class_Physics2DDirectBodyState_total_gravity: -- :ref:`Vector2` **total_gravity** - The total gravity vector being currently applied to this body. +- :ref:`Vector2` **total_gravity** - The total gravity vector being currently applied to this body. .. _class_Physics2DDirectBodyState_total_linear_damp: @@ -102,24 +105,19 @@ Member Variables .. _class_Physics2DDirectBodyState_transform: -- :ref:`Transform2D` **transform** - The transformation matrix of the body. +- :ref:`Transform2D` **transform** - The transformation matrix of the body. -Description ------------ - -Direct access object to a physics body in the :ref:`Physics2DServer`. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Physics2DDirectBodyState_add_central_force: -- void **add_central_force** **(** :ref:`Vector2` force **)** +- void **add_central_force** **(** :ref:`Vector2` force **)** .. _class_Physics2DDirectBodyState_add_force: -- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** +- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** .. _class_Physics2DDirectBodyState_add_torque: @@ -127,11 +125,11 @@ Member Function Description .. _class_Physics2DDirectBodyState_apply_central_impulse: -- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** +- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** .. _class_Physics2DDirectBodyState_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** +- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** .. _class_Physics2DDirectBodyState_apply_torque_impulse: @@ -139,9 +137,9 @@ Member Function Description .. _class_Physics2DDirectBodyState_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const -Return the :ref:`RID` of the collider. +Return the :ref:`RID` of the collider. .. _class_Physics2DDirectBodyState_get_contact_collider_id: @@ -151,13 +149,13 @@ Return the object id of the collider. .. _class_Physics2DDirectBodyState_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). .. _class_Physics2DDirectBodyState_get_contact_collider_position: -- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Return the contact position in the collider. @@ -169,13 +167,13 @@ Return the collider shape index. .. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata: -- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const +- :ref:`Variant` **get_contact_collider_shape_metadata** **(** :ref:`int` contact_idx **)** const Return the metadata of the collided shape. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. .. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Return the linear velocity vector at contact point of the collider. @@ -187,13 +185,13 @@ Return the amount of contacts this body has with other bodies. Note that by defa .. _class_Physics2DDirectBodyState_get_contact_local_normal: -- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const Return the local normal (of this body) of the contact point. .. _class_Physics2DDirectBodyState_get_contact_local_position: -- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Return the local position (of this body) of the contact point. @@ -205,7 +203,7 @@ Return the local shape index of the collision. .. _class_Physics2DDirectBodyState_get_space_state: -- :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** +- :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Return the current state of space, useful for queries. diff --git a/classes/class_physics2ddirectbodystatesw.rst b/classes/class_physics2ddirectbodystatesw.rst index 003befbad..f86969943 100644 --- a/classes/class_physics2ddirectbodystatesw.rst +++ b/classes/class_physics2ddirectbodystatesw.rst @@ -7,17 +7,16 @@ Physics2DDirectBodyStateSW ========================== -**Inherits:** :ref:`Physics2DDirectBodyState` **<** :ref:`Object` - +**Inherits:** :ref:`Physics2DDirectBodyState` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Software implementation of :ref:`Physics2DDirectBodyState`. +Software implementation of :ref:`Physics2DDirectBodyState`. Description ----------- -Software implementation of :ref:`Physics2DDirectBodyState`. This object exposes no new methods or properties and should not be used, as :ref:`Physics2DDirectBodyState` selects the best implementation available. +Software implementation of :ref:`Physics2DDirectBodyState`. This object exposes no new methods or properties and should not be used, as :ref:`Physics2DDirectBodyState` selects the best implementation available. diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index a9e05b5e4..506899449 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -7,68 +7,67 @@ Physics2DDirectSpaceState ========================= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- -Direct access object to a space in the :ref:`Physics2DServer`. +Direct access object to a space in the :ref:`Physics2DServer`. -Member Functions ----------------- +Methods +------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Direct access object to a space in the :ref:`Physics2DServer`. It's used mainly to do queries against objects and areas residing in a given space. +Direct access object to a space in the :ref:`Physics2DServer`. It's used mainly to do queries against objects and areas residing in a given space. Tutorials --------- - :doc:`../tutorials/physics/ray-casting` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Physics2DDirectSpaceState_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** +- :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** -Checks how far the shape can travel toward a point. Note that both the shape and the motion are supplied through a :ref:`Physics2DShapeQueryParameters` object. The method will return an array with two floats between 0 and 1, both representing a fraction of ``motion``. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be 1, 1. +Checks how far the shape can travel toward a point. Note that both the shape and the motion are supplied through a :ref:`Physics2DShapeQueryParameters` object. The method will return an array with two floats between 0 and 1, both representing a fraction of ``motion``. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be 1, 1. -If the shape can not move, the array will be empty (``dir.empty()==true``). +If the shape can not move, the array will be empty. .. _class_Physics2DDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. +Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. .. _class_Physics2DDirectSpaceState_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** -Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. If it collides with more than one shape, the nearest one is selected. Note that this method does not take into account the ``motion`` property of the object. The returned object is a dictionary containing the following fields: +Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. If it collides with more than one shape, the nearest one is selected. Note that this method does not take into account the ``motion`` property of the object. The returned object is a dictionary containing the following fields: ``collider_id``: The colliding object's ID. -``linear_velocity``: The colliding object's velocity :ref:`Vector2`. If the object is an :ref:`Area2D`, the result is ``(0, 0)``. +``linear_velocity``: The colliding object's velocity :ref:`Vector2`. If the object is an :ref:`Area2D`, the result is ``(0, 0)``. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. @@ -76,15 +75,15 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa ``point``: The intersection point. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. -If the shape did not intersect anything, then an empty dictionary (``dir.empty()==true``) is returned instead. +If the shape did not intersect anything, then an empty dictionary is returned instead. .. _class_Physics2DDirectSpaceState_intersect_point: -- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** Checks whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: @@ -94,15 +93,15 @@ Checks whether a point is inside any shape. The shapes the point is inside of ar ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. -Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. +Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** Intersects a ray in a given space. The returned object is a dictionary with the following fields: @@ -116,19 +115,19 @@ Intersects a ray in a given space. The returned object is a dictionary with the ``position``: The intersection point. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. -If the ray did not intersect anything, then an empty dictionary (``dir.empty()==true``) is returned instead. +If the ray did not intersect anything, then an empty dictionary is returned instead. -Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. +Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. .. _class_Physics2DDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. Note that this method does not take into account the ``motion`` property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: +Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters` object, against the space. Note that this method does not take into account the ``motion`` property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: ``collider``: The colliding object. @@ -136,7 +135,7 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta`, and is set with :ref:`Physics2DServer.shape_set_data`. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 0f89a9543..b5cd2774c 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -7,10 +7,8 @@ Physics2DServer =============== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`Physics2DServerSW` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`Physics2DServerSW` **Category:** Core Brief Description @@ -18,209 +16,209 @@ Brief Description Physics 2D Server. -Member Functions ----------------- +Methods +------- +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | +| :ref:`RID` | :ref:`area_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`Transform2D` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +| :ref:`Transform2D` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | +| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | +| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`float` torque **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** **)** | +| :ref:`RID` | :ref:`body_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | +| :ref:`CCDMode` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +| :ref:`Physics2DDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Variant` | :ref:`body_get_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Transform2D` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | +| void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | +| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | +| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | +| void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +| :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | +| :ref:`RID` | :ref:`capsule_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`circle_shape_create` **(** **)** | +| :ref:`RID` | :ref:`circle_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | +| :ref:`RID` | :ref:`concave_polygon_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | +| :ref:`RID` | :ref:`convex_polygon_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const | +| :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** | +| void | :ref:`damped_string_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | +| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** const | +| :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | +| void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`line_shape_create` **(** **)** | +| :ref:`RID` | :ref:`line_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`ray_shape_create` **(** **)** | +| :ref:`RID` | :ref:`ray_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | +| :ref:`RID` | :ref:`rectangle_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`segment_shape_create` **(** **)** | +| :ref:`RID` | :ref:`segment_shape_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | +| :ref:`RID` | :ref:`space_create` **(** **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +| :ref:`Physics2DDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | +---------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_Physics2DServer_CCDMode: @@ -356,112 +354,112 @@ Description Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Physics2DServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_Physics2DServer_area_attach_object_instance_id: -- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** -Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. +Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_Physics2DServer_area_clear_shapes: -- void **area_clear_shapes** **(** :ref:`RID` area **)** +- void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. .. _class_Physics2DServer_area_create: -- :ref:`RID` **area_create** **(** **)** +- :ref:`RID` **area_create** **(** **)** -Creates an :ref:`Area2D`. +Creates an :ref:`Area2D`. .. _class_Physics2DServer_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_Physics2DServer_area_get_shape: -- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const -Returns the :ref:`RID` of the nth shape of an area. +Returns the :ref:`RID` of the nth shape of an area. .. _class_Physics2DServer_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. .. _class_Physics2DServer_area_get_shape_transform: -- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. .. _class_Physics2DServer_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. .. _class_Physics2DServer_area_get_space_override_mode: -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. .. _class_Physics2DServer_area_get_transform: -- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. .. _class_Physics2DServer_area_remove_shape: -- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. .. _class_Physics2DServer_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** .. _class_Physics2DServer_area_set_collision_layer: -- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. .. _class_Physics2DServer_area_set_collision_mask: -- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. .. _class_Physics2DServer_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. -2: :ref:`RID` of the object that entered/exited the area. +2: :ref:`RID` of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. @@ -471,231 +469,231 @@ Sets the function to call when any body/area enters or exits the area. This call .. _class_Physics2DServer_area_set_monitorable: -- void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +- void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** .. _class_Physics2DServer_area_set_param: -- void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** +- void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_Physics2DServer_area_set_shape: -- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** -Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. +Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_Physics2DServer_area_set_shape_disabled: -- void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** +- void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables a given shape in an area. .. _class_Physics2DServer_area_set_shape_transform: -- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for an area shape. .. _class_Physics2DServer_area_set_space: -- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. .. _class_Physics2DServer_area_set_space_override_mode: -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** +- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. .. _class_Physics2DServer_area_set_transform: -- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** +- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Sets the transform matrix for an area. .. _class_Physics2DServer_body_add_central_force: -- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** +- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** .. _class_Physics2DServer_body_add_collision_exception: -- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. .. _class_Physics2DServer_body_add_force: -- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** +- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the applied force and torque. As with :ref:`body_apply_impulse`, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. .. _class_Physics2DServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_Physics2DServer_body_add_torque: -- void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** +- void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** .. _class_Physics2DServer_body_apply_central_impulse: -- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** +- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** .. _class_Physics2DServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. .. _class_Physics2DServer_body_apply_torque_impulse: -- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** +- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** .. _class_Physics2DServer_body_attach_object_instance_id: -- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** -Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. +Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_Physics2DServer_body_clear_shapes: -- void **body_clear_shapes** **(** :ref:`RID` body **)** +- void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. .. _class_Physics2DServer_body_create: -- :ref:`RID` **body_create** **(** **)** +- :ref:`RID` **body_create** **(** **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. .. _class_Physics2DServer_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. .. _class_Physics2DServer_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. .. _class_Physics2DServer_body_get_continuous_collision_detection_mode: -- :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const +- :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const Returns the continuous collision detection mode. .. _class_Physics2DServer_body_get_direct_state: -- :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** +- :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** -Returns the :ref:`Physics2DDirectBodyState` of the body. +Returns the :ref:`Physics2DDirectBodyState` of the body. .. _class_Physics2DServer_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. .. _class_Physics2DServer_body_get_mode: -- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. .. _class_Physics2DServer_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. .. _class_Physics2DServer_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_Physics2DServer_body_get_shape: -- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const -Returns the :ref:`RID` of the nth shape of a body. +Returns the :ref:`RID` of the nth shape of a body. .. _class_Physics2DServer_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. .. _class_Physics2DServer_body_get_shape_metadata: -- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Variant` **body_get_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the metadata of a shape of a body. .. _class_Physics2DServer_body_get_shape_transform: -- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform2D` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. .. _class_Physics2DServer_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const -Returns the :ref:`RID` of the space assigned to a body. +Returns the :ref:`RID` of the space assigned to a body. .. _class_Physics2DServer_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. .. _class_Physics2DServer_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_Physics2DServer_body_remove_collision_exception: -- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Removes a body from the list of bodies exempt from collisions. .. _class_Physics2DServer_body_remove_shape: -- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. .. _class_Physics2DServer_body_set_axis_velocity: -- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** +- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_Physics2DServer_body_set_collision_layer: -- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. .. _class_Physics2DServer_body_set_collision_mask: -- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. .. _class_Physics2DServer_body_set_continuous_collision_detection_mode: -- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** +- void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** Sets the continuous collision detection mode from any of the CCD_MODE\_\* constants. @@ -703,173 +701,173 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_Physics2DServer_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). .. _class_Physics2DServer_body_set_max_contacts_reported: -- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets 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. .. _class_Physics2DServer_body_set_mode: -- void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** +- void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. .. _class_Physics2DServer_body_set_omit_force_integration: -- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_Physics2DServer_body_set_param: -- void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** +- void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_Physics2DServer_body_set_shape: -- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** -Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. +Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_Physics2DServer_body_set_shape_as_one_way_collision: -- void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** +- void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** Enables one way collision on body if ``enable`` is ``true``. .. _class_Physics2DServer_body_set_shape_disabled: -- void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** +- void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** Disables shape in body if ``disable`` is ``true``. .. _class_Physics2DServer_body_set_shape_metadata: -- void **body_set_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** +- void **body_set_shape_metadata** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** Sets metadata of a shape within a body. This metadata is different from :ref:`Object.set_meta`, and can be retrieved on shape queries. .. _class_Physics2DServer_body_set_shape_transform: -- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** +- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** Sets the transform matrix for a body shape. .. _class_Physics2DServer_body_set_space: -- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`space_create`). .. _class_Physics2DServer_body_set_state: -- void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** +- void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). .. _class_Physics2DServer_body_test_motion: -- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** +- :ref:`bool` **body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`bool` infinite_inertia, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** -Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. +Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a :ref:`Physics2DTestMotionResult` can be passed to return additional information in. .. _class_Physics2DServer_capsule_shape_create: -- :ref:`RID` **capsule_shape_create** **(** **)** +- :ref:`RID` **capsule_shape_create** **(** **)** .. _class_Physics2DServer_circle_shape_create: -- :ref:`RID` **circle_shape_create** **(** **)** +- :ref:`RID` **circle_shape_create** **(** **)** .. _class_Physics2DServer_concave_polygon_shape_create: -- :ref:`RID` **concave_polygon_shape_create** **(** **)** +- :ref:`RID` **concave_polygon_shape_create** **(** **)** .. _class_Physics2DServer_convex_polygon_shape_create: -- :ref:`RID` **convex_polygon_shape_create** **(** **)** +- :ref:`RID` **convex_polygon_shape_create** **(** **)** .. _class_Physics2DServer_damped_spring_joint_create: -- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. .. _class_Physics2DServer_damped_string_joint_get_param: -- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const +- :ref:`float` **damped_string_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param **)** const Returns the value of a damped spring joint parameter. .. _class_Physics2DServer_damped_string_joint_set_param: -- void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** +- void **damped_string_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedStringParam` param, :ref:`float` value **)** Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING\* constants. .. _class_Physics2DServer_free_rid: -- void **free_rid** **(** :ref:`RID` rid **)** +- void **free_rid** **(** :ref:`RID` rid **)** -Destroys any of the objects created by Physics2DServer. If the :ref:`RID` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. +Destroys any of the objects created by Physics2DServer. If the :ref:`RID` passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. .. _class_Physics2DServer_get_process_info: -- :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** +- :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns information about the current state of the 2D physics engine. The states are listed under the INFO\_\* constants. .. _class_Physics2DServer_groove_joint_create: -- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. .. _class_Physics2DServer_joint_get_param: -- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const +- :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const Returns the value of a joint parameter. .. _class_Physics2DServer_joint_get_type: -- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of a joint (see JOINT\_\* constants). .. _class_Physics2DServer_joint_set_param: -- void **joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** +- void **joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** Sets a joint parameter. Parameters are explained in the JOINT_PARAM\* constants. .. _class_Physics2DServer_line_shape_create: -- :ref:`RID` **line_shape_create** **(** **)** +- :ref:`RID` **line_shape_create** **(** **)** .. _class_Physics2DServer_pin_joint_create: -- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** +- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. .. _class_Physics2DServer_ray_shape_create: -- :ref:`RID` **ray_shape_create** **(** **)** +- :ref:`RID` **ray_shape_create** **(** **)** .. _class_Physics2DServer_rectangle_shape_create: -- :ref:`RID` **rectangle_shape_create** **(** **)** +- :ref:`RID` **rectangle_shape_create** **(** **)** .. _class_Physics2DServer_segment_shape_create: -- :ref:`RID` **segment_shape_create** **(** **)** +- :ref:`RID` **segment_shape_create** **(** **)** .. _class_Physics2DServer_set_active: @@ -879,55 +877,55 @@ Activates or deactivates the 2D physics engine. .. _class_Physics2DServer_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. .. _class_Physics2DServer_shape_get_type: -- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). .. _class_Physics2DServer_shape_set_data: -- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. .. _class_Physics2DServer_space_create: -- :ref:`RID` **space_create** **(** **)** +- :ref:`RID` **space_create** **(** **)** Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. .. _class_Physics2DServer_space_get_direct_state: -- :ref:`Physics2DDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** +- :ref:`Physics2DDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** -Returns the state of a space, a :ref:`Physics2DDirectSpaceState`. This object can be used to make collision/intersection queries. +Returns the state of a space, a :ref:`Physics2DDirectSpaceState`. This object can be used to make collision/intersection queries. .. _class_Physics2DServer_space_get_param: -- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. .. _class_Physics2DServer_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. .. _class_Physics2DServer_space_set_active: -- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. .. _class_Physics2DServer_space_set_param: -- void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** +- void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. diff --git a/classes/class_physics2dserversw.rst b/classes/class_physics2dserversw.rst index 950719391..0eab65c6a 100644 --- a/classes/class_physics2dserversw.rst +++ b/classes/class_physics2dserversw.rst @@ -7,17 +7,16 @@ Physics2DServerSW ================= -**Inherits:** :ref:`Physics2DServer` **<** :ref:`Object` - +**Inherits:** :ref:`Physics2DServer` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Software implementation of :ref:`Physics2DServer`. +Software implementation of :ref:`Physics2DServer`. Description ----------- -This class exposes no new methods or properties and should not be used, as :ref:`Physics2DServer` automatically selects the best implementation available. +This class exposes no new methods or properties and should not be used, as :ref:`Physics2DServer` automatically selects the best implementation available. diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 8007920ea..ef31d9f63 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -7,8 +7,7 @@ Physics2DShapeQueryParameters ============================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,28 @@ Brief Description Parameters to be sent to a 2D shape physics query. -Member Functions ----------------- +Methods +------- +-------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +-------+-------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +This class contains the shape and other parameters for intersection/collision queries. + +Property Descriptions +--------------------- + + .. _class_Physics2DShapeQueryParameters_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + + .. _class_Physics2DShapeQueryParameters_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** .. _class_Physics2DShapeQueryParameters_collision_layer: @@ -32,7 +44,7 @@ Member Variables .. _class_Physics2DShapeQueryParameters_exclude: -- :ref:`Array` **exclude** - The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. +- :ref:`Array` **exclude** - The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_margin: @@ -40,29 +52,24 @@ Member Variables .. _class_Physics2DShapeQueryParameters_motion: -- :ref:`Vector2` **motion** - The motion of the shape being queried for. +- :ref:`Vector2` **motion** - The motion of the shape being queried for. .. _class_Physics2DShapeQueryParameters_shape_rid: -- :ref:`RID` **shape_rid** - The :ref:`RID` of the queried shape. See :ref:`set_shape` also. +- :ref:`RID` **shape_rid** - The :ref:`RID` of the queried shape. See :ref:`set_shape` also. .. _class_Physics2DShapeQueryParameters_transform: -- :ref:`Transform2D` **transform** - the transform matrix of the queried shape. +- :ref:`Transform2D` **transform** - the transform matrix of the queried shape. -Description ------------ - -This class contains the shape and other parameters for intersection/collision queries. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Physics2DShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Resource` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** -Set the :ref:`Shape2D` that will be used for collision/intersection queries. +Set the :ref:`Shape2D` that will be used for collision/intersection queries. diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index a616ca27d..7f24e9177 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -7,8 +7,7 @@ Physics2DShapeQueryResult ========================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_count` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Physics2DShapeQueryResult_get_result_count: @@ -40,7 +39,7 @@ Member Function Description .. _class_Physics2DShapeQueryResult_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const .. _class_Physics2DShapeQueryResult_get_result_object_id: @@ -52,6 +51,6 @@ Member Function Description .. _class_Physics2DShapeQueryResult_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 164fc8f32..53c978622 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -7,8 +7,7 @@ Physics2DTestMotionResult ========================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,12 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_Physics2DTestMotionResult_collider: -- :ref:`Object` **collider** +- :ref:`Object` **collider** .. _class_Physics2DTestMotionResult_collider_id: @@ -29,7 +28,7 @@ Member Variables .. _class_Physics2DTestMotionResult_collider_rid: -- :ref:`RID` **collider_rid** +- :ref:`RID` **collider_rid** .. _class_Physics2DTestMotionResult_collider_shape: @@ -37,22 +36,22 @@ Member Variables .. _class_Physics2DTestMotionResult_collider_velocity: -- :ref:`Vector2` **collider_velocity** +- :ref:`Vector2` **collider_velocity** .. _class_Physics2DTestMotionResult_collision_normal: -- :ref:`Vector2` **collision_normal** +- :ref:`Vector2` **collision_normal** .. _class_Physics2DTestMotionResult_collision_point: -- :ref:`Vector2` **collision_point** +- :ref:`Vector2` **collision_point** .. _class_Physics2DTestMotionResult_motion: -- :ref:`Vector2` **motion** +- :ref:`Vector2` **motion** .. _class_Physics2DTestMotionResult_motion_remainder: -- :ref:`Vector2` **motion_remainder** +- :ref:`Vector2` **motion_remainder** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index ed8c9c630..7fda010a8 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -7,10 +7,8 @@ PhysicsBody =========== -**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`PhysicalBone`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` - +**Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`PhysicalBone`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` **Category:** Core Brief Description @@ -18,25 +16,35 @@ Brief Description Base class for all objects affected by physics in 3D space. -Member Functions ----------------- +Methods +------- +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it. + +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + +Property Descriptions +--------------------- .. _class_PhysicsBody_collision_layer: @@ -51,22 +59,12 @@ A contact is detected if object A is in any of the layers that object B scans, o - :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. -Description ------------ - -PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it. - -Tutorials ---------- - -- :doc:`../tutorials/physics/physics_introduction` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsBody_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`Node` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. @@ -80,7 +78,7 @@ Adds a body to the list of bodies that this body can't collide with. .. _class_PhysicsBody_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`Node` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 4c86fb4fd..58ab1d4a5 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -7,10 +7,8 @@ PhysicsBody2D ============= -**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`RigidBody2D`, :ref:`StaticBody2D`, :ref:`KinematicBody2D` - +**Inherits:** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`RigidBody2D`, :ref:`StaticBody2D`, :ref:`KinematicBody2D` **Category:** Core Brief Description @@ -18,25 +16,35 @@ Brief Description Base class for all objects affected by physics in 2D space. -Member Functions ----------------- +Methods +------- +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +PhysicsBody2D is an abstract base class for implementing a physics body. All \*Body2D types inherit from it. + +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + +Property Descriptions +--------------------- .. _class_PhysicsBody2D_collision_layer: @@ -55,22 +63,12 @@ A contact is detected if object A is in any of the layers that object B scans, o - :ref:`int` **layers** - Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. -Description ------------ - -PhysicsBody2D is an abstract base class for implementing a physics body. All \*Body2D types inherit from it. - -Tutorials ---------- - -- :doc:`../tutorials/physics/physics_introduction` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsBody2D_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`Node` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. @@ -88,7 +86,7 @@ Return an individual bit on the collision mask. .. _class_PhysicsBody2D_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`Node` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 4e71dab1d..ac7d97a55 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -7,10 +7,8 @@ PhysicsDirectBodyState ====================== -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`BulletPhysicsDirectBodyState` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`BulletPhysicsDirectBodyState` **Category:** Core Brief Description @@ -18,63 +16,63 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | +| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | +| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` j **)** | +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` j **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` j **)** | +| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` j **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_count` **(** **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_contact_impulse` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | +| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | +| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`integrate_forces` **(** **)** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_PhysicsDirectBodyState_angular_velocity: -- :ref:`Vector3` **angular_velocity** - The angular velocity of the body. +- :ref:`Vector3` **angular_velocity** - The angular velocity of the body. .. _class_PhysicsDirectBodyState_center_of_mass: -- :ref:`Vector3` **center_of_mass** +- :ref:`Vector3` **center_of_mass** .. _class_PhysicsDirectBodyState_inverse_inertia: -- :ref:`Vector3` **inverse_inertia** - The inverse of the inertia of the body. +- :ref:`Vector3` **inverse_inertia** - The inverse of the inertia of the body. .. _class_PhysicsDirectBodyState_inverse_mass: @@ -82,11 +80,11 @@ Member Variables .. _class_PhysicsDirectBodyState_linear_velocity: -- :ref:`Vector3` **linear_velocity** - The linear velocity of the body. +- :ref:`Vector3` **linear_velocity** - The linear velocity of the body. .. _class_PhysicsDirectBodyState_principal_inertia_axes: -- :ref:`Basis` **principal_inertia_axes** +- :ref:`Basis` **principal_inertia_axes** .. _class_PhysicsDirectBodyState_sleeping: @@ -102,7 +100,7 @@ Member Variables .. _class_PhysicsDirectBodyState_total_gravity: -- :ref:`Vector3` **total_gravity** - The total gravity vector being currently applied to this body. +- :ref:`Vector3` **total_gravity** - The total gravity vector being currently applied to this body. .. _class_PhysicsDirectBodyState_total_linear_damp: @@ -110,39 +108,55 @@ Member Variables .. _class_PhysicsDirectBodyState_transform: -- :ref:`Transform` **transform** - The transformation matrix of the body. +- :ref:`Transform` **transform** - The transformation matrix of the body. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsDirectBodyState_add_central_force: -- void **add_central_force** **(** :ref:`Vector3` force **)** +- void **add_central_force** **(** :ref:`Vector3` force **)** + +Adds a constant directional force without affecting rotation. + +This is equivalent to ``add_force(force, Vector3(0,0,0))``. .. _class_PhysicsDirectBodyState_add_force: -- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** +- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** + +Adds a constant force (i.e. acceleration). .. _class_PhysicsDirectBodyState_add_torque: -- void **add_torque** **(** :ref:`Vector3` torque **)** +- void **add_torque** **(** :ref:`Vector3` torque **)** + +Adds a constant rotational force (i.e. a motor) without affecting position. .. _class_PhysicsDirectBodyState_apply_central_impulse: -- void **apply_central_impulse** **(** :ref:`Vector3` j **)** +- void **apply_central_impulse** **(** :ref:`Vector3` j **)** + +Applies a single directional impulse without affecting rotation. + +This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. .. _class_PhysicsDirectBodyState_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** + +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 position are in global coordinates, and the position is relative to the object's origin. .. _class_PhysicsDirectBodyState_apply_torque_impulse: -- void **apply_torque_impulse** **(** :ref:`Vector3` j **)** +- void **apply_torque_impulse** **(** :ref:`Vector3` j **)** + +Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. .. _class_PhysicsDirectBodyState_get_contact_collider: -- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const +- :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_id: @@ -150,11 +164,11 @@ Member Function Description .. _class_PhysicsDirectBodyState_get_contact_collider_object: -- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const +- :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_position: -- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_shape: @@ -162,7 +176,7 @@ Member Function Description .. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_count: @@ -176,11 +190,11 @@ Impulse created by the contact. Only implemented for Bullet physics. .. _class_PhysicsDirectBodyState_get_contact_local_normal: -- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_local_position: -- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_local_shape: @@ -188,7 +202,7 @@ Impulse created by the contact. Only implemented for Bullet physics. .. _class_PhysicsDirectBodyState_get_space_state: -- :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** +- :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** .. _class_PhysicsDirectBodyState_integrate_forces: diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 323a85c1a..977b6ad74 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -7,80 +7,79 @@ PhysicsDirectSpaceState ======================= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- -Direct access object to a space in the :ref:`PhysicsServer`. +Direct access object to a space in the :ref:`PhysicsServer`. -Member Functions ----------------- +Methods +------- -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | -+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`cast_motion` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`collide_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Direct access object to a space in the :ref:`PhysicsServer`. It's used mainly to do queries against objects and areas residing in a given space. +Direct access object to a space in the :ref:`PhysicsServer`. It's used mainly to do queries against objects and areas residing in a given space. Tutorials --------- - :doc:`../tutorials/physics/ray-casting` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsDirectSpaceState_cast_motion: -- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** +- :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** Checks whether the shape can travel to a point. The method will return an array with two floats between 0 and 1, both representing a fraction of ``motion``. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be 1, 1. -If the shape can not move, the array will be empty (``dir.empty()==true``). +If the shape can not move, the array will be empty. .. _class_PhysicsDirectSpaceState_collide_shape: -- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. +Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape`, the number of returned results can be limited to save processing time. .. _class_PhysicsDirectSpaceState_get_rest_info: -- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** +- :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: +Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: ``collider_id``: The colliding object's ID. -``linear_velocity``: The colliding object's velocity :ref:`Vector3`. If the object is an :ref:`Area`, the result is ``(0, 0, 0)``. +``linear_velocity``: The colliding object's velocity :ref:`Vector3`. If the object is an :ref:`Area`, the result is ``(0, 0, 0)``. ``normal``: The object's surface normal at the intersection point. ``point``: The intersection point. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. -If the shape did not intersect anything, then an empty dictionary (``dir.empty()==true``) is returned instead. +If the shape did not intersect anything, then an empty dictionary is returned instead. .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_layer=2147483647 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[ ], :ref:`int` collision_mask=2147483647, :ref:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** Intersects a ray in a given space. The returned object is a dictionary with the following fields: @@ -92,25 +91,25 @@ Intersects a ray in a given space. The returned object is a dictionary with the ``position``: The intersection point. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. -If the ray did not intersect anything, then an empty dictionary (``dir.empty()==true``) is returned instead. +If the ray did not intersect anything, then an empty dictionary is returned instead. -Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. +Additionally, the method can take an ``exclude`` array of objects or :ref:`RID`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody`\ s or :ref:`Area`\ s, respectively. .. _class_PhysicsDirectSpaceState_intersect_shape: -- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** +- :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: +Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: ``collider``: The colliding object. ``collider_id``: The colliding object's ID. -``rid``: The intersecting object's :ref:`RID`. +``rid``: The intersecting object's :ref:`RID`. ``shape``: The shape index of the colliding shape. diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 082c434d4..b79823c16 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -7,17 +7,21 @@ PhysicsMaterial =============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- +A material for physics properties. +Description +----------- -Member Variables ----------------- +Provides a means of modifying the collision properties of a :ref:`PhysicsBody`. + +Property Descriptions +--------------------- .. _class_PhysicsMaterial_absorbent: @@ -25,11 +29,11 @@ Member Variables .. _class_PhysicsMaterial_bounce: -- :ref:`float` **bounce** +- :ref:`float` **bounce** - The body's bounciness. Default value: ``0``. .. _class_PhysicsMaterial_friction: -- :ref:`float` **friction** +- :ref:`float` **friction** - The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. .. _class_PhysicsMaterial_rough: diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 70c1aa1ce..0ce7a576b 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -7,10 +7,8 @@ PhysicsServer ============= -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`BulletPhysicsServer` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`BulletPhysicsServer` **Category:** Core Brief Description @@ -18,235 +16,235 @@ Brief Description Server interface for low level physics access. -Member Functions ----------------- +Methods +------- +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +| void | :ref:`area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +| void | :ref:`area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +| void | :ref:`area_clear_shapes` **(** :ref:`RID` area **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_create` **(** **)** | +| :ref:`RID` | :ref:`area_create` **(** **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_object_instance_id` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +| :ref:`Variant` | :ref:`area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +| :ref:`int` | :ref:`area_get_shape_count` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +| :ref:`Transform` | :ref:`area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +| :ref:`RID` | :ref:`area_get_space` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +| :ref:`AreaSpaceOverrideMode` | :ref:`area_get_space_override_mode` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +| :ref:`Transform` | :ref:`area_get_transform` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | +| :ref:`bool` | :ref:`area_is_ray_pickable` **(** :ref:`RID` area **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +| void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +| void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | +| void | :ref:`area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | +| void | :ref:`area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | +| void | :ref:`area_set_ray_pickable` **(** :ref:`RID` area, :ref:`bool` enable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | +| void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | +| void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | +| void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | +| void | :ref:`area_set_space_override_mode` **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | +| void | :ref:`area_set_transform` **(** :ref:`RID` area, :ref:`Transform` transform **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | +| void | :ref:`body_add_central_force` **(** :ref:`RID` body, :ref:`Vector3` force **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +| void | :ref:`body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | +| void | :ref:`body_add_force` **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +| void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | +| void | :ref:`body_add_torque` **(** :ref:`RID` body, :ref:`Vector3` torque **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +| void | :ref:`body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +| void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +| void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +| void | :ref:`body_clear_shapes` **(** :ref:`RID` body **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_create` **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** | +| :ref:`RID` | :ref:`body_create` **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +| :ref:`PhysicsDirectBodyState` | :ref:`body_get_direct_state` **(** :ref:`RID` body **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** const | +| :ref:`float` | :ref:`body_get_kinematic_safe_margin` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +| :ref:`BodyMode` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_object_instance_id` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +| :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +| :ref:`int` | :ref:`body_get_shape_count` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +| :ref:`Transform` | :ref:`body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +| :ref:`RID` | :ref:`body_get_space` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +| :ref:`Variant` | :ref:`body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const | +| :ref:`bool` | :ref:`body_is_axis_locked` **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_continuous_collision_detection_enabled` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | +| :ref:`bool` | :ref:`body_is_ray_pickable` **(** :ref:`RID` body **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +| void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | +| void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | +| void | :ref:`body_set_axis_lock` **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | +| void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +| void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | +| void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +| void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | +| void | :ref:`body_set_kinematic_safe_margin` **(** :ref:`RID` body, :ref:`float` margin **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +| void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | +| void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | +| void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | +| void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | +| void | :ref:`body_set_ray_pickable` **(** :ref:`RID` body, :ref:`bool` enable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | +| void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | +| void | :ref:`body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | +| void | :ref:`body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | +| void | :ref:`body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const | +| :ref:`float` | :ref:`cone_twist_joint_get_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | +| void | :ref:`cone_twist_joint_set_param` **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** | +| :ref:`bool` | :ref:`generic_6dof_joint_get_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** | +| :ref:`float` | :ref:`generic_6dof_joint_get_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | +| void | :ref:`generic_6dof_joint_set_flag` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | +| void | :ref:`generic_6dof_joint_set_param` **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | +| :ref:`int` | :ref:`get_process_info` **(** :ref:`ProcessInfo` process_info **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const | +| :ref:`bool` | :ref:`hinge_joint_get_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const | +| :ref:`float` | :ref:`hinge_joint_get_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | +| void | :ref:`hinge_joint_set_flag` **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | +| void | :ref:`hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +| :ref:`RID` | :ref:`joint_create_cone_twist` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +| :ref:`RID` | :ref:`joint_create_generic_6dof` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | +| :ref:`RID` | :ref:`joint_create_hinge` **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | +| :ref:`RID` | :ref:`joint_create_pin` **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +| :ref:`RID` | :ref:`joint_create_slider` **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | +| :ref:`int` | :ref:`joint_get_solver_priority` **(** :ref:`RID` joint **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +| :ref:`JointType` | :ref:`joint_get_type` **(** :ref:`RID` joint **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | +| void | :ref:`joint_set_solver_priority` **(** :ref:`RID` joint, :ref:`int` priority **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_a` **(** :ref:`RID` joint **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | +| :ref:`Vector3` | :ref:`pin_joint_get_local_b` **(** :ref:`RID` joint **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const | +| :ref:`float` | :ref:`pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | +| void | :ref:`pin_joint_set_local_a` **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | +| void | :ref:`pin_joint_set_local_b` **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | +| void | :ref:`pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | +| :ref:`RID` | :ref:`shape_create` **(** :ref:`ShapeType` type **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +| :ref:`Variant` | :ref:`shape_get_data` **(** :ref:`RID` shape **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +| :ref:`ShapeType` | :ref:`shape_get_type` **(** :ref:`RID` shape **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +| void | :ref:`shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const | +| :ref:`float` | :ref:`slider_joint_get_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | +| void | :ref:`slider_joint_set_param` **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`space_create` **(** **)** | +| :ref:`RID` | :ref:`space_create` **(** **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +| :ref:`PhysicsDirectSpaceState` | :ref:`space_get_direct_state` **(** :ref:`RID` space **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +| :ref:`float` | :ref:`space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +| :ref:`bool` | :ref:`space_is_active` **(** :ref:`RID` space **)** const | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +| void | :ref:`space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | +| void | :ref:`space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** | +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_PhysicsServer_BodyState: @@ -291,15 +289,15 @@ enum **ProcessInfo** enum **ShapeType** -- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. -- **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. -- **SHAPE_SPHERE** = **2** --- The :ref:`Shape` is a :ref:`SphereShape`. -- **SHAPE_BOX** = **3** --- The :ref:`Shape` is a :ref:`BoxShape`. -- **SHAPE_CAPSULE** = **4** --- The :ref:`Shape` is a :ref:`CapsuleShape`. -- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape` is a :ref:`CylinderShape`. -- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. -- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. -- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. +- **SHAPE_PLANE** = **0** --- The :ref:`Shape` is a :ref:`PlaneShape`. +- **SHAPE_RAY** = **1** --- The :ref:`Shape` is a :ref:`RayShape`. +- **SHAPE_SPHERE** = **2** --- The :ref:`Shape` is a :ref:`SphereShape`. +- **SHAPE_BOX** = **3** --- The :ref:`Shape` is a :ref:`BoxShape`. +- **SHAPE_CAPSULE** = **4** --- The :ref:`Shape` is a :ref:`CapsuleShape`. +- **SHAPE_CYLINDER** = **5** --- The :ref:`Shape` is a :ref:`CylinderShape`. +- **SHAPE_CONVEX_POLYGON** = **6** --- The :ref:`Shape` is a :ref:`ConvexPolygonShape`. +- **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. +- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. - **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. .. _enum_PhysicsServer_HingeJointFlag: @@ -391,11 +389,11 @@ enum **BodyAxis** enum **JointType** -- **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. -- **JOINT_HINGE** = **1** --- The :ref:`Joint` is a :ref:`HingeJoint`. -- **JOINT_SLIDER** = **2** --- The :ref:`Joint` is a :ref:`SliderJoint`. -- **JOINT_CONE_TWIST** = **3** --- The :ref:`Joint` is a :ref:`ConeTwistJoint`. -- **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. +- **JOINT_PIN** = **0** --- The :ref:`Joint` is a :ref:`PinJoint`. +- **JOINT_HINGE** = **1** --- The :ref:`Joint` is a :ref:`HingeJoint`. +- **JOINT_SLIDER** = **2** --- The :ref:`Joint` is a :ref:`SliderJoint`. +- **JOINT_CONE_TWIST** = **3** --- The :ref:`Joint` is a :ref:`ConeTwistJoint`. +- **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. .. _enum_PhysicsServer_AreaSpaceOverrideMode: @@ -452,7 +450,7 @@ enum **ConeTwistJointParam** The swing span defines, how much rotation will not get corrected allong the swing axis. -Could be defined as looseness in the :ref:`ConeTwistJoint`. +Could be defined as looseness in the :ref:`ConeTwistJoint`. If below 0.05, this behaviour is locked. Default value: ``PI/4``. - **CONE_TWIST_JOINT_TWIST_SPAN** = **1** --- Twist is the rotation around the twist axis, this value defined how far the joint can twist. @@ -483,118 +481,118 @@ Description Everything related to physics in 3D. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsServer_area_add_shape: -- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** +- void **area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_PhysicsServer_area_attach_object_instance_id: -- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +- void **area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** -Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. +Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_PhysicsServer_area_clear_shapes: -- void **area_clear_shapes** **(** :ref:`RID` area **)** +- void **area_clear_shapes** **(** :ref:`RID` area **)** Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. .. _class_PhysicsServer_area_create: -- :ref:`RID` **area_create** **(** **)** +- :ref:`RID` **area_create** **(** **)** -Creates an :ref:`Area`. +Creates an :ref:`Area`. .. _class_PhysicsServer_area_get_object_instance_id: -- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_object_instance_id** **(** :ref:`RID` area **)** const Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_area_get_param: -- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const +- :ref:`Variant` **area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** const Returns an area parameter value. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_PhysicsServer_area_get_shape: -- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const -Returns the :ref:`RID` of the nth shape of an area. +Returns the :ref:`RID` of the nth shape of an area. .. _class_PhysicsServer_area_get_shape_count: -- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const +- :ref:`int` **area_get_shape_count** **(** :ref:`RID` area **)** const Returns the number of shapes assigned to an area. .. _class_PhysicsServer_area_get_shape_transform: -- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const +- :ref:`Transform` **area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the transform matrix of a shape within an area. .. _class_PhysicsServer_area_get_space: -- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const +- :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. .. _class_PhysicsServer_area_get_space_override_mode: -- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const +- :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. .. _class_PhysicsServer_area_get_transform: -- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const +- :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. .. _class_PhysicsServer_area_is_ray_pickable: -- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const +- :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const If ``true`` area collides with rays. .. _class_PhysicsServer_area_remove_shape: -- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +- void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** Removes a shape from an area. It does not delete the shape, so it can be reassigned later. .. _class_PhysicsServer_area_set_area_monitor_callback: -- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** .. _class_PhysicsServer_area_set_collision_layer: -- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** +- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** Assigns the area to one or many physics layers. .. _class_PhysicsServer_area_set_collision_mask: -- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** +- void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Sets which physics layers the area will monitor. .. _class_PhysicsServer_area_set_monitor_callback: -- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** +- void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. -2: :ref:`RID` of the object that entered/exited the area. +2: :ref:`RID` of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. @@ -604,117 +602,117 @@ Sets the function to call when any body/area enters or exits the area. This call .. _class_PhysicsServer_area_set_monitorable: -- void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +- void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** .. _class_PhysicsServer_area_set_param: -- void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** +- void **area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM\_\* constants. .. _class_PhysicsServer_area_set_ray_pickable: -- void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** +- void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** Sets object pickable with rays. .. _class_PhysicsServer_area_set_shape: -- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** -Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. +Substitutes a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_PhysicsServer_area_set_shape_transform: -- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** +- void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for an area shape. .. _class_PhysicsServer_area_set_space: -- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** +- void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. .. _class_PhysicsServer_area_set_space_override_mode: -- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** +- void **area_set_space_override_mode** **(** :ref:`RID` area, :ref:`AreaSpaceOverrideMode` mode **)** Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE\_\*. .. _class_PhysicsServer_area_set_transform: -- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** +- void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** Sets the transform matrix for an area. .. _class_PhysicsServer_body_add_central_force: -- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** +- void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** .. _class_PhysicsServer_body_add_collision_exception: -- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Adds a body to the list of bodies exempt from collisions. .. _class_PhysicsServer_body_add_force: -- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** +- void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** .. _class_PhysicsServer_body_add_shape: -- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** +- void **body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. .. _class_PhysicsServer_body_add_torque: -- void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** +- void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** .. _class_PhysicsServer_body_apply_central_impulse: -- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** +- void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** .. _class_PhysicsServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** Gives the body a push at a ``position`` in the direction of the ``impulse``. .. _class_PhysicsServer_body_apply_torque_impulse: -- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** +- void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** Gives the body a push to rotate it. .. _class_PhysicsServer_body_attach_object_instance_id: -- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +- void **body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** -Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. +Assigns the area to a descendant of :ref:`Object`, so it can exist in the node tree. .. _class_PhysicsServer_body_clear_shapes: -- void **body_clear_shapes** **(** :ref:`RID` body **)** +- void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. .. _class_PhysicsServer_body_create: -- :ref:`RID` **body_create** **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** +- :ref:`RID` **body_create** **(** :ref:`BodyMode` mode=2, :ref:`bool` init_sleeping=false **)** Creates a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. .. _class_PhysicsServer_body_get_collision_layer: -- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body belongs to. .. _class_PhysicsServer_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const Returns the physics layer or layers a body can collide with. @@ -722,93 +720,93 @@ Returns the physics layer or layers a body can collide with. .. _class_PhysicsServer_body_get_direct_state: -- :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** +- :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** -Returns the :ref:`PhysicsDirectBodyState` of the body. +Returns the :ref:`PhysicsDirectBodyState` of the body. .. _class_PhysicsServer_body_get_kinematic_safe_margin: -- :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const +- :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const .. _class_PhysicsServer_body_get_max_contacts_reported: -- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_max_contacts_reported** **(** :ref:`RID` body **)** const Returns the maximum contacts that can be reported. See :ref:`body_set_max_contacts_reported`. .. _class_PhysicsServer_body_get_mode: -- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const +- :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. .. _class_PhysicsServer_body_get_object_instance_id: -- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_object_instance_id** **(** :ref:`RID` body **)** const Gets the instance ID of the object the area is assigned to. .. _class_PhysicsServer_body_get_param: -- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const +- :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** const Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_PhysicsServer_body_get_shape: -- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const -Returns the :ref:`RID` of the nth shape of a body. +Returns the :ref:`RID` of the nth shape of a body. .. _class_PhysicsServer_body_get_shape_count: -- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const +- :ref:`int` **body_get_shape_count** **(** :ref:`RID` body **)** const Returns the number of shapes assigned to a body. .. _class_PhysicsServer_body_get_shape_transform: -- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const +- :ref:`Transform` **body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the transform matrix of a body shape. .. _class_PhysicsServer_body_get_space: -- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const +- :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const -Returns the :ref:`RID` of the space assigned to a body. +Returns the :ref:`RID` of the space assigned to a body. .. _class_PhysicsServer_body_get_state: -- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const +- :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. .. _class_PhysicsServer_body_is_axis_locked: -- :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const +- :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const .. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: -- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const If ``true`` the continuous collision detection mode is enabled. .. _class_PhysicsServer_body_is_omitting_force_integration: -- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_omitting_force_integration** **(** :ref:`RID` body **)** const Returns whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_PhysicsServer_body_is_ray_pickable: -- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const +- :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const If ``true`` the body can be detected by rays .. _class_PhysicsServer_body_remove_collision_exception: -- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** +- void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** Removes a body from the list of bodies exempt from collisions. @@ -816,35 +814,35 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_PhysicsServer_body_remove_shape: -- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** +- void **body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. .. _class_PhysicsServer_body_set_axis_lock: -- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** +- void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** .. _class_PhysicsServer_body_set_axis_velocity: -- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** +- void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. .. _class_PhysicsServer_body_set_collision_layer: -- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** +- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** Sets the physics layer or layers a body belongs to. .. _class_PhysicsServer_body_set_collision_mask: -- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** +- void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** Sets the physics layer or layers a body can collide with. .. _class_PhysicsServer_body_set_enable_continuous_collision_detection: -- void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** If ``true`` the continuous collision detection mode is enabled. @@ -852,221 +850,221 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_PhysicsServer_body_set_force_integration_callback: -- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** +- void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=null **)** Sets the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force_integration`). .. _class_PhysicsServer_body_set_kinematic_safe_margin: -- void **body_set_kinematic_safe_margin** **(** :ref:`RID` body, :ref:`float` margin **)** +- void **body_set_kinematic_safe_margin** **(** :ref:`RID` body, :ref:`float` margin **)** .. _class_PhysicsServer_body_set_max_contacts_reported: -- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** +- void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** Sets 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. .. _class_PhysicsServer_body_set_mode: -- void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** +- void **body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** Sets the body mode, from one of the constants BODY_MODE\*. .. _class_PhysicsServer_body_set_omit_force_integration: -- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). .. _class_PhysicsServer_body_set_param: -- void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** +- void **body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`float` value **)** Sets a body parameter. A list of available parameters is on the BODY_PARAM\_\* constants. .. _class_PhysicsServer_body_set_ray_pickable: -- void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** +- void **body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** Sets the body pickable with rays if ``enabled`` is set. .. _class_PhysicsServer_body_set_shape: -- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** +- void **body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** -Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. +Substitutes a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. .. _class_PhysicsServer_body_set_shape_transform: -- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** +- void **body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform` transform **)** Sets the transform matrix for a body shape. .. _class_PhysicsServer_body_set_space: -- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** +- void **body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** Assigns a space to the body (see :ref:`create_space`). .. _class_PhysicsServer_body_set_state: -- void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** +- void **body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** Sets a body state (see BODY_STATE\* constants). .. _class_PhysicsServer_cone_twist_joint_get_param: -- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const +- :ref:`float` **cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** const Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). .. _class_PhysicsServer_cone_twist_joint_set_param: -- void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** +- void **cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT\* constants). .. _class_PhysicsServer_free_rid: -- void **free_rid** **(** :ref:`RID` rid **)** +- void **free_rid** **(** :ref:`RID` rid **)** -Destroys any of the objects created by PhysicsServer. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. +Destroys any of the objects created by PhysicsServer. If the :ref:`RID` passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. .. _class_PhysicsServer_generic_6dof_joint_get_flag: -- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** +- :ref:`bool` **generic_6dof_joint_get_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag **)** Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). .. _class_PhysicsServer_generic_6dof_joint_get_param: -- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** +- :ref:`float` **generic_6dof_joint_get_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param **)** Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). .. _class_PhysicsServer_generic_6dof_joint_set_flag: -- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** +- void **generic_6dof_joint_set_flag** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). .. _class_PhysicsServer_generic_6dof_joint_set_param: -- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** +- void **generic_6dof_joint_set_param** **(** :ref:`RID` joint, :ref:`Axis` axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). .. _class_PhysicsServer_get_process_info: -- :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** +- :ref:`int` **get_process_info** **(** :ref:`ProcessInfo` process_info **)** Returns an Info defined by the ProcessInfo input given. .. _class_PhysicsServer_hinge_joint_get_flag: -- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const +- :ref:`bool` **hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** const Gets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). .. _class_PhysicsServer_hinge_joint_get_param: -- :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const +- :ref:`float` **hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** const Gets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). .. _class_PhysicsServer_hinge_joint_set_flag: -- void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** +- void **hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** Sets a hinge_joint flag (see HINGE_JOINT_FLAG\* constants). .. _class_PhysicsServer_hinge_joint_set_param: -- void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** +- void **hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** Sets a hinge_joint parameter (see HINGE_JOINT\* constants without the HINGE_JOINT_FLAG\*). .. _class_PhysicsServer_joint_create_cone_twist: -- :ref:`RID` **joint_create_cone_twist** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_cone_twist** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** -Creates a :ref:`ConeTwistJoint`. +Creates a :ref:`ConeTwistJoint`. .. _class_PhysicsServer_joint_create_generic_6dof: -- :ref:`RID` **joint_create_generic_6dof** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_generic_6dof** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** -Creates a :ref:`Generic6DOFJoint`. +Creates a :ref:`Generic6DOFJoint`. .. _class_PhysicsServer_joint_create_hinge: -- :ref:`RID` **joint_create_hinge** **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** +- :ref:`RID` **joint_create_hinge** **(** :ref:`RID` body_A, :ref:`Transform` hinge_A, :ref:`RID` body_B, :ref:`Transform` hinge_B **)** -Creates a :ref:`HingeJoint`. +Creates a :ref:`HingeJoint`. .. _class_PhysicsServer_joint_create_pin: -- :ref:`RID` **joint_create_pin** **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** +- :ref:`RID` **joint_create_pin** **(** :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** -Creates a :ref:`PinJoint`. +Creates a :ref:`PinJoint`. .. _class_PhysicsServer_joint_create_slider: -- :ref:`RID` **joint_create_slider** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** +- :ref:`RID` **joint_create_slider** **(** :ref:`RID` body_A, :ref:`Transform` local_ref_A, :ref:`RID` body_B, :ref:`Transform` local_ref_B **)** -Creates a :ref:`SliderJoint`. +Creates a :ref:`SliderJoint`. .. _class_PhysicsServer_joint_get_solver_priority: -- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const +- :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const Gets the priority value of the Joint. .. _class_PhysicsServer_joint_get_type: -- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const +- :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of the Joint. .. _class_PhysicsServer_joint_set_solver_priority: -- void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** +- void **joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** Sets the priority value of the Joint. .. _class_PhysicsServer_pin_joint_get_local_a: -- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_a** **(** :ref:`RID` joint **)** const Returns position of the joint in the local space of body a of the joint. .. _class_PhysicsServer_pin_joint_get_local_b: -- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const +- :ref:`Vector3` **pin_joint_get_local_b** **(** :ref:`RID` joint **)** const Returns position of the joint in the local space of body b of the joint. .. _class_PhysicsServer_pin_joint_get_param: -- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const +- :ref:`float` **pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** const Gets a pin_joint parameter (see PIN_JOINT\* constants). .. _class_PhysicsServer_pin_joint_set_local_a: -- void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** +- void **pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** Sets position of the joint in the local space of body a of the joint. .. _class_PhysicsServer_pin_joint_set_local_b: -- void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** +- void **pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** Sets position of the joint in the local space of body b of the joint. .. _class_PhysicsServer_pin_joint_set_param: -- void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** +- void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** Sets a pin_joint parameter (see PIN_JOINT\* constants). @@ -1078,73 +1076,73 @@ Activates or deactivates the 3D physics engine. .. _class_PhysicsServer_shape_create: -- :ref:`RID` **shape_create** **(** :ref:`ShapeType` type **)** +- :ref:`RID` **shape_create** **(** :ref:`ShapeType` type **)** Creates a shape of type SHAPE\_\*. Does not assign it to a body or an area. To do so, you must use :ref:`area_set_shape` or :ref:`body_set_shape`. .. _class_PhysicsServer_shape_get_data: -- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const +- :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. .. _class_PhysicsServer_shape_get_type: -- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const +- :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). .. _class_PhysicsServer_shape_set_data: -- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** +- void **shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created :ref:`shape_get_type`. .. _class_PhysicsServer_slider_joint_get_param: -- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const +- :ref:`float` **slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** const Gets a slider_joint parameter (see SLIDER_JOINT\* constants). .. _class_PhysicsServer_slider_joint_set_param: -- void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** +- void **slider_joint_set_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** Gets a slider_joint parameter (see SLIDER_JOINT\* constants). .. _class_PhysicsServer_space_create: -- :ref:`RID` **space_create** **(** **)** +- :ref:`RID` **space_create** **(** **)** Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with :ref:`area_set_space`, or to a body with :ref:`body_set_space`. .. _class_PhysicsServer_space_get_direct_state: -- :ref:`PhysicsDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** +- :ref:`PhysicsDirectSpaceState` **space_get_direct_state** **(** :ref:`RID` space **)** -Returns the state of a space, a :ref:`PhysicsDirectSpaceState`. This object can be used to make collision/intersection queries. +Returns the state of a space, a :ref:`PhysicsDirectSpaceState`. This object can be used to make collision/intersection queries. .. _class_PhysicsServer_space_get_param: -- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const +- :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. .. _class_PhysicsServer_space_is_active: -- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const +- :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. .. _class_PhysicsServer_space_set_active: -- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** +- void **space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** Marks a space as active. It will not have an effect, unless it is assigned to an area or body. .. _class_PhysicsServer_space_set_param: -- void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** +- void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM\_\* constants. diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 982dace8d..157ec40ac 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -7,8 +7,7 @@ PhysicsShapeQueryParameters =========================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,23 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+-----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +| void | :ref:`set_shape` **(** :ref:`Resource` shape **)** | +-------+-----------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- + + .. _class_PhysicsShapeQueryParameters_collide_with_areas: + +- :ref:`bool` **collide_with_areas** + + .. _class_PhysicsShapeQueryParameters_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** .. _class_PhysicsShapeQueryParameters_collision_mask: @@ -32,7 +39,7 @@ Member Variables .. _class_PhysicsShapeQueryParameters_exclude: -- :ref:`Array` **exclude** +- :ref:`Array` **exclude** .. _class_PhysicsShapeQueryParameters_margin: @@ -40,18 +47,18 @@ Member Variables .. _class_PhysicsShapeQueryParameters_shape_rid: -- :ref:`RID` **shape_rid** +- :ref:`RID` **shape_rid** .. _class_PhysicsShapeQueryParameters_transform: -- :ref:`Transform` **transform** +- :ref:`Transform` **transform** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsShapeQueryParameters_set_shape: -- void **set_shape** **(** :ref:`Resource` shape **)** +- void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 55b81972f..5f483d3e3 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -7,8 +7,7 @@ PhysicsShapeQueryResult ======================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description Result of a shape query in Physics2DServer. -Member Functions ----------------- +Methods +------- +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_count` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | +| :ref:`Object` | :ref:`get_result_object` **(** :ref:`int` idx **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_object_id` **(** :ref:`int` idx **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_result_object_shape` **(** :ref:`int` idx **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | +| :ref:`RID` | :ref:`get_result_rid` **(** :ref:`int` idx **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PhysicsShapeQueryResult_get_result_count: @@ -40,7 +39,7 @@ Member Function Description .. _class_PhysicsShapeQueryResult_get_result_object: -- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const +- :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const .. _class_PhysicsShapeQueryResult_get_result_object_id: @@ -52,6 +51,6 @@ Member Function Description .. _class_PhysicsShapeQueryResult_get_result_rid: -- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const +- :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 456a9140a..8fd64ab07 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -7,8 +7,7 @@ PinJoint ======== -**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,28 +15,8 @@ Brief Description Pin Joint for 3D Shapes. -Member Variables ----------------- - - .. _class_PinJoint_params/bias: - -- :ref:`float` **params/bias** - The force with which the pinned objects stay in positional relation to each other. - -The higher, the stronger. - - .. _class_PinJoint_params/damping: - -- :ref:`float` **params/damping** - The force with which the pinned objects stay in velocity relation to each other. - -The higher, the stronger. - - .. _class_PinJoint_params/impulse_clamp: - -- :ref:`float` **params/impulse_clamp** - If above 0, this value is the maximum value for an impulse that this Joint produces. - - -Enums ------ +Enumerations +------------ .. _enum_PinJoint_Param: @@ -57,3 +36,23 @@ Description Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. +Property Descriptions +--------------------- + + .. _class_PinJoint_params/bias: + +- :ref:`float` **params/bias** - The force with which the pinned objects stay in positional relation to each other. + +The higher, the stronger. + + .. _class_PinJoint_params/damping: + +- :ref:`float` **params/damping** - The force with which the pinned objects stay in velocity relation to each other. + +The higher, the stronger. + + .. _class_PinJoint_params/impulse_clamp: + +- :ref:`float` **params/impulse_clamp** - If above 0, this value is the maximum value for an impulse that this Joint produces. + + diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 6f08ca527..c9437fc5c 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -7,8 +7,7 @@ PinJoint2D ========== -**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Pin Joint for 2D Shapes. -Member Variables ----------------- +Description +----------- + +Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. + +Property Descriptions +--------------------- .. _class_PinJoint2D_softness: - :ref:`float` **softness** - The higher this value, the more the bond to the pinned partner can flex. -Description ------------ - -Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. - diff --git a/classes/class_plane.rst b/classes/class_plane.rst index d88ab2ae5..0349033f3 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -14,39 +14,56 @@ Brief Description Plane in hessian form. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | +| :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | +| :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`center` **(** **)** | +| :ref:`Vector3` | :ref:`center` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | +| :ref:`Vector3` | :ref:`get_any_point` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | +| :ref:`Vector3` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | +| :ref:`Vector3` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | +| :ref:`Vector3` | :ref:`intersects_segment` **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | +| :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Plane` | :ref:`normalized` **(** **)** | +| :ref:`Plane` | :ref:`normalized` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- + +- **PLANE_YZ** = **Plane( 1, 0, 0, 0 )** +- **PLANE_XZ** = **Plane( 0, 1, 0, 0 )** +- **PLANE_XY** = **Plane( 0, 0, 1, 0 )** + +Description +----------- + +Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. + +Tutorials +--------- + +- :doc:`../tutorials/math/index` + +Property Descriptions +--------------------- .. _class_Plane_d: @@ -54,7 +71,7 @@ Member Variables .. _class_Plane_normal: -- :ref:`Vector3` **normal** +- :ref:`Vector3` **normal** .. _class_Plane_x: @@ -69,101 +86,84 @@ Member Variables - :ref:`float` **z** -Numeric Constants ------------------ - -- **X** = **Plane( 1, 0, 0, 0 )** -- **Y** = **Plane( 0, 1, 0, 0 )** -- **Z** = **Plane( 0, 0, 1, 0 )** - -Description ------------ - -Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. - -Tutorials ---------- - -- :doc:`../tutorials/math/index` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** +- :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** Creates a plane from the four parameters "a", "b", "c" and "d". .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** +- :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. .. _class_Plane_Plane: -- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** +- :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** Creates a plane from the normal and the plane's distance to the origin. .. _class_Plane_center: -- :ref:`Vector3` **center** **(** **)** +- :ref:`Vector3` **center** **(** **)** Returns the center of the plane. .. _class_Plane_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** +- :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** Returns the shortest distance from the plane to the position "point". .. _class_Plane_get_any_point: -- :ref:`Vector3` **get_any_point** **(** **)** +- :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. .. _class_Plane_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** +- :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** Returns true if "point" is inside the plane (by a very minimum threshold). .. _class_Plane_intersect_3: -- :ref:`Vector3` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** +- :ref:`Vector3` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. .. _class_Plane_intersects_ray: -- :ref:`Vector3` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** +- :ref:`Vector3` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. .. _class_Plane_intersects_segment: -- :ref:`Vector3` **intersects_segment** **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** +- :ref:`Vector3` **intersects_segment** **(** :ref:`Vector3` begin, :ref:`Vector3` end **)** Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. .. _class_Plane_is_point_over: -- :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** +- :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** Returns true if "point" is located above the plane. .. _class_Plane_normalized: -- :ref:`Plane` **normalized** **(** **)** +- :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. .. _class_Plane_project: -- :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** +- :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** Returns the orthogonal projection of point "p" into a point in the plane. diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 3345a3df3..09ba1bbc7 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -7,21 +7,25 @@ PlaneMesh ========= -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Class representing a planar :ref:`PrimitiveMesh`. +Class representing a planar :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Class representing a planar :ref:`PrimitiveMesh`. This flat mesh does not have a thickness. + +Property Descriptions +--------------------- .. _class_PlaneMesh_size: -- :ref:`Vector2` **size** - Size of the generated plane. Defaults to (2.0, 2.0). +- :ref:`Vector2` **size** - Size of the generated plane. Defaults to (2.0, 2.0). .. _class_PlaneMesh_subdivide_depth: @@ -32,8 +36,3 @@ Member Variables - :ref:`int` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0. -Description ------------ - -Class representing a planar :ref:`PrimitiveMesh`. This flat mesh does not have a thickness. - diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 0b23b9f3c..381618476 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -7,8 +7,7 @@ PlaneShape ========== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_PlaneShape_plane: -- :ref:`Plane` **plane** +- :ref:`Plane` **plane** diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index 57f9fd675..65cf8ae9c 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -7,8 +7,7 @@ PluginScript ============ -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 4fb6320ee..fb688f741 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -7,8 +7,7 @@ Polygon2D ========= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description A 2D polygon. -Member Functions ----------------- +Methods +------- +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | +| void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_bones` **(** **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,17 +27,22 @@ Member Functions +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count` **(** **)** const | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** const | +| :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** const | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** const | +| :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** const | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | +| void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | +| void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture. + +Property Descriptions +--------------------- .. _class_Polygon2D_antialiased: @@ -46,11 +50,11 @@ Member Variables .. _class_Polygon2D_bones: -- :ref:`Array` **bones** +- :ref:`Array` **bones** .. _class_Polygon2D_color: -- :ref:`Color` **color** - The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. +- :ref:`Color` **color** - The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``. .. _class_Polygon2D_invert_border: @@ -62,27 +66,27 @@ Member Variables .. _class_Polygon2D_offset: -- :ref:`Vector2` **offset** - The offset applied to each vertex. +- :ref:`Vector2` **offset** - The offset applied to each vertex. .. _class_Polygon2D_polygon: -- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. +- :ref:`PoolVector2Array` **polygon** - The polygon's list of vertices. The final point will be connected to the first. .. _class_Polygon2D_skeleton: -- :ref:`NodePath` **skeleton** +- :ref:`NodePath` **skeleton** .. _class_Polygon2D_splits: -- :ref:`PoolIntArray` **splits** +- :ref:`PoolIntArray` **splits** .. _class_Polygon2D_texture: -- :ref:`Texture` **texture** - The polygon's fill texture. Use ``uv`` to set texture coordinates. +- :ref:`Texture` **texture** - The polygon's fill texture. Use ``uv`` to set texture coordinates. .. _class_Polygon2D_texture_offset: -- :ref:`Vector2` **texture_offset** - Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. +- :ref:`Vector2` **texture_offset** - Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``. .. _class_Polygon2D_texture_rotation: @@ -94,28 +98,23 @@ Member Variables .. _class_Polygon2D_texture_scale: -- :ref:`Vector2` **texture_scale** - Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. +- :ref:`Vector2` **texture_scale** - Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. .. _class_Polygon2D_uv: -- :ref:`PoolVector2Array` **uv** - Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. +- :ref:`PoolVector2Array` **uv** - Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``. .. _class_Polygon2D_vertex_colors: -- :ref:`PoolColorArray` **vertex_colors** - Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. +- :ref:`PoolColorArray` **vertex_colors** - Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``. -Description ------------ - -A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Polygon2D_add_bone: -- void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** +- void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** .. _class_Polygon2D_clear_bones: @@ -131,18 +130,18 @@ Member Function Description .. _class_Polygon2D_get_bone_path: -- :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const +- :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const .. _class_Polygon2D_get_bone_weights: -- :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const +- :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const .. _class_Polygon2D_set_bone_path: -- void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** +- void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** .. _class_Polygon2D_set_bone_weights: -- void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** +- void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 95fa183bc..9233cf3fc 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -7,8 +7,7 @@ PolygonPathFinder ================= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,45 +15,45 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | +| :ref:`PoolVector2Array` | :ref:`find_path` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | +| :ref:`Rect2` | :ref:`get_bounds` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | +| :ref:`Vector2` | :ref:`get_closest_point` **(** :ref:`Vector2` point **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | +| :ref:`PoolVector2Array` | :ref:`get_intersections` **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_penalty` **(** :ref:`int` idx **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | +| :ref:`bool` | :ref:`is_point_inside` **(** :ref:`Vector2` point **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_penalty` **(** :ref:`int` idx, :ref:`float` penalty **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | +| void | :ref:`setup` **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PolygonPathFinder_find_path: -- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +- :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** .. _class_PolygonPathFinder_get_bounds: -- :ref:`Rect2` **get_bounds** **(** **)** const +- :ref:`Rect2` **get_bounds** **(** **)** const .. _class_PolygonPathFinder_get_closest_point: -- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const +- :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const .. _class_PolygonPathFinder_get_intersections: -- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const +- :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const .. _class_PolygonPathFinder_get_point_penalty: @@ -62,7 +61,7 @@ Member Function Description .. _class_PolygonPathFinder_is_point_inside: -- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const +- :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const .. _class_PolygonPathFinder_set_point_penalty: @@ -70,6 +69,6 @@ Member Function Description .. _class_PolygonPathFinder_setup: -- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** +- void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index cac7dad81..73b51a151 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -14,23 +14,23 @@ Brief Description Raw byte array. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | +| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`append` **(** :ref:`int` byte **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | +| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | +| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,7 +46,7 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | +| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -54,12 +54,12 @@ Description Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolByteArray_PoolByteArray: -- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** +- :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** Create from a generic array. @@ -71,33 +71,33 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** +- void **append_array** **(** :ref:`PoolByteArray` array **)** Append a ``PoolByteArray`` at the end of this array. .. _class_PoolByteArray_compress: -- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** +- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** -Returns a new ``PoolByteArray`` with the data compressed. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. +Returns a new ``PoolByteArray`` with the data compressed. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_decompress: -- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** +- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** -Returns a new ``PoolByteArray`` with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. +Returns a new ``PoolByteArray`` with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_get_string_from_ascii: -- :ref:`String` **get_string_from_ascii** **(** **)** +- :ref:`String` **get_string_from_ascii** **(** **)** -Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`PoolByteArray.get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`PoolByteArray.get_string_from_utf8`. +Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`PoolByteArray.get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`PoolByteArray.get_string_from_utf8`. .. _class_PoolByteArray_get_string_from_utf8: -- :ref:`String` **get_string_from_utf8** **(** **)** +- :ref:`String` **get_string_from_utf8** **(** **)** -Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`PoolByteArray.get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. +Returns a copy of the array's contents as :ref:`String`. Slower than :ref:`PoolByteArray.get_string_from_ascii` but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. .. _class_PoolByteArray_insert: @@ -109,7 +109,7 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolByteArray_push_back: @@ -143,7 +143,7 @@ Return the size of the array. .. _class_PoolByteArray_subarray: -- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** +- :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** Returns the slice of the ``PoolByteArray`` between indices (inclusive) as a new ``PoolByteArray``. Any negative index is considered to be from the end of the array. diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index c397a2593..0bc442589 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -14,27 +14,27 @@ Brief Description Array of Colors -Member Functions ----------------- +Methods +------- +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | +| :ref:`PoolColorArray` | :ref:`PoolColorArray` **(** :ref:`Array` from **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Color` color **)** | +| void | :ref:`append` **(** :ref:`Color` color **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolColorArray` array **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Color` color **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Color` color **)** | +| void | :ref:`push_back` **(** :ref:`Color` color **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove` **(** :ref:`int` idx **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` idx **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Color` color **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ @@ -44,30 +44,30 @@ Description Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolColorArray_PoolColorArray: -- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** +- :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolColorArray_append: -- void **append** **(** :ref:`Color` color **)** +- void **append** **(** :ref:`Color` color **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolColorArray_append_array: -- void **append_array** **(** :ref:`PoolColorArray` array **)** +- void **append_array** **(** :ref:`PoolColorArray` array **)** Append a ``PoolColorArray`` at the end of this array. .. _class_PoolColorArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Color` color **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). @@ -75,11 +75,11 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolColorArray_push_back: -- void **push_back** **(** :ref:`Color` color **)** +- void **push_back** **(** :ref:`Color` color **)** Append a value to the array. @@ -97,9 +97,9 @@ Set the size of the array. If the array is grown reserve elements at the end of .. _class_PoolColorArray_set: -- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** +- void **set** **(** :ref:`int` idx, :ref:`Color` color **)** -Change the :ref:`Color` at the given index. +Change the :ref:`Color` at the given index. .. _class_PoolColorArray_size: diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 3d19b961f..94ca55a23 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -14,15 +14,15 @@ Brief Description Integer Array. -Member Functions ----------------- +Methods +------- +------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | +| :ref:`PoolIntArray` | :ref:`PoolIntArray` **(** :ref:`Array` from **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | void | :ref:`append` **(** :ref:`int` integer **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolIntArray` array **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` integer **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------+ @@ -44,12 +44,12 @@ Description Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolIntArray_PoolIntArray: -- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** +- :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** Create from a generic array. @@ -61,7 +61,7 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** +- void **append_array** **(** :ref:`PoolIntArray` array **)** Append an ``PoolIntArray`` at the end of this array. @@ -75,7 +75,7 @@ Insert a new int at a given position in the array. The position must be valid, o - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolIntArray_push_back: diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 2a14ea3a3..b5afe314b 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -14,15 +14,15 @@ Brief Description Real Array. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | +| :ref:`PoolRealArray` | :ref:`PoolRealArray` **(** :ref:`Array` from **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`append` **(** :ref:`float` value **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolRealArray` array **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`float` value **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ @@ -44,12 +44,12 @@ Description Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolRealArray_PoolRealArray: -- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** +- :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** Create from a generic array. @@ -61,7 +61,7 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** +- void **append_array** **(** :ref:`PoolRealArray` array **)** Append an RealArray at the end of this array. @@ -75,7 +75,7 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolRealArray_push_back: diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 0e1fb7b94..129b9eb98 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -14,29 +14,29 @@ Brief Description String Array. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | +| :ref:`PoolStringArray` | :ref:`PoolStringArray` **(** :ref:`Array` from **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`String` string **)** | +| void | :ref:`append` **(** :ref:`String` string **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolStringArray` array **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`String` string **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | +| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`String` string **)** | +| void | :ref:`push_back` **(** :ref:`String` string **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove` **(** :ref:`int` idx **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` idx **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`String` string **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ @@ -46,30 +46,30 @@ Description String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolStringArray_PoolStringArray: -- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** +- :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** Create from a generic array. .. _class_PoolStringArray_append: -- void **append** **(** :ref:`String` string **)** +- void **append** **(** :ref:`String` string **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolStringArray_append_array: -- void **append_array** **(** :ref:`PoolStringArray` array **)** +- void **append_array** **(** :ref:`PoolStringArray` array **)** Append an StringArray at the end of this array. .. _class_PoolStringArray_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`String` string **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). @@ -77,17 +77,17 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolStringArray_join: -- :ref:`String` **join** **(** :ref:`String` delimiter **)** +- :ref:`String` **join** **(** :ref:`String` delimiter **)** -Returns a :ref:`String` with each element of the array joined with the delimiter. +Returns a :ref:`String` with each element of the array joined with the delimiter. .. _class_PoolStringArray_push_back: -- void **push_back** **(** :ref:`String` string **)** +- void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. @@ -105,9 +105,9 @@ Set the size of the array. If the array is grown reserve elements at the end of .. _class_PoolStringArray_set: -- void **set** **(** :ref:`int` idx, :ref:`String` string **)** +- void **set** **(** :ref:`int` idx, :ref:`String` string **)** -Change the :ref:`String` at the given index. +Change the :ref:`String` at the given index. .. _class_PoolStringArray_size: diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index d4f895c15..21741c52b 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -14,27 +14,27 @@ Brief Description An Array of Vector2. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | +| :ref:`PoolVector2Array` | :ref:`PoolVector2Array` **(** :ref:`Array` from **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | +| void | :ref:`append` **(** :ref:`Vector2` vector2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolVector2Array` array **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | +| void | :ref:`push_back` **(** :ref:`Vector2` vector2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -44,30 +44,30 @@ Description An Array specifically designed to hold Vector2. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolVector2Array_PoolVector2Array: -- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** +- :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** Construct a new ``PoolVector2Array``. Optionally, you can pass in an Array that will be converted. .. _class_PoolVector2Array_append: -- void **append** **(** :ref:`Vector2` vector2 **)** +- void **append** **(** :ref:`Vector2` vector2 **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolVector2Array_append_array: -- void **append_array** **(** :ref:`PoolVector2Array` array **)** +- void **append_array** **(** :ref:`PoolVector2Array` array **)** Append an ``PoolVector2Array`` at the end of this array. .. _class_PoolVector2Array_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). @@ -75,13 +75,13 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolVector2Array_push_back: -- void **push_back** **(** :ref:`Vector2` vector2 **)** +- void **push_back** **(** :ref:`Vector2` vector2 **)** -Insert a :ref:`Vector2` at the end. +Insert a :ref:`Vector2` at the end. .. _class_PoolVector2Array_remove: @@ -97,9 +97,9 @@ Set the size of the array. If the array is grown reserve elements at the end of .. _class_PoolVector2Array_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** +- void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** -Change the :ref:`Vector2` at the given index. +Change the :ref:`Vector2` at the given index. .. _class_PoolVector2Array_size: diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 7835df077..46211c15e 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -14,27 +14,27 @@ Brief Description An Array of Vector3. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | +| :ref:`PoolVector3Array` | :ref:`PoolVector3Array` **(** :ref:`Array` from **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | +| void | :ref:`append` **(** :ref:`Vector3` vector3 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | +| void | :ref:`append_array` **(** :ref:`PoolVector3Array` array **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | +| void | :ref:`push_back` **(** :ref:`Vector3` vector3 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` idx **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +| void | :ref:`set` **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -44,30 +44,30 @@ Description An Array specifically designed to hold Vector3. Note that this type is passed by value and not by reference. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PoolVector3Array_PoolVector3Array: -- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** +- :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. .. _class_PoolVector3Array_append: -- void **append** **(** :ref:`Vector3` vector3 **)** +- void **append** **(** :ref:`Vector3` vector3 **)** Append an element at the end of the array (alias of :ref:`push_back`). .. _class_PoolVector3Array_append_array: -- void **append_array** **(** :ref:`PoolVector3Array` array **)** +- void **append_array** **(** :ref:`PoolVector3Array` array **)** Append an ``PoolVector3Array`` at the end of this array. .. _class_PoolVector3Array_insert: -- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- :ref:`int` **insert** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). @@ -75,13 +75,13 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** -Reverse the order of the elements in the array (so first element will now be the last). +Reverse the order of the elements in the array. .. _class_PoolVector3Array_push_back: -- void **push_back** **(** :ref:`Vector3` vector3 **)** +- void **push_back** **(** :ref:`Vector3` vector3 **)** -Insert a :ref:`Vector3` at the end. +Insert a :ref:`Vector3` at the end. .. _class_PoolVector3Array_remove: @@ -97,9 +97,9 @@ Set the size of the array. If the array is grown reserve elements at the end of .. _class_PoolVector3Array_set: -- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** +- void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** -Change the :ref:`Vector3` at the given index. +Change the :ref:`Vector3` at the given index. .. _class_PoolVector3Array_size: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index b19693d66..b9aafce0c 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -7,10 +7,8 @@ Popup ===== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`PopupPanel`, :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`WindowDialog` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`PopupPanel`, :ref:`PopupDialog`, :ref:`PopupMenu`, :ref:`WindowDialog` **Category:** Core Brief Description @@ -18,15 +16,15 @@ Brief Description Base container control for popups and dialogs. -Member Functions ----------------- +Methods +------- +-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | +| void | :ref:`popup` **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | +| void | :ref:`popup_centered` **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | +| void | :ref:`popup_centered_minsize` **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`popup_centered_ratio` **(** :ref:`float` ratio=0.75 **)** | +-------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -38,7 +36,7 @@ Signals - **about_to_show** **(** **)** -This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). +This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu` for clearing the list of options and creating a new one according to the current context). .. _class_Popup_popup_hide: @@ -47,16 +45,8 @@ This signal is emitted when a popup is about to be shown. (often used in :ref:`P This signal is emitted when a popup is hidden. -Member Variables ----------------- - - .. _class_Popup_popup_exclusive: - -- :ref:`bool` **popup_exclusive** - If ``true`` the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. - - -Numeric Constants ------------------ +Constants +--------- - **NOTIFICATION_POST_POPUP** = **80** --- Notification sent right after the popup is shown. - **NOTIFICATION_POPUP_HIDE** = **81** --- Notification sent right after the popup is hidden. @@ -64,26 +54,34 @@ Numeric Constants Description ----------- -Popup is a base :ref:`Control` used to show dialogs and popups. It's a subwindow and modal by default (see :ref:`Control`) and has helpers for custom popup behavior. +Popup is a base :ref:`Control` used to show dialogs and popups. It's a subwindow and modal by default (see :ref:`Control`) and has helpers for custom popup behavior. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Popup_popup_exclusive: + +- :ref:`bool` **popup_exclusive** - If ``true`` the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. + + +Method Descriptions +------------------- .. _class_Popup_popup: -- void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** +- void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). .. _class_Popup_popup_centered: -- void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** +- void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". .. _class_Popup_popup_centered_minsize: -- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** +- void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than ``minsize``. diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index 6a5b8aea3..b416118f5 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -7,8 +7,7 @@ PopupDialog =========== -**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Base class for Popup Dialogs. Description ----------- -PopupDialog is a base class for popup dialogs, along with :ref:`WindowDialog`. +PopupDialog is a base class for popup dialogs, along with :ref:`WindowDialog`. diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 7442371af..5ac6638ab 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -7,8 +7,7 @@ PopupMenu ========= -**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,33 @@ Brief Description PopupMenu displays a list of options. -Member Functions ----------------- +Methods +------- +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +| void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +| void | :ref:`add_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +| void | :ref:`add_icon_check_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +| void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +| void | :ref:`add_icon_item` **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +| void | :ref:`add_icon_shortcut` **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +| void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +| void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +| void | :ref:`add_radio_check_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | +| void | :ref:`add_separator` **(** :ref:`String` label="" **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +| void | :ref:`add_shortcut` **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | +| void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,21 +49,21 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | +| :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_hide_on_window_lose_focus` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -96,23 +95,23 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | +| void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture` icon **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_id` **(** :ref:`int` idx, :ref:`int` id **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +| void | :ref:`set_item_metadata` **(** :ref:`int` idx, :ref:`Variant` metadata **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_multistate` **(** :ref:`int` idx, :ref:`int` state **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | +| void | :ref:`set_item_shortcut` **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | +| void | :ref:`set_item_submenu` **(** :ref:`int` idx, :ref:`String` submenu **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +| void | :ref:`set_item_text` **(** :ref:`int` idx, :ref:`String` text **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | +| void | :ref:`set_item_tooltip` **(** :ref:`int` idx, :ref:`String` tooltip **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`toggle_item_checked` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -141,8 +140,13 @@ This event is emitted when an item of some id is pressed or its accelerator is a This event is emitted when an item of some index is pressed or its accelerator is activated. -Member Variables ----------------- +Description +----------- + +PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. + +Property Descriptions +--------------------- .. _class_PopupMenu_hide_on_checkable_item_selection: @@ -161,27 +165,22 @@ Member Variables - :ref:`float` **submenu_popup_delay** - Sets the delay time for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. Default value: ``0.3`` seconds. -Description ------------ - -PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PopupMenu_add_check_item: -- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. .. _class_PopupMenu_add_check_shortcut: -- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_check_item: -- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_check_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be @@ -189,47 +188,47 @@ created from the index. Note that checkable items just display a checkmark, but .. _class_PopupMenu_add_icon_check_shortcut: -- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_check_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_icon_item: -- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_icon_item** **(** :ref:`Texture` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_icon_shortcut: -- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_item: -- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. .. _class_PopupMenu_add_radio_check_item: -- void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** +- void **add_radio_check_item** **(** :ref:`String` label, :ref:`int` id=-1, :ref:`int` accel=0 **)** The same as :ref:`add_check_item` but the inserted item will look as a radio button. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. .. _class_PopupMenu_add_radio_check_shortcut: -- void **add_radio_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_radio_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_separator: -- void **add_separator** **(** :ref:`String` label="" **)** +- void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. .. _class_PopupMenu_add_shortcut: -- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +- void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** .. _class_PopupMenu_add_submenu_item: -- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** +- void **add_submenu_item** **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. @@ -253,7 +252,7 @@ Return the amount of items. .. _class_PopupMenu_get_item_icon: -- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const +- :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". @@ -271,29 +270,29 @@ Find and return the index of the item containing a given id. .. _class_PopupMenu_get_item_metadata: -- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const Return the metadata of an item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. .. _class_PopupMenu_get_item_shortcut: -- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const +- :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const .. _class_PopupMenu_get_item_submenu: -- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const Return the submenu name of the item at index "idx". .. _class_PopupMenu_get_item_text: -- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". .. _class_PopupMenu_get_item_tooltip: -- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +- :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const .. _class_PopupMenu_is_hide_on_window_lose_focus: @@ -383,7 +382,7 @@ Sets whether the item at index "idx" is disabled or not. When it is disabled it .. _class_PopupMenu_set_item_icon: -- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** +- void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** .. _class_PopupMenu_set_item_id: @@ -393,7 +392,7 @@ Set the id of the item at index "idx". .. _class_PopupMenu_set_item_metadata: -- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** +- void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** Sets the metadata of an item, which might be of any type. You can later get it with :ref:`get_item_metadata`, which provides a simple way of assigning context data to items. @@ -403,7 +402,7 @@ Sets the metadata of an item, which might be of any type. You can later get it w .. _class_PopupMenu_set_item_shortcut: -- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** +- void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** .. _class_PopupMenu_set_item_shortcut_disabled: @@ -411,19 +410,19 @@ Sets the metadata of an item, which might be of any type. You can later get it w .. _class_PopupMenu_set_item_submenu: -- void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** +- void **set_item_submenu** **(** :ref:`int` idx, :ref:`String` submenu **)** Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. .. _class_PopupMenu_set_item_text: -- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** +- void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Set the text of the item at index "idx". .. _class_PopupMenu_set_item_tooltip: -- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** +- void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** .. _class_PopupMenu_toggle_item_checked: diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 3ba5baf0e..7e1b2c261 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -7,8 +7,7 @@ PopupPanel ========== -**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Class for displaying popups with a panel background. Description ----------- -Class for displaying popups with a panel background. In some cases it might be simpler to use than :ref:`Popup`, since it provides a configurable background. If you are making windows, better check :ref:`WindowDialog`. +Class for displaying popups with a panel background. In some cases it might be simpler to use than :ref:`Popup`, since it provides a configurable background. If you are making windows, better check :ref:`WindowDialog`. diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index e1c0bf509..b31151aa6 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -7,8 +7,7 @@ Position2D ========== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Generic 2D Position hint for editing. Description ----------- -Generic 2D Position hint for editing. It's just like a plain :ref:`Node2D` but displays as a cross in the 2D-Editor at all times. +Generic 2D Position hint for editing. It's just like a plain :ref:`Node2D` but displays as a cross in the 2D-Editor at all times. diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index 3ea88c607..2379b8923 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -7,8 +7,7 @@ Position3D ========== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Generic 3D Position hint for editing. Description ----------- -Generic 3D Position hint for editing. It's just like a plain :ref:`Spatial` but displays as a cross in the 3D-Editor at all times. +Generic 3D Position hint for editing. It's just like a plain :ref:`Spatial` but displays as a cross in the 3D-Editor at all times. diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 7621e8b16..10a71d126 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -7,30 +7,33 @@ PrimitiveMesh ============= -**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`PlaneMesh`, :ref:`CubeMesh`, :ref:`SphereMesh`, :ref:`CylinderMesh`, :ref:`CapsuleMesh`, :ref:`QuadMesh`, :ref:`PrismMesh` - +**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`PlaneMesh`, :ref:`CubeMesh`, :ref:`SphereMesh`, :ref:`CylinderMesh`, :ref:`CapsuleMesh`, :ref:`QuadMesh`, :ref:`PrismMesh` **Category:** Core Brief Description ----------------- -Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. +Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. + +Property Descriptions +--------------------- .. _class_PrimitiveMesh_custom_aabb: -- :ref:`AABB` **custom_aabb** +- :ref:`AABB` **custom_aabb** .. _class_PrimitiveMesh_flip_faces: @@ -38,19 +41,14 @@ Member Variables .. _class_PrimitiveMesh_material: -- :ref:`Material` **material** - The current :ref:`Material` of the primitive mesh. +- :ref:`Material` **material** - The current :ref:`Material` of the primitive mesh. -Description ------------ - -Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_PrimitiveMesh_get_mesh_arrays: -- :ref:`Array` **get_mesh_arrays** **(** **)** const +- :ref:`Array` **get_mesh_arrays** **(** **)** const diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 196ab596f..709e25a79 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -7,17 +7,21 @@ PrismMesh ========= -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Class representing a prism-shaped :ref:`PrimitiveMesh`. +Class representing a prism-shaped :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Class representing a prism-shaped :ref:`PrimitiveMesh`. + +Property Descriptions +--------------------- .. _class_PrismMesh_left_to_right: @@ -25,7 +29,7 @@ Member Variables .. _class_PrismMesh_size: -- :ref:`Vector3` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0). +- :ref:`Vector3` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0). .. _class_PrismMesh_subdivide_depth: @@ -40,8 +44,3 @@ Member Variables - :ref:`int` **subdivide_width** - Number of added edge loops along the x-axis. Defaults to 0. -Description ------------ - -Class representing a prism-shaped :ref:`PrimitiveMesh`. - diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index e301a6491..0d8f4d4b1 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -7,85 +7,16 @@ ProceduralSky ============= -**Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Sky` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Type of :ref:`Sky` that is generated procedurally based on user input parameters. +Type of :ref:`Sky` that is generated procedurally based on user input parameters. -Member Variables ----------------- - - .. _class_ProceduralSky_ground_bottom_color: - -- :ref:`Color` **ground_bottom_color** - Color of the ground at the bottom. - - .. _class_ProceduralSky_ground_curve: - -- :ref:`float` **ground_curve** - How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. - - .. _class_ProceduralSky_ground_energy: - -- :ref:`float` **ground_energy** - Amount of energy contribution from the ground. - - .. _class_ProceduralSky_ground_horizon_color: - -- :ref:`Color` **ground_horizon_color** - Color of the ground at the horizon. - - .. _class_ProceduralSky_sky_curve: - -- :ref:`float` **sky_curve** - How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. - - .. _class_ProceduralSky_sky_energy: - -- :ref:`float` **sky_energy** - Amount of energy contribution from the sky. - - .. _class_ProceduralSky_sky_horizon_color: - -- :ref:`Color` **sky_horizon_color** - Color of the sky at the horizon. - - .. _class_ProceduralSky_sky_top_color: - -- :ref:`Color` **sky_top_color** - Color of the sky at the top. - - .. _class_ProceduralSky_sun_angle_max: - -- :ref:`float` **sun_angle_max** - Distance from center of sun where it fades out completely. - - .. _class_ProceduralSky_sun_angle_min: - -- :ref:`float` **sun_angle_min** - Distance from sun where it goes from solid to starting to fade. - - .. _class_ProceduralSky_sun_color: - -- :ref:`Color` **sun_color** - Color of the sun. - - .. _class_ProceduralSky_sun_curve: - -- :ref:`float` **sun_curve** - How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` - - .. _class_ProceduralSky_sun_energy: - -- :ref:`float` **sun_energy** - Amount of energy contribution from the sun. - - .. _class_ProceduralSky_sun_latitude: - -- :ref:`float` **sun_latitude** - The suns height using polar coordinates. - - .. _class_ProceduralSky_sun_longitude: - -- :ref:`float` **sun_longitude** - The direction of the sun using polar coordinates. - - .. _class_ProceduralSky_texture_size: - -- :ref:`TextureSize` **texture_size** - Size of :ref:`Texture` that the ProceduralSky will generate. - - -Enums ------ +Enumerations +------------ .. _enum_ProceduralSky_TextureSize: @@ -106,3 +37,71 @@ ProceduralSky provides a way to create an effective background quickly by defini The ProceduralSky is updated on the CPU after the parameters change and stored in a texture and then displayed as a background in the scene. This makes it relatively unsuitable for realtime updates during gameplay. But with a small texture size it is still feasible to update relatively frequently becuase it is updated on a background thread when multi-threading is available. +Property Descriptions +--------------------- + + .. _class_ProceduralSky_ground_bottom_color: + +- :ref:`Color` **ground_bottom_color** - Color of the ground at the bottom. + + .. _class_ProceduralSky_ground_curve: + +- :ref:`float` **ground_curve** - How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. + + .. _class_ProceduralSky_ground_energy: + +- :ref:`float` **ground_energy** - Amount of energy contribution from the ground. + + .. _class_ProceduralSky_ground_horizon_color: + +- :ref:`Color` **ground_horizon_color** - Color of the ground at the horizon. + + .. _class_ProceduralSky_sky_curve: + +- :ref:`float` **sky_curve** - How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. + + .. _class_ProceduralSky_sky_energy: + +- :ref:`float` **sky_energy** - Amount of energy contribution from the sky. + + .. _class_ProceduralSky_sky_horizon_color: + +- :ref:`Color` **sky_horizon_color** - Color of the sky at the horizon. + + .. _class_ProceduralSky_sky_top_color: + +- :ref:`Color` **sky_top_color** - Color of the sky at the top. + + .. _class_ProceduralSky_sun_angle_max: + +- :ref:`float` **sun_angle_max** - Distance from center of sun where it fades out completely. + + .. _class_ProceduralSky_sun_angle_min: + +- :ref:`float` **sun_angle_min** - Distance from sun where it goes from solid to starting to fade. + + .. _class_ProceduralSky_sun_color: + +- :ref:`Color` **sun_color** - Color of the sun. + + .. _class_ProceduralSky_sun_curve: + +- :ref:`float` **sun_curve** - How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` + + .. _class_ProceduralSky_sun_energy: + +- :ref:`float` **sun_energy** - Amount of energy contribution from the sun. + + .. _class_ProceduralSky_sun_latitude: + +- :ref:`float` **sun_latitude** - The suns height using polar coordinates. + + .. _class_ProceduralSky_sun_longitude: + +- :ref:`float` **sun_longitude** - The direction of the sun using polar coordinates. + + .. _class_ProceduralSky_texture_size: + +- :ref:`TextureSize` **texture_size** - Size of :ref:`Texture` that the ProceduralSky will generate. + + diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 595144fe3..f5f98afd6 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -7,8 +7,7 @@ ProgressBar =========== -**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description General purpose progress bar. -Member Variables ----------------- +Description +----------- + +General purpose progress bar. Shows fill percentage from right to left. + +Property Descriptions +--------------------- .. _class_ProgressBar_percent_visible: - :ref:`bool` **percent_visible** - If ``true`` the fill percentage is displayed on the bar. Default value: ``true``. -Description ------------ - -General purpose progress bar. Shows fill percentage from right to left. - diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 0b030eeb8..d5a869be7 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -7,8 +7,7 @@ ProjectSettings =============== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,48 @@ Brief Description Contains global variables accessible from everywhere. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` name **)** | +| void | :ref:`clear` **(** :ref:`String` name **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_setting` **(** :ref:`String` name **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_setting` **(** :ref:`String` name **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | +| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** **)** | +| :ref:`Error` | :ref:`save` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save_custom` **(** :ref:`String` file **)** | +| :ref:`Error` | :ref:`save_custom` **(** :ref:`String` file **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_setting` **(** :ref:`String` name, :ref:`Variant` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + +Property Descriptions +--------------------- .. _class_ProjectSettings_application/boot_splash/fullsize: @@ -60,21 +64,21 @@ Member Variables .. _class_ProjectSettings_application/boot_splash/image: -- :ref:`String` **application/boot_splash/image** - Path to an image used for boot splash. +- :ref:`String` **application/boot_splash/image** - Path to an image used for boot splash. .. _class_ProjectSettings_application/config/custom_user_dir_name: -- :ref:`String` **application/config/custom_user_dir_name** - This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. +- :ref:`String` **application/config/custom_user_dir_name** - This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_application/config/icon: -- :ref:`String` **application/config/icon** - Icon used for the project, set when project loads. Exporters will use this icon when possible to. +- :ref:`String` **application/config/icon** - Icon used for the project, set when project loads. Exporters will use this icon when possible to. .. _class_ProjectSettings_application/config/name: -- :ref:`String` **application/config/name** - Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. +- :ref:`String` **application/config/name** - Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. .. _class_ProjectSettings_application/config/use_custom_user_dir: @@ -102,7 +106,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_application/run/main_scene: -- :ref:`String` **application/run/main_scene** - Path to the main scene file that will be loaded when the project runs. +- :ref:`String` **application/run/main_scene** - Path to the main scene file that will be loaded when the project runs. .. _class_ProjectSettings_audio/channel_disable_threshold_db: @@ -114,7 +118,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_audio/driver: -- :ref:`String` **audio/driver** +- :ref:`String` **audio/driver** .. _class_ProjectSettings_audio/mix_rate: @@ -254,7 +258,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_debug/settings/crash_handler/message: -- :ref:`String` **debug/settings/crash_handler/message** +- :ref:`String` **debug/settings/crash_handler/message** .. _class_ProjectSettings_debug/settings/fps/force_fps: @@ -282,11 +286,11 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_display/mouse_cursor/custom_image: -- :ref:`String` **display/mouse_cursor/custom_image** - Custom image for the mouse cursor. +- :ref:`String` **display/mouse_cursor/custom_image** - Custom image for the mouse cursor. .. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: -- :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** - Hotspot for the custom mouse cursor image. +- :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** - Hotspot for the custom mouse cursor image. .. _class_ProjectSettings_display/window/allow_per_pixel_transparency: @@ -302,7 +306,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_display/window/handheld/orientation: -- :ref:`String` **display/window/handheld/orientation** - Default orientation for cell phone or tablet. +- :ref:`String` **display/window/handheld/orientation** - Default orientation for cell phone or tablet. .. _class_ProjectSettings_display/window/per_pixel_transparency: @@ -362,11 +366,11 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_gui/theme/custom: -- :ref:`String` **gui/theme/custom** - Use a custom theme resource, set a path to it here. +- :ref:`String` **gui/theme/custom** - Use a custom theme resource, set a path to it here. .. _class_ProjectSettings_gui/theme/custom_font: -- :ref:`String` **gui/theme/custom_font** - USe a custom default font resource, set a path to it here. +- :ref:`String` **gui/theme/custom_font** - USe a custom default font resource, set a path to it here. .. _class_ProjectSettings_gui/theme/use_hidpi: @@ -382,55 +386,55 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_input/ui_accept: -- :ref:`Dictionary` **input/ui_accept** +- :ref:`Dictionary` **input/ui_accept** .. _class_ProjectSettings_input/ui_cancel: -- :ref:`Dictionary` **input/ui_cancel** +- :ref:`Dictionary` **input/ui_cancel** .. _class_ProjectSettings_input/ui_down: -- :ref:`Dictionary` **input/ui_down** +- :ref:`Dictionary` **input/ui_down** .. _class_ProjectSettings_input/ui_end: -- :ref:`Dictionary` **input/ui_end** +- :ref:`Dictionary` **input/ui_end** .. _class_ProjectSettings_input/ui_focus_next: -- :ref:`Dictionary` **input/ui_focus_next** +- :ref:`Dictionary` **input/ui_focus_next** .. _class_ProjectSettings_input/ui_focus_prev: -- :ref:`Dictionary` **input/ui_focus_prev** +- :ref:`Dictionary` **input/ui_focus_prev** .. _class_ProjectSettings_input/ui_home: -- :ref:`Dictionary` **input/ui_home** +- :ref:`Dictionary` **input/ui_home** .. _class_ProjectSettings_input/ui_left: -- :ref:`Dictionary` **input/ui_left** +- :ref:`Dictionary` **input/ui_left** .. _class_ProjectSettings_input/ui_page_down: -- :ref:`Dictionary` **input/ui_page_down** +- :ref:`Dictionary` **input/ui_page_down** .. _class_ProjectSettings_input/ui_page_up: -- :ref:`Dictionary` **input/ui_page_up** +- :ref:`Dictionary` **input/ui_page_up** .. _class_ProjectSettings_input/ui_right: -- :ref:`Dictionary` **input/ui_right** +- :ref:`Dictionary` **input/ui_right** .. _class_ProjectSettings_input/ui_select: -- :ref:`Dictionary` **input/ui_select** +- :ref:`Dictionary` **input/ui_select** .. _class_ProjectSettings_input/ui_up: -- :ref:`Dictionary` **input/ui_up** +- :ref:`Dictionary` **input/ui_up** .. _class_ProjectSettings_input_devices/pointing/emulate_mouse_from_touch: @@ -442,331 +446,331 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_layer_names/2d_physics/layer_1: -- :ref:`String` **layer_names/2d_physics/layer_1** +- :ref:`String` **layer_names/2d_physics/layer_1** .. _class_ProjectSettings_layer_names/2d_physics/layer_10: -- :ref:`String` **layer_names/2d_physics/layer_10** +- :ref:`String` **layer_names/2d_physics/layer_10** .. _class_ProjectSettings_layer_names/2d_physics/layer_11: -- :ref:`String` **layer_names/2d_physics/layer_11** +- :ref:`String` **layer_names/2d_physics/layer_11** .. _class_ProjectSettings_layer_names/2d_physics/layer_12: -- :ref:`String` **layer_names/2d_physics/layer_12** +- :ref:`String` **layer_names/2d_physics/layer_12** .. _class_ProjectSettings_layer_names/2d_physics/layer_13: -- :ref:`String` **layer_names/2d_physics/layer_13** +- :ref:`String` **layer_names/2d_physics/layer_13** .. _class_ProjectSettings_layer_names/2d_physics/layer_14: -- :ref:`String` **layer_names/2d_physics/layer_14** +- :ref:`String` **layer_names/2d_physics/layer_14** .. _class_ProjectSettings_layer_names/2d_physics/layer_15: -- :ref:`String` **layer_names/2d_physics/layer_15** +- :ref:`String` **layer_names/2d_physics/layer_15** .. _class_ProjectSettings_layer_names/2d_physics/layer_16: -- :ref:`String` **layer_names/2d_physics/layer_16** +- :ref:`String` **layer_names/2d_physics/layer_16** .. _class_ProjectSettings_layer_names/2d_physics/layer_17: -- :ref:`String` **layer_names/2d_physics/layer_17** +- :ref:`String` **layer_names/2d_physics/layer_17** .. _class_ProjectSettings_layer_names/2d_physics/layer_18: -- :ref:`String` **layer_names/2d_physics/layer_18** +- :ref:`String` **layer_names/2d_physics/layer_18** .. _class_ProjectSettings_layer_names/2d_physics/layer_19: -- :ref:`String` **layer_names/2d_physics/layer_19** +- :ref:`String` **layer_names/2d_physics/layer_19** .. _class_ProjectSettings_layer_names/2d_physics/layer_2: -- :ref:`String` **layer_names/2d_physics/layer_2** +- :ref:`String` **layer_names/2d_physics/layer_2** .. _class_ProjectSettings_layer_names/2d_physics/layer_20: -- :ref:`String` **layer_names/2d_physics/layer_20** +- :ref:`String` **layer_names/2d_physics/layer_20** .. _class_ProjectSettings_layer_names/2d_physics/layer_3: -- :ref:`String` **layer_names/2d_physics/layer_3** +- :ref:`String` **layer_names/2d_physics/layer_3** .. _class_ProjectSettings_layer_names/2d_physics/layer_4: -- :ref:`String` **layer_names/2d_physics/layer_4** +- :ref:`String` **layer_names/2d_physics/layer_4** .. _class_ProjectSettings_layer_names/2d_physics/layer_5: -- :ref:`String` **layer_names/2d_physics/layer_5** +- :ref:`String` **layer_names/2d_physics/layer_5** .. _class_ProjectSettings_layer_names/2d_physics/layer_6: -- :ref:`String` **layer_names/2d_physics/layer_6** +- :ref:`String` **layer_names/2d_physics/layer_6** .. _class_ProjectSettings_layer_names/2d_physics/layer_7: -- :ref:`String` **layer_names/2d_physics/layer_7** +- :ref:`String` **layer_names/2d_physics/layer_7** .. _class_ProjectSettings_layer_names/2d_physics/layer_8: -- :ref:`String` **layer_names/2d_physics/layer_8** +- :ref:`String` **layer_names/2d_physics/layer_8** .. _class_ProjectSettings_layer_names/2d_physics/layer_9: -- :ref:`String` **layer_names/2d_physics/layer_9** +- :ref:`String` **layer_names/2d_physics/layer_9** .. _class_ProjectSettings_layer_names/2d_render/layer_1: -- :ref:`String` **layer_names/2d_render/layer_1** +- :ref:`String` **layer_names/2d_render/layer_1** .. _class_ProjectSettings_layer_names/2d_render/layer_10: -- :ref:`String` **layer_names/2d_render/layer_10** +- :ref:`String` **layer_names/2d_render/layer_10** .. _class_ProjectSettings_layer_names/2d_render/layer_11: -- :ref:`String` **layer_names/2d_render/layer_11** +- :ref:`String` **layer_names/2d_render/layer_11** .. _class_ProjectSettings_layer_names/2d_render/layer_12: -- :ref:`String` **layer_names/2d_render/layer_12** +- :ref:`String` **layer_names/2d_render/layer_12** .. _class_ProjectSettings_layer_names/2d_render/layer_13: -- :ref:`String` **layer_names/2d_render/layer_13** +- :ref:`String` **layer_names/2d_render/layer_13** .. _class_ProjectSettings_layer_names/2d_render/layer_14: -- :ref:`String` **layer_names/2d_render/layer_14** +- :ref:`String` **layer_names/2d_render/layer_14** .. _class_ProjectSettings_layer_names/2d_render/layer_15: -- :ref:`String` **layer_names/2d_render/layer_15** +- :ref:`String` **layer_names/2d_render/layer_15** .. _class_ProjectSettings_layer_names/2d_render/layer_16: -- :ref:`String` **layer_names/2d_render/layer_16** +- :ref:`String` **layer_names/2d_render/layer_16** .. _class_ProjectSettings_layer_names/2d_render/layer_17: -- :ref:`String` **layer_names/2d_render/layer_17** +- :ref:`String` **layer_names/2d_render/layer_17** .. _class_ProjectSettings_layer_names/2d_render/layer_18: -- :ref:`String` **layer_names/2d_render/layer_18** +- :ref:`String` **layer_names/2d_render/layer_18** .. _class_ProjectSettings_layer_names/2d_render/layer_19: -- :ref:`String` **layer_names/2d_render/layer_19** +- :ref:`String` **layer_names/2d_render/layer_19** .. _class_ProjectSettings_layer_names/2d_render/layer_2: -- :ref:`String` **layer_names/2d_render/layer_2** +- :ref:`String` **layer_names/2d_render/layer_2** .. _class_ProjectSettings_layer_names/2d_render/layer_20: -- :ref:`String` **layer_names/2d_render/layer_20** +- :ref:`String` **layer_names/2d_render/layer_20** .. _class_ProjectSettings_layer_names/2d_render/layer_3: -- :ref:`String` **layer_names/2d_render/layer_3** +- :ref:`String` **layer_names/2d_render/layer_3** .. _class_ProjectSettings_layer_names/2d_render/layer_4: -- :ref:`String` **layer_names/2d_render/layer_4** +- :ref:`String` **layer_names/2d_render/layer_4** .. _class_ProjectSettings_layer_names/2d_render/layer_5: -- :ref:`String` **layer_names/2d_render/layer_5** +- :ref:`String` **layer_names/2d_render/layer_5** .. _class_ProjectSettings_layer_names/2d_render/layer_6: -- :ref:`String` **layer_names/2d_render/layer_6** +- :ref:`String` **layer_names/2d_render/layer_6** .. _class_ProjectSettings_layer_names/2d_render/layer_7: -- :ref:`String` **layer_names/2d_render/layer_7** +- :ref:`String` **layer_names/2d_render/layer_7** .. _class_ProjectSettings_layer_names/2d_render/layer_8: -- :ref:`String` **layer_names/2d_render/layer_8** +- :ref:`String` **layer_names/2d_render/layer_8** .. _class_ProjectSettings_layer_names/2d_render/layer_9: -- :ref:`String` **layer_names/2d_render/layer_9** +- :ref:`String` **layer_names/2d_render/layer_9** .. _class_ProjectSettings_layer_names/3d_physics/layer_1: -- :ref:`String` **layer_names/3d_physics/layer_1** +- :ref:`String` **layer_names/3d_physics/layer_1** .. _class_ProjectSettings_layer_names/3d_physics/layer_10: -- :ref:`String` **layer_names/3d_physics/layer_10** +- :ref:`String` **layer_names/3d_physics/layer_10** .. _class_ProjectSettings_layer_names/3d_physics/layer_11: -- :ref:`String` **layer_names/3d_physics/layer_11** +- :ref:`String` **layer_names/3d_physics/layer_11** .. _class_ProjectSettings_layer_names/3d_physics/layer_12: -- :ref:`String` **layer_names/3d_physics/layer_12** +- :ref:`String` **layer_names/3d_physics/layer_12** .. _class_ProjectSettings_layer_names/3d_physics/layer_13: -- :ref:`String` **layer_names/3d_physics/layer_13** +- :ref:`String` **layer_names/3d_physics/layer_13** .. _class_ProjectSettings_layer_names/3d_physics/layer_14: -- :ref:`String` **layer_names/3d_physics/layer_14** +- :ref:`String` **layer_names/3d_physics/layer_14** .. _class_ProjectSettings_layer_names/3d_physics/layer_15: -- :ref:`String` **layer_names/3d_physics/layer_15** +- :ref:`String` **layer_names/3d_physics/layer_15** .. _class_ProjectSettings_layer_names/3d_physics/layer_16: -- :ref:`String` **layer_names/3d_physics/layer_16** +- :ref:`String` **layer_names/3d_physics/layer_16** .. _class_ProjectSettings_layer_names/3d_physics/layer_17: -- :ref:`String` **layer_names/3d_physics/layer_17** +- :ref:`String` **layer_names/3d_physics/layer_17** .. _class_ProjectSettings_layer_names/3d_physics/layer_18: -- :ref:`String` **layer_names/3d_physics/layer_18** +- :ref:`String` **layer_names/3d_physics/layer_18** .. _class_ProjectSettings_layer_names/3d_physics/layer_19: -- :ref:`String` **layer_names/3d_physics/layer_19** +- :ref:`String` **layer_names/3d_physics/layer_19** .. _class_ProjectSettings_layer_names/3d_physics/layer_2: -- :ref:`String` **layer_names/3d_physics/layer_2** +- :ref:`String` **layer_names/3d_physics/layer_2** .. _class_ProjectSettings_layer_names/3d_physics/layer_20: -- :ref:`String` **layer_names/3d_physics/layer_20** +- :ref:`String` **layer_names/3d_physics/layer_20** .. _class_ProjectSettings_layer_names/3d_physics/layer_3: -- :ref:`String` **layer_names/3d_physics/layer_3** +- :ref:`String` **layer_names/3d_physics/layer_3** .. _class_ProjectSettings_layer_names/3d_physics/layer_4: -- :ref:`String` **layer_names/3d_physics/layer_4** +- :ref:`String` **layer_names/3d_physics/layer_4** .. _class_ProjectSettings_layer_names/3d_physics/layer_5: -- :ref:`String` **layer_names/3d_physics/layer_5** +- :ref:`String` **layer_names/3d_physics/layer_5** .. _class_ProjectSettings_layer_names/3d_physics/layer_6: -- :ref:`String` **layer_names/3d_physics/layer_6** +- :ref:`String` **layer_names/3d_physics/layer_6** .. _class_ProjectSettings_layer_names/3d_physics/layer_7: -- :ref:`String` **layer_names/3d_physics/layer_7** +- :ref:`String` **layer_names/3d_physics/layer_7** .. _class_ProjectSettings_layer_names/3d_physics/layer_8: -- :ref:`String` **layer_names/3d_physics/layer_8** +- :ref:`String` **layer_names/3d_physics/layer_8** .. _class_ProjectSettings_layer_names/3d_physics/layer_9: -- :ref:`String` **layer_names/3d_physics/layer_9** +- :ref:`String` **layer_names/3d_physics/layer_9** .. _class_ProjectSettings_layer_names/3d_render/layer_1: -- :ref:`String` **layer_names/3d_render/layer_1** +- :ref:`String` **layer_names/3d_render/layer_1** .. _class_ProjectSettings_layer_names/3d_render/layer_10: -- :ref:`String` **layer_names/3d_render/layer_10** +- :ref:`String` **layer_names/3d_render/layer_10** .. _class_ProjectSettings_layer_names/3d_render/layer_11: -- :ref:`String` **layer_names/3d_render/layer_11** +- :ref:`String` **layer_names/3d_render/layer_11** .. _class_ProjectSettings_layer_names/3d_render/layer_12: -- :ref:`String` **layer_names/3d_render/layer_12** +- :ref:`String` **layer_names/3d_render/layer_12** .. _class_ProjectSettings_layer_names/3d_render/layer_13: -- :ref:`String` **layer_names/3d_render/layer_13** +- :ref:`String` **layer_names/3d_render/layer_13** .. _class_ProjectSettings_layer_names/3d_render/layer_14: -- :ref:`String` **layer_names/3d_render/layer_14** +- :ref:`String` **layer_names/3d_render/layer_14** .. _class_ProjectSettings_layer_names/3d_render/layer_15: -- :ref:`String` **layer_names/3d_render/layer_15** +- :ref:`String` **layer_names/3d_render/layer_15** .. _class_ProjectSettings_layer_names/3d_render/layer_16: -- :ref:`String` **layer_names/3d_render/layer_16** +- :ref:`String` **layer_names/3d_render/layer_16** .. _class_ProjectSettings_layer_names/3d_render/layer_17: -- :ref:`String` **layer_names/3d_render/layer_17** +- :ref:`String` **layer_names/3d_render/layer_17** .. _class_ProjectSettings_layer_names/3d_render/layer_18: -- :ref:`String` **layer_names/3d_render/layer_18** +- :ref:`String` **layer_names/3d_render/layer_18** .. _class_ProjectSettings_layer_names/3d_render/layer_19: -- :ref:`String` **layer_names/3d_render/layer_19** +- :ref:`String` **layer_names/3d_render/layer_19** .. _class_ProjectSettings_layer_names/3d_render/layer_2: -- :ref:`String` **layer_names/3d_render/layer_2** +- :ref:`String` **layer_names/3d_render/layer_2** .. _class_ProjectSettings_layer_names/3d_render/layer_20: -- :ref:`String` **layer_names/3d_render/layer_20** +- :ref:`String` **layer_names/3d_render/layer_20** .. _class_ProjectSettings_layer_names/3d_render/layer_3: -- :ref:`String` **layer_names/3d_render/layer_3** +- :ref:`String` **layer_names/3d_render/layer_3** .. _class_ProjectSettings_layer_names/3d_render/layer_4: -- :ref:`String` **layer_names/3d_render/layer_4** +- :ref:`String` **layer_names/3d_render/layer_4** .. _class_ProjectSettings_layer_names/3d_render/layer_5: -- :ref:`String` **layer_names/3d_render/layer_5** +- :ref:`String` **layer_names/3d_render/layer_5** .. _class_ProjectSettings_layer_names/3d_render/layer_6: -- :ref:`String` **layer_names/3d_render/layer_6** +- :ref:`String` **layer_names/3d_render/layer_6** .. _class_ProjectSettings_layer_names/3d_render/layer_7: -- :ref:`String` **layer_names/3d_render/layer_7** +- :ref:`String` **layer_names/3d_render/layer_7** .. _class_ProjectSettings_layer_names/3d_render/layer_8: -- :ref:`String` **layer_names/3d_render/layer_8** +- :ref:`String` **layer_names/3d_render/layer_8** .. _class_ProjectSettings_layer_names/3d_render/layer_9: -- :ref:`String` **layer_names/3d_render/layer_9** +- :ref:`String` **layer_names/3d_render/layer_9** .. _class_ProjectSettings_locale/fallback: -- :ref:`String` **locale/fallback** +- :ref:`String` **locale/fallback** .. _class_ProjectSettings_locale/test: -- :ref:`String` **locale/test** +- :ref:`String` **locale/test** .. _class_ProjectSettings_logging/file_logging/enable_file_logging: @@ -774,7 +778,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_logging/file_logging/log_path: -- :ref:`String` **logging/file_logging/log_path** - Path to logs withint he project. Using an user:// based path is recommended. +- :ref:`String` **logging/file_logging/log_path** - Path to logs withint he project. Using an user:// based path is recommended. .. _class_ProjectSettings_logging/file_logging/max_log_files: @@ -788,6 +792,22 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. - :ref:`int` **memory/limits/multithreaded_server/rid_pool_prealloc** - This is used by servers when used in multi threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number. + .. _class_ProjectSettings_mono/debugger_agent/port: + +- :ref:`int` **mono/debugger_agent/port** + + .. _class_ProjectSettings_mono/debugger_agent/wait_for_debugger: + +- :ref:`bool` **mono/debugger_agent/wait_for_debugger** + + .. _class_ProjectSettings_mono/debugger_agent/wait_timeout: + +- :ref:`int` **mono/debugger_agent/wait_timeout** + + .. _class_ProjectSettings_mono/export/include_scripts_content: + +- :ref:`bool` **mono/export/include_scripts_content** + .. _class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second: - :ref:`int` **network/limits/debugger_stdout/max_chars_per_second** - Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. @@ -818,7 +838,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_network/ssl/certificates: -- :ref:`String` **network/ssl/certificates** - If your game or application uses HTTPS, a certificates file is needed. It must be set here. +- :ref:`String` **network/ssl/certificates** - If your game or application uses HTTPS, a certificates file is needed. It must be set here. .. _class_ProjectSettings_node/name_casing: @@ -830,7 +850,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_physics/2d/physics_engine: -- :ref:`String` **physics/2d/physics_engine** +- :ref:`String` **physics/2d/physics_engine** .. _class_ProjectSettings_physics/2d/thread_model: @@ -842,7 +862,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_physics/3d/physics_engine: -- :ref:`String` **physics/3d/physics_engine** +- :ref:`String` **physics/3d/physics_engine** .. _class_ProjectSettings_physics/common/physics_fps: @@ -854,7 +874,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_rendering/environment/default_clear_color: -- :ref:`Color` **rendering/environment/default_clear_color** - Default background clear color. +- :ref:`Color` **rendering/environment/default_clear_color** - Default background clear color. .. _class_ProjectSettings_rendering/limits/buffers/blend_shape_max_buffer_size_kb: @@ -886,7 +906,7 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_rendering/quality/depth_prepass/disable_for_vendors: -- :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** - Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. +- :ref:`String` **rendering/quality/depth_prepass/disable_for_vendors** - Disable depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this. .. _class_ProjectSettings_rendering/quality/depth_prepass/enable: @@ -900,9 +920,13 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. - :ref:`int` **rendering/quality/directional_shadow/size.mobile** + .. _class_ProjectSettings_rendering/quality/driver/driver_fallback: + +- :ref:`String` **rendering/quality/driver/driver_fallback** - Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function. + .. _class_ProjectSettings_rendering/quality/driver/driver_name: -- :ref:`String` **rendering/quality/driver/driver_name** +- :ref:`String` **rendering/quality/driver/driver_name** .. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: @@ -1000,6 +1024,10 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. - :ref:`int` **rendering/threads/thread_model** - Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + .. _class_ProjectSettings_rendering/vram_compression/import_bptc: + +- :ref:`bool` **rendering/vram_compression/import_bptc** + .. _class_ProjectSettings_rendering/vram_compression/import_etc: - :ref:`bool` **rendering/vram_compression/import_etc** - If the project uses this compression (usually low end mobile), texture importer will import these. @@ -1018,22 +1046,17 @@ the "use_custom_user_dir" setting must be enabled for this to take effect. .. _class_ProjectSettings_script: -- :ref:`Script` **script** +- :ref:`Script` **script** -Description ------------ - -Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ProjectSettings_add_property_info: -- void **add_property_info** **(** :ref:`Dictionary` hint **)** +- void **add_property_info** **(** :ref:`Dictionary` hint **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: @@ -1052,70 +1075,70 @@ Example: .. _class_ProjectSettings_clear: -- void **clear** **(** :ref:`String` name **)** +- void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). .. _class_ProjectSettings_get_order: -- :ref:`int` **get_order** **(** :ref:`String` name **)** const +- :ref:`int` **get_order** **(** :ref:`String` name **)** const Return the order of a configuration value (influences when saved to the config file). .. _class_ProjectSettings_get_setting: -- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const .. _class_ProjectSettings_globalize_path: -- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const +- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Convert a localized path (res://) to a full native OS path. .. _class_ProjectSettings_has_setting: -- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const +- :ref:`bool` **has_setting** **(** :ref:`String` name **)** const Return true if a configuration value is present. .. _class_ProjectSettings_load_resource_pack: -- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** +- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** .. _class_ProjectSettings_localize_path: -- :ref:`String` **localize_path** **(** :ref:`String` path **)** const +- :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (res:// path). .. _class_ProjectSettings_property_can_revert: -- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** .. _class_ProjectSettings_property_get_revert: -- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** +- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** .. _class_ProjectSettings_save: -- :ref:`Error` **save** **(** **)** +- :ref:`Error` **save** **(** **)** .. _class_ProjectSettings_save_custom: -- :ref:`Error` **save_custom** **(** :ref:`String` file **)** +- :ref:`Error` **save_custom** **(** :ref:`String` file **)** .. _class_ProjectSettings_set_initial_value: -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** .. _class_ProjectSettings_set_order: -- void **set_order** **(** :ref:`String` name, :ref:`int` position **)** +- void **set_order** **(** :ref:`String` name, :ref:`int` position **)** Set the order of a configuration value (influences when saved to the config file). .. _class_ProjectSettings_set_setting: -- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index d47653f74..a947032b1 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -7,8 +7,7 @@ ProximityGroup ============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description General purpose proximity-detection node. -Member Functions ----------------- +Methods +------- +-------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | +| void | :ref:`broadcast` **(** :ref:`String` name, :ref:`Variant` parameters **)** | +-------+-----------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -28,27 +27,11 @@ Signals .. _class_ProximityGroup_broadcast: -- **broadcast** **(** :ref:`String` group_name, :ref:`Array` parameters **)** +- **broadcast** **(** :ref:`String` group_name, :ref:`Array` parameters **)** -Member Variables ----------------- - - .. _class_ProximityGroup_dispatch_mode: - -- :ref:`DispatchMode` **dispatch_mode** - - .. _class_ProximityGroup_grid_radius: - -- :ref:`Vector3` **grid_radius** - - .. _class_ProximityGroup_group_name: - -- :ref:`String` **group_name** - - -Enums ------ +Enumerations +------------ .. _enum_ProximityGroup_DispatchMode: @@ -63,11 +46,27 @@ Description General purpose proximity-detection node. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ProximityGroup_dispatch_mode: + +- :ref:`DispatchMode` **dispatch_mode** + + .. _class_ProximityGroup_grid_radius: + +- :ref:`Vector3` **grid_radius** + + .. _class_ProximityGroup_group_name: + +- :ref:`String` **group_name** + + +Method Descriptions +------------------- .. _class_ProximityGroup_broadcast: -- void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** +- void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 8808e9d5f..2a74ee4de 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -7,8 +7,7 @@ ProxyTexture ============ -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_ProxyTexture_base: -- :ref:`Texture` **base** +- :ref:`Texture` **base** diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index d6969cb6f..d0754f8ac 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -7,8 +7,7 @@ QuadMesh ======== -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Class representing a square mesh. -Member Variables ----------------- - - .. _class_QuadMesh_size: - -- :ref:`Vector2` **size** - - Description ----------- -Class representing a square mesh with size (2,2,0). Consider using a :ref:`PlaneMesh` if you require a differently sized plane. +Class representing a square mesh with size (2,2,0). Consider using a :ref:`PlaneMesh` if you require a differently sized plane. + +Property Descriptions +--------------------- + + .. _class_QuadMesh_size: + +- :ref:`Vector2` **size** + diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 43b0fbfa6..7ee0166fe 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -14,25 +14,25 @@ Brief Description Quaternion. -Member Functions ----------------- +Methods +------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Basis` from **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` euler **)** | +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` euler **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +| :ref:`Quat` | :ref:`Quat` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | +| :ref:`Quat` | :ref:`Quat` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | +| :ref:`Quat` | :ref:`cubic_slerp` **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | +| :ref:`float` | :ref:`dot` **(** :ref:`Quat` b **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_euler` **(** **)** | +| :ref:`Vector3` | :ref:`get_euler` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`inverse` **(** **)** | +| :ref:`Quat` | :ref:`inverse` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,21 +40,41 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`normalized` **(** **)** | +| :ref:`Quat` | :ref:`normalized` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +| void | :ref:`set_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_euler` **(** :ref:`Vector3` euler **)** | +| void | :ref:`set_euler` **(** :ref:`Vector3` euler **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | +| :ref:`Quat` | :ref:`slerp` **(** :ref:`Quat` b, :ref:`float` t **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | +| :ref:`Quat` | :ref:`slerpni` **(** :ref:`Quat` b, :ref:`float` t **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | +| :ref:`Vector3` | :ref:`xform` **(** :ref:`Vector3` v **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- + +- **IDENTITY** = **Quat( 0, 0, 0, 1 )** + +Description +----------- + +A unit quaternion used for representing 3D rotations. + +It is similar to :ref:`Basis`, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors. + +Quaternions need to be (re)normalized. + +Tutorials +--------- + +- `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms` +- :doc:`../tutorials/math/rotations` + +Property Descriptions +--------------------- .. _class_Quat_w: @@ -73,74 +93,54 @@ Member Variables - :ref:`float` **z** - Z component of the quaternion. Default value: ``0`` -Numeric Constants ------------------ - -- **IDENTITY** = **Quat( 0, 0, 0, 1 )** - -Description ------------ - -A unit quaternion used for representing 3D rotations. - -It is similar to :ref:`Basis`, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors. - -Quaternions need to be (re)normalized. - -Tutorials ---------- - -- `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms` -- :doc:`../tutorials/math/rotations` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** +- :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Vector3` euler **)** +- :ref:`Quat` **Quat** **(** :ref:`Vector3` euler **)** Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- :ref:`Quat` **Quat** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. .. _class_Quat_Quat: -- :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** +- :ref:`Quat` **Quat** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns a quaternion defined by these values. .. _class_Quat_cubic_slerp: -- :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** +- :ref:`Quat` **cubic_slerp** **(** :ref:`Quat` b, :ref:`Quat` pre_a, :ref:`Quat` post_b, :ref:`float` t **)** Performs a cubic spherical-linear interpolation with another quaternion. .. _class_Quat_dot: -- :ref:`float` **dot** **(** :ref:`Quat` b **)** +- :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. .. _class_Quat_get_euler: -- :ref:`Vector3` **get_euler** **(** **)** +- :ref:`Vector3` **get_euler** **(** **)** Return Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). .. _class_Quat_inverse: -- :ref:`Quat` **inverse** **(** **)** +- :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. @@ -164,37 +164,37 @@ Returns the length of the quaternion, squared. .. _class_Quat_normalized: -- :ref:`Quat` **normalized** **(** **)** +- :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. .. _class_Quat_set_axis_angle: -- void **set_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- void **set_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. .. _class_Quat_set_euler: -- void **set_euler** **(** :ref:`Vector3` euler **)** +- void **set_euler** **(** :ref:`Vector3` euler **)** Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle). .. _class_Quat_slerp: -- :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** +- :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaternion. .. _class_Quat_slerpni: -- :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** +- :ref:`Quat` **slerpni** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°. .. _class_Quat_xform: -- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** +- :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Transforms the vector ``v`` by this quaternion. diff --git a/classes/class_range.rst b/classes/class_range.rst index 562a9bbc7..927158e6e 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -7,10 +7,8 @@ Range ===== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`SpinBox`, :ref:`ScrollBar`, :ref:`ProgressBar`, :ref:`TextureProgress`, :ref:`Slider` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`SpinBox`, :ref:`ScrollBar`, :ref:`ProgressBar`, :ref:`TextureProgress`, :ref:`Slider` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description Abstract base class for range-based controls. -Member Functions ----------------- +Methods +------- +-------+--------------------------------------------------------------------------+ -| void | :ref:`share` **(** :ref:`Node` with **)** | +| void | :ref:`share` **(** :ref:`Node` with **)** | +-------+--------------------------------------------------------------------------+ | void | :ref:`unshare` **(** **)** | +-------+--------------------------------------------------------------------------+ @@ -43,8 +41,13 @@ Emitted when :ref:`min_value`, :ref:`max_value` changes. -Member Variables ----------------- +Description +----------- + +Range is a base class for :ref:`Control` nodes that change a floating point *value* between a *minimum* and a *maximum*, using *step* and *page*, for example a :ref:`ScrollBar`. + +Property Descriptions +--------------------- .. _class_Range_allow_greater: @@ -68,7 +71,7 @@ Member Variables .. _class_Range_page: -- :ref:`float` **page** - Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. +- :ref:`float` **page** - Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length is its size multiplied by ``page`` over the difference between ``min_value`` and ``max_value``. .. _class_Range_ratio: @@ -87,17 +90,12 @@ Member Variables - :ref:`float` **value** - Range's current value. -Description ------------ - -Range is a base class for :ref:`Control` nodes that change a floating point *value* between a *minimum* and a *maximum*, using *step* and *page*, for example a :ref:`ScrollBar`. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Range_share: -- void **share** **(** :ref:`Node` with **)** +- void **share** **(** :ref:`Node` with **)** Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index 99f261580..aa122ba56 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -7,8 +7,7 @@ RayCast ======= -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,64 @@ Brief Description Query the closest object intersecting a ray. -Member Functions ----------------- +Methods +------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_exceptions` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Object` | :ref:`get_collider` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | +| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | +| :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 3D space in order to find the closest object along the path of the ray. + +RayCast can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. + +RayCast can be configured to report collisions with :ref:`Area`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody`\ s (:ref:`collide_with_bodies`). + +Only enabled raycasts will be able to query the space and report collisions. + +RayCast calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. + +Property Descriptions +--------------------- .. _class_RayCast_cast_to: -- :ref:`Vector3` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. +- :ref:`Vector3` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. + + .. _class_RayCast_collide_with_areas: + +- :ref:`bool` **collide_with_areas** - If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. + + .. _class_RayCast_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** - If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. .. _class_RayCast_collision_mask: @@ -67,31 +87,20 @@ Member Variables - :ref:`bool` **exclude_parent** - If ``true`` collisions will be ignored for this RayCast's immediate parent. Default value: ``true``. -Description ------------ - -A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 3D space in order to find the closest object along the path of the ray. - -RayCast can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. - -Only enabled raycasts will be able to query the space and report collisions. - -RayCast calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_RayCast_add_exception: -- void **add_exception** **(** :ref:`Object` node **)** +- void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast_add_exception_rid: -- void **add_exception_rid** **(** :ref:`RID` rid **)** +- void **add_exception_rid** **(** :ref:`RID` rid **)** -Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. +Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. .. _class_RayCast_clear_exceptions: @@ -109,29 +118,15 @@ Use this method to update the collision information immediately instead of waiti .. _class_RayCast_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const -Return the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. - -Example: - -:: - - if RayCast.is_colliding(): - var collider = RayCast.get_collider() +Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const -Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. - -Example: - -:: - - if RayCast.is_colliding(): - var shape = RayCast.get_collider_shape() +Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast_get_collision_mask_bit: @@ -141,13 +136,13 @@ Returns ``true`` if the bit index passed is turned on. Note that bit indexes ran .. _class_RayCast_get_collision_normal: -- :ref:`Vector3` **get_collision_normal** **(** **)** const +- :ref:`Vector3` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast_get_collision_point: -- :ref:`Vector3` **get_collision_point** **(** **)** const +- :ref:`Vector3` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. @@ -155,19 +150,19 @@ Returns the collision point at which the ray intersects the closest object. Note - :ref:`bool` **is_colliding** **(** **)** const -Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). +Return whether any object is intersecting with the ray's vector (considering the vector length). .. _class_RayCast_remove_exception: -- void **remove_exception** **(** :ref:`Object` node **)** +- void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast_remove_exception_rid: -- void **remove_exception_rid** **(** :ref:`RID` rid **)** +- void **remove_exception_rid** **(** :ref:`RID` rid **)** -Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. +Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. .. _class_RayCast_set_collision_mask_bit: diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 4e95fcf29..a6b4a8664 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -7,8 +7,7 @@ RayCast2D ========= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,64 @@ Brief Description Query the closest object intersecting a ray. -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception` **(** :ref:`Object` node **)** | +| void | :ref:`add_exception` **(** :ref:`Object` node **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`add_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_exceptions` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_raycast_update` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collider` **(** **)** const | +| :ref:`Object` | :ref:`get_collider` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | +| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | +| :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +| void | :ref:`remove_exception` **(** :ref:`Object` node **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 2D space in order to find the closest object along the path of the ray. + +RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. + +RayCast2D can be configured to report collisions with :ref:`Area2D`\ s (:ref:`collide_with_areas`) and/or :ref:`PhysicsBody2D`\ s (:ref:`collide_with_bodies`). + +Only enabled raycasts will be able to query the space and report collisions. + +RayCast2D calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. + +Property Descriptions +--------------------- .. _class_RayCast2D_cast_to: -- :ref:`Vector2` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. +- :ref:`Vector2` **cast_to** - The ray's destination point, relative to the RayCast's ``position``. + + .. _class_RayCast2D_collide_with_areas: + +- :ref:`bool` **collide_with_areas** - If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. + + .. _class_RayCast2D_collide_with_bodies: + +- :ref:`bool` **collide_with_bodies** - If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. .. _class_RayCast2D_collision_mask: @@ -67,31 +87,20 @@ Member Variables - :ref:`bool` **exclude_parent** - If ``true``, the parent node will be excluded from collision detection. Default value: ``true``. -Description ------------ - -A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 2D space in order to find the closest object along the path of the ray. - -RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. - -Only enabled raycasts will be able to query the space and report collisions. - -RayCast2D calculates intersection every physics frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_RayCast2D_add_exception: -- void **add_exception** **(** :ref:`Object` node **)** +- void **add_exception** **(** :ref:`Object` node **)** Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast2D_add_exception_rid: -- void **add_exception_rid** **(** :ref:`RID` rid **)** +- void **add_exception_rid** **(** :ref:`RID` rid **)** -Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. +Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. .. _class_RayCast2D_clear_exceptions: @@ -107,29 +116,15 @@ Updates the collision information for the ray. Use this method to update the co .. _class_RayCast2D_get_collider: -- :ref:`Object` **get_collider** **(** **)** const +- :ref:`Object` **get_collider** **(** **)** const -Returns the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. - -Example: - -:: - - if RayCast2D.is_colliding(): - var collider = RayCast2D.get_collider() +Return the first object that the ray intersects, or ``null`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast2D_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const -Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. - -Example: - -:: - - if RayCast2D.is_colliding(): - var shape = RayCast2D.get_collider_shape() +Returns the shape ID of the first object that the ray intersects, or ``0`` if no object is intersecting the ray (i.e. :ref:`is_colliding` returns ``false``). .. _class_RayCast2D_get_collision_mask_bit: @@ -139,13 +134,13 @@ Return an individual bit on the collision mask. .. _class_RayCast2D_get_collision_normal: -- :ref:`Vector2` **get_collision_normal** **(** **)** const +- :ref:`Vector2` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast2D_get_collision_point: -- :ref:`Vector2` **get_collision_point** **(** **)** const +- :ref:`Vector2` **get_collision_point** **(** **)** const Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. @@ -153,19 +148,19 @@ Returns the collision point at which the ray intersects the closest object. Note - :ref:`bool` **is_colliding** **(** **)** const -Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). +Return whether any object is intersecting with the ray's vector (considering the vector length). .. _class_RayCast2D_remove_exception: -- void **remove_exception** **(** :ref:`Object` node **)** +- void **remove_exception** **(** :ref:`Object` node **)** Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast2D_remove_exception_rid: -- void **remove_exception_rid** **(** :ref:`RID` rid **)** +- void **remove_exception_rid** **(** :ref:`RID` rid **)** -Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. +Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. .. _class_RayCast2D_set_collision_mask_bit: diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 8d2900268..40e378446 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -7,8 +7,7 @@ RayShape ======== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Ray shape for 3D collisions. -Member Variables ----------------- +Description +----------- + +Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + +Property Descriptions +--------------------- .. _class_RayShape_length: @@ -28,8 +32,3 @@ Member Variables - :ref:`bool` **slips_on_slope** - If ``true`` allow the shape to return the correct normal. Default value: ``false``. -Description ------------ - -Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. - diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 497c662fd..aec30cc8d 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -7,8 +7,7 @@ RayShape2D ========== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,13 @@ Brief Description Ray shape for 2D collisions. -Member Variables ----------------- +Description +----------- + +Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + +Property Descriptions +--------------------- .. _class_RayShape2D_length: @@ -28,8 +32,3 @@ Member Variables - :ref:`bool` **slips_on_slope** - If ``true`` allow the shape to return the correct normal. Default value: ``false``. -Description ------------ - -Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. - diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 83d4df7dd..89dbaf500 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -14,55 +14,39 @@ Brief Description 2D Axis-aligned bounding box. -Member Functions ----------------- +Methods +------- +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`abs` **(** **)** | +| :ref:`Rect2` | :ref:`abs` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | +| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | +| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_area` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | +| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | +| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | +| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_no_area` **(** **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | +| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Rect2_end: - -- :ref:`Vector2` **end** - Ending corner. - - .. _class_Rect2_position: - -- :ref:`Vector2` **position** - Position (starting corner). - - .. _class_Rect2_size: - -- :ref:`Vector2` **size** - Size from position to end. - - Description ----------- @@ -73,42 +57,58 @@ Tutorials - :doc:`../tutorials/math/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Rect2_end: + +- :ref:`Vector2` **end** - Ending corner. + + .. _class_Rect2_position: + +- :ref:`Vector2` **position** - Position (starting corner). + + .. _class_Rect2_size: + +- :ref:`Vector2` **size** - Size from position to end. + + +Method Descriptions +------------------- .. _class_Rect2_Rect2: -- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** +- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. .. _class_Rect2_Rect2: -- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** +- :ref:`Rect2` **Rect2** **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** Constructs a ``Rect2`` by x, y, width, and height. .. _class_Rect2_abs: -- :ref:`Rect2` **abs** **(** **)** +- :ref:`Rect2` **abs** **(** **)** Returns a ``Rect2`` with equivalent position and area, modified so that the top-left corner is the origin and ``width`` and ``height`` are positive. .. _class_Rect2_clip: -- :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** +- :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this ``Rect2`` and b. .. _class_Rect2_encloses: -- :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** +- :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns ``true`` if this ``Rect2`` completely encloses another one. .. _class_Rect2_expand: -- :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** +- :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Returns this ``Rect2`` expanded to include a given point. @@ -120,19 +120,19 @@ Returns the area of the ``Rect2``. .. _class_Rect2_grow: -- :ref:`Rect2` **grow** **(** :ref:`float` by **)** +- :ref:`Rect2` **grow** **(** :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards all the sides. .. _class_Rect2_grow_individual: -- :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** +- :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** Returns a copy of the ``Rect2`` grown a given amount of units towards each direction individually. .. _class_Rect2_grow_margin: -- :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** +- :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** Returns a copy of the ``Rect2`` grown a given amount of units towards the Margin direction. @@ -144,19 +144,19 @@ Returns ``true`` if the ``Rect2`` is flat or empty. .. _class_Rect2_has_point: -- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** +- :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Returns ``true`` if the ``Rect2`` contains a point. .. _class_Rect2_intersects: -- :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** +- :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Returns ``true`` if the ``Rect2`` overlaps with another. .. _class_Rect2_merge: -- :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** +- :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** Returns a larger Rect2 that contains this Rect2 and ``with``. diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 2018982d6..f76da904d 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -7,8 +7,7 @@ RectangleShape2D ================ -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Rectangle shape for 2D collisions. -Member Variables ----------------- - - .. _class_RectangleShape2D_extents: - -- :ref:`Vector2` **extents** - The rectangle's half extents. The width and height of this shape is twice the half extents. - - Description ----------- Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects. +Property Descriptions +--------------------- + + .. _class_RectangleShape2D_extents: + +- :ref:`Vector2` **extents** - The rectangle's half extents. The width and height of this shape is twice the half extents. + + diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 523e5e653..b2e25060f 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -7,10 +7,8 @@ Reference ========= -**Inherits:** :ref:`Object` - -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` - +**Inherits:** :ref:`Object` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Base class for anything that keeps a reference count. -Member Functions ----------------- +Methods +------- +--------------------------+-------------------------------------------------------------+ | :ref:`bool` | :ref:`init_ref` **(** **)** | @@ -34,8 +32,8 @@ Description Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Reference_init_ref: diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 83c02ed00..c9cf0be29 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -7,8 +7,7 @@ ReferenceRect ============= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Reference frame for GUI. -Member Variables ----------------- - - .. _class_ReferenceRect_border_color: - -- :ref:`Color` **border_color** - - Description ----------- Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. +Property Descriptions +--------------------- + + .. _class_ReferenceRect_border_color: + +- :ref:`Color` **border_color** + + diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index e50212d62..1117418e1 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -7,8 +7,7 @@ ReflectionProbe =============== -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,24 @@ Brief Description -Member Variables ----------------- +Enumerations +------------ + + .. _enum_ReflectionProbe_UpdateMode: + +enum **UpdateMode** + +- **UPDATE_ONCE** = **0** +- **UPDATE_ALWAYS** = **1** + + +Tutorials +--------- + +- :doc:`../tutorials/3d/reflection_probes` + +Property Descriptions +--------------------- .. _class_ReflectionProbe_box_projection: @@ -33,7 +48,7 @@ Member Variables .. _class_ReflectionProbe_extents: -- :ref:`Vector3` **extents** +- :ref:`Vector3` **extents** .. _class_ReflectionProbe_intensity: @@ -41,7 +56,7 @@ Member Variables .. _class_ReflectionProbe_interior_ambient_color: -- :ref:`Color` **interior_ambient_color** +- :ref:`Color` **interior_ambient_color** .. _class_ReflectionProbe_interior_ambient_contrib: @@ -61,26 +76,10 @@ Member Variables .. _class_ReflectionProbe_origin_offset: -- :ref:`Vector3` **origin_offset** +- :ref:`Vector3` **origin_offset** .. _class_ReflectionProbe_update_mode: -- :ref:`UpdateMode` **update_mode** +- :ref:`UpdateMode` **update_mode** -Enums ------ - - .. _enum_ReflectionProbe_UpdateMode: - -enum **UpdateMode** - -- **UPDATE_ONCE** = **0** -- **UPDATE_ALWAYS** = **1** - - -Tutorials ---------- - -- :doc:`../tutorials/3d/reflection_probes` - diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 18e1c1149..5638caa49 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -7,8 +7,7 @@ RegEx ===== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,27 @@ Brief Description Class for searching text for patterns using regular expressions. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`compile` **(** :ref:`String` pattern **)** | +| :ref:`Error` | :ref:`compile` **(** :ref:`String` pattern **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_group_count` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | +| :ref:`Array` | :ref:`get_names` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | +| :ref:`String` | :ref:`get_pattern` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`search_all` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +| :ref:`Array` | :ref:`search_all` **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +| :ref:`String` | :ref:`sub` **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -53,7 +52,7 @@ To begin, the RegEx object needs to be compiled with the search pattern using :r The search pattern must be escaped first for gdscript before it is escaped for the expression. For example, ``compile("\\d+")`` would be read by RegEx as ``\d+``. Similarly, ``compile("\"(?:\\\\.|[^\"])*\"")`` would be read as ``"(?:\\.|[^"])*"`` -Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using functions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. +Using :ref:`search` you can find the pattern within the given text. If a pattern is found, :ref:`RegExMatch` is returned and you can retrieve details of the results using functions such as :ref:`RegExMatch.get_string` and :ref:`RegExMatch.get_start`. :: @@ -63,7 +62,7 @@ Using :ref:`search` you can find the pattern within the give if result: print(result.get_string()) # Would print n-0123 -The results of capturing groups ``()`` can be retrieved by passing the group number to the various functions in :ref:`RegExMatch`. Group 0 is the default and would always refer to the entire pattern. In the above example, calling ``result.get_string(1)`` would give you ``0123``. +The results of capturing groups ``()`` can be retrieved by passing the group number to the various functions in :ref:`RegExMatch`. Group 0 is the default and would always refer to the entire pattern. In the above example, calling ``result.get_string(1)`` would give you ``0123``. This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match. @@ -84,8 +83,8 @@ If you need to process multiple results, :ref:`search_all` **compile** **(** :ref:`String` pattern **)** +- :ref:`Error` **compile** **(** :ref:`String` pattern **)** Compiles and assign the search pattern to use. Returns OK if the compilation is successful. If an error is encountered the details are printed to STDOUT and FAILED is returned. @@ -107,13 +106,13 @@ Returns the number of capturing groups in compiled pattern. .. _class_RegEx_get_names: -- :ref:`Array` **get_names** **(** **)** const +- :ref:`Array` **get_names** **(** **)** const Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. .. _class_RegEx_get_pattern: -- :ref:`String` **get_pattern** **(** **)** const +- :ref:`String` **get_pattern** **(** **)** const Returns the original search pattern that was compiled. @@ -125,19 +124,19 @@ Returns whether this object has a valid search pattern assigned. .. _class_RegEx_search: -- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const -Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. +Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching result if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. .. _class_RegEx_search_all: -- :ref:`Array` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`Array` **search_all** **(** :ref:`String` subject, :ref:`int` offset=0, :ref:`int` end=-1 **)** const -Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. +Searches the text for the compiled pattern. Returns an array of :ref:`RegExMatch` containers for each non-overlapping result. If no results were found an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. .. _class_RegEx_sub: -- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const +- :ref:`String` **sub** **(** :ref:`String` subject, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` offset=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as ``\1`` and ``\g`` expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 654f1d959..45e1f4e67 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -7,8 +7,7 @@ RegExMatch ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,46 +15,46 @@ Brief Description Contains the results of a regex search. -Member Functions ----------------- +Methods +------- +------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | +| :ref:`int` | :ref:`get_end` **(** :ref:`Variant` name=0 **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_group_count` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | +| :ref:`int` | :ref:`get_start` **(** :ref:`Variant` name=0 **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | +| :ref:`String` | :ref:`get_string` **(** :ref:`Variant` name=0 **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_RegExMatch_names: - -- :ref:`Dictionary` **names** - A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. - - .. _class_RegExMatch_strings: - -- :ref:`Array` **strings** - An :ref:`Array` of the match and its capturing groups. - - .. _class_RegExMatch_subject: - -- :ref:`String` **subject** - The source string used with the search pattern to find this matching result. - - Description ----------- Contains the results of a single regex match returned by :ref:`RegEx.search` and :ref:`RegEx.search_all`. It can be used to find the position and range of the match and its capturing groups, and it can extract its sub-string for you. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_RegExMatch_names: + +- :ref:`Dictionary` **names** - A dictionary of named groups and its corresponding group number. Only groups with that were matched are included. If multiple groups have the same name, that name would refer to the first matching one. + + .. _class_RegExMatch_strings: + +- :ref:`Array` **strings** - An :ref:`Array` of the match and its capturing groups. + + .. _class_RegExMatch_subject: + +- :ref:`String` **subject** - The source string used with the search pattern to find this matching result. + + +Method Descriptions +------------------- .. _class_RegExMatch_get_end: -- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -69,7 +68,7 @@ Returns the number of capturing groups. .. _class_RegExMatch_get_start: -- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const +- :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. @@ -77,7 +76,7 @@ Returns -1 if the group did not match or doesn't exist. .. _class_RegExMatch_get_string: -- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const +- :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index e63ff0a30..40d82ec88 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -7,43 +7,42 @@ RemoteTransform =============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -RemoteTransform leads the :ref:`Transform` of another :ref:`Spatial` derived Node in the scene. +RemoteTransform pushes its own :ref:`Transform` to another :ref:`Spatial` derived Node in the scene. -Member Variables ----------------- +Description +----------- + +RemoteTransform pushes its own :ref:`Transform` to another :ref:`Spatial` derived Node (called the remote node) in the scene. + +It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates. + +Property Descriptions +--------------------- .. _class_RemoteTransform_remote_path: -- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. +- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. .. _class_RemoteTransform_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is tracked. Default value: ``true``. +- :ref:`bool` **update_position** - If ``true`` the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is tracked. Default value: ``true``. +- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is tracked. Default value: ``true``. +- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform_use_global_coordinates: - :ref:`bool` **use_global_coordinates** - If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. -Description ------------ - -RemoteTransform leads the :ref:`Transform` of another :ref:`Spatial` derived Node (called the remote node) in the scene. - -It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. - diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 52879abcd..f76dde7b1 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -7,43 +7,42 @@ RemoteTransform2D ================= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -RemoteTransform2D leads the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node in the scene. +RemoteTransform2D pushes its own :ref:`Transform2D` to another :ref:`CanvasItem` derived Node in the scene. -Member Variables ----------------- +Description +----------- + +RemoteTransform2D pushes its own :ref:`Transform2D` to another :ref:`CanvasItem` derived Node (called the remote node) in the scene. + +It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates. + +Property Descriptions +--------------------- .. _class_RemoteTransform2D_remote_path: -- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. +- :ref:`NodePath` **remote_path** - The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. .. _class_RemoteTransform2D_update_position: -- :ref:`bool` **update_position** - If ``true`` the remote node's position is tracked. Default value: ``true``. +- :ref:`bool` **update_position** - If ``true`` the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_rotation: -- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is tracked. Default value: ``true``. +- :ref:`bool` **update_rotation** - If ``true`` the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_scale: -- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is tracked. Default value: ``true``. +- :ref:`bool` **update_scale** - If ``true`` the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform2D_use_global_coordinates: - :ref:`bool` **use_global_coordinates** - If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. -Description ------------ - -RemoteTransform2D leads the :ref:`Transform2D` of another :ref:`CanvasItem` derived Node (called the remote node) in the scene. - -It can be set to track another Node's position, rotation and/or scale. It can update using either global or local coordinates. - diff --git a/classes/class_resource.rst b/classes/class_resource.rst index da904c240..ae345a00f 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -7,10 +7,8 @@ Resource ======== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core Brief Description @@ -18,21 +16,21 @@ Brief Description Base class for all resources. -Member Functions ----------------- +Methods +------- +----------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`_setup_local_to_scene` **(** **)** virtual | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | +| :ref:`Resource` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | +| :ref:`Node` | :ref:`get_local_scene` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_rid` **(** **)** const | +----------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`setup_local_to_scene` **(** **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`take_over_path` **(** :ref:`String` path **)** | +| void | :ref:`take_over_path` **(** :ref:`String` path **)** | +----------------------------------+---------------------------------------------------------------------------------------------------------+ Signals @@ -43,8 +41,13 @@ Signals - **changed** **(** **)** -Member Variables ----------------- +Description +----------- + +Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a :ref:`Node`, which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node` or another resource. + +Property Descriptions +--------------------- .. _class_Resource_resource_local_to_scene: @@ -52,20 +55,15 @@ Member Variables .. _class_Resource_resource_name: -- :ref:`String` **resource_name** +- :ref:`String` **resource_name** .. _class_Resource_resource_path: -- :ref:`String` **resource_path** +- :ref:`String` **resource_path** -Description ------------ - -Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a :ref:`Node`, which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a :ref:`Node` or another resource. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Resource__setup_local_to_scene: @@ -73,17 +71,17 @@ Member Function Description .. _class_Resource_duplicate: -- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const +- :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const .. _class_Resource_get_local_scene: -- :ref:`Node` **get_local_scene** **(** **)** const +- :ref:`Node` **get_local_scene** **(** **)** const .. _class_Resource_get_rid: -- :ref:`RID` **get_rid** **(** **)** const +- :ref:`RID` **get_rid** **(** **)** const -Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. +Return the RID of the resource (or an empty RID). Many resources (such as :ref:`Texture`, :ref:`Mesh`, etc) are high level abstractions of resources stored in a server, so this function will return the original RID. .. _class_Resource_setup_local_to_scene: @@ -91,7 +89,7 @@ Return the RID of the resource (or an empty RID). Many resources (such as :ref:` .. _class_Resource_take_over_path: -- void **take_over_path** **(** :ref:`String` path **)** +- void **take_over_path** **(** :ref:`String` path **)** Set the path of the resource. Differs from set_path(), if another ``Resource`` exists with "path" it over-takes it, instead of failing. diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 6505477ab..319279f5e 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -7,10 +7,8 @@ ResourceImporter ================ -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`ResourceImporterOGGVorbis` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`ResourceImporterOGGVorbis` **Category:** Core Brief Description diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index a86285211..8a295d032 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -7,8 +7,7 @@ ResourceImporterOGGVorbis ========================= -**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`ResourceImporter` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 8b7d531ee..9acc2f3f4 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -7,8 +7,7 @@ ResourceInteractiveLoader ========================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,19 +15,19 @@ Brief Description Interactive Resource Loader. -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** **)** | +| :ref:`Resource` | :ref:`get_resource` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_stage` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_stage_count` **(** **)** const | +----------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`poll` **(** **)** | +| :ref:`Error` | :ref:`poll` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | +| :ref:`Error` | :ref:`wait` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------+ Description @@ -36,12 +35,12 @@ Description Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ResourceInteractiveLoader_get_resource: -- :ref:`Resource` **get_resource** **(** **)** +- :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. @@ -59,12 +58,12 @@ Return the total amount of stages (calls to :ref:`poll` **poll** **(** **)** +- :ref:`Error` **poll** **(** **)** Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. .. _class_ResourceInteractiveLoader_wait: -- :ref:`Error` **wait** **(** **)** +- :ref:`Error` **wait** **(** **)** diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 7c1d2d75a..0b5df65e8 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -7,8 +7,7 @@ ResourceLoader ============== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description Resource Loader. -Member Functions ----------------- +Methods +------- +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | +| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | +--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,38 +41,38 @@ Description Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScript has a simplified load() function, though. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ResourceLoader_exists: -- :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +- :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** .. _class_ResourceLoader_get_dependencies: -- :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** +- :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** .. _class_ResourceLoader_get_recognized_extensions_for_type: -- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Return the list of recognized extensions for a resource type. .. _class_ResourceLoader_has: -- :ref:`bool` **has** **(** :ref:`String` path **)** +- :ref:`bool` **has** **(** :ref:`String` path **)** .. _class_ResourceLoader_has_cached: -- :ref:`bool` **has_cached** **(** :ref:`String` path **)** +- :ref:`bool` **has_cached** **(** :ref:`String` path **)** .. _class_ResourceLoader_load: -- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** +- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** .. _class_ResourceLoader_load_interactive: -- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** +- :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 9e070ba64..10764b79a 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -7,8 +7,7 @@ ResourcePreloader ================= -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description Resource Preloader Node. -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | +| void | :ref:`add_resource` **(** :ref:`String` name, :ref:`Resource` resource **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | +| :ref:`Resource` | :ref:`get_resource` **(** :ref:`String` name **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_resource_list` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_resource` **(** :ref:`String` name **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_resource` **(** :ref:`String` name **)** | +| void | :ref:`remove_resource` **(** :ref:`String` name **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | +| void | :ref:`rename_resource` **(** :ref:`String` name, :ref:`String` newname **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -38,40 +37,40 @@ Description Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ResourcePreloader_add_resource: -- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** +- void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** .. _class_ResourcePreloader_get_resource: -- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const +- :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. .. _class_ResourcePreloader_get_resource_list: -- :ref:`PoolStringArray` **get_resource_list** **(** **)** const +- :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. .. _class_ResourcePreloader_has_resource: -- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const +- :ref:`bool` **has_resource** **(** :ref:`String` name **)** const Return true if the preloader has a given resource. .. _class_ResourcePreloader_remove_resource: -- void **remove_resource** **(** :ref:`String` name **)** +- void **remove_resource** **(** :ref:`String` name **)** Remove a resource from the preloader by text id. .. _class_ResourcePreloader_rename_resource: -- void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** +- void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** Rename a resource inside the preloader, from a text-id to a new text-id. diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index ee12620eb..59ebf643f 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -7,26 +7,25 @@ ResourceSaver ============= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- -Resource Saving Interface. +Resource saving interface. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | +| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_ResourceSaver_SaverFlags: @@ -43,21 +42,21 @@ enum **SaverFlags** Description ----------- -Resource Saving Interface. This interface is used for saving resources to disk. +Resource saving interface, used for saving resources to disk. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ResourceSaver_get_recognized_extensions: -- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** -Return the list of extensions available for saving a resource of a given type. +Returns the list of extensions available for saving a resource of a given type. .. _class_ResourceSaver_save: -- :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** +- :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** -Save a resource to disk, to a given path. +Saves a resource to disk. diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 1ecdc63c9..5b8a81626 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -7,8 +7,7 @@ RichTextLabel ============= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description Label that displays rich text. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image **)** | +| void | :ref:`add_image` **(** :ref:`Texture` image **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | +| void | :ref:`add_text` **(** :ref:`String` text **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | +| :ref:`Error` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,29 +33,29 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_total_character_count` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`newline` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | +| :ref:`Error` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pop` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_align` **(** :ref:`Align` align **)** | +| void | :ref:`push_align` **(** :ref:`Align` align **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_cell` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_color` **(** :ref:`Color` color **)** | +| void | :ref:`push_color` **(** :ref:`Color` color **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font` **(** :ref:`Font` font **)** | +| void | :ref:`push_font` **(** :ref:`Font` font **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_indent` **(** :ref:`int` level **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`ListType` type **)** | +| void | :ref:`push_list` **(** :ref:`ListType` type **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | +| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_table` **(** :ref:`int` columns **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -74,75 +73,25 @@ Signals .. _class_RichTextLabel_meta_clicked: -- **meta_clicked** **(** :ref:`Nil` meta **)** +- **meta_clicked** **(** :ref:`Nil` meta **)** -Triggered when the user clicks on content between url tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. +Triggered when the user clicks on content between url tags. If the meta is defined in text, e.g. ``[url={"data"="hi"}]hi[/url]``, then the parameter for this signal will be a :ref:`String` type. If a particular type or an object is desired, the :ref:`push_meta` method must be used to manually insert the data into the tag stack. .. _class_RichTextLabel_meta_hover_ended: -- **meta_hover_ended** **(** :ref:`Nil` meta **)** +- **meta_hover_ended** **(** :ref:`Nil` meta **)** Triggers when the mouse exits a meta tag. .. _class_RichTextLabel_meta_hover_started: -- **meta_hover_started** **(** :ref:`Nil` meta **)** +- **meta_hover_started** **(** :ref:`Nil` meta **)** Triggers when the mouse enters a meta tag. -Member Variables ----------------- - - .. _class_RichTextLabel_bbcode_enabled: - -- :ref:`bool` **bbcode_enabled** - If ``true`` the label uses BBCode formatting. Default value: ``false``. - - .. _class_RichTextLabel_bbcode_text: - -- :ref:`String` **bbcode_text** - The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. - - .. _class_RichTextLabel_meta_underlined: - -- :ref:`bool` **meta_underlined** - If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``. - - .. _class_RichTextLabel_override_selected_font_color: - -- :ref:`bool` **override_selected_font_color** - If ``true`` the label uses the custom font color. Default value: ``false``. - - .. _class_RichTextLabel_percent_visible: - -- :ref:`float` **percent_visible** - The text's visibility, as a :ref:`float` between 0.0 and 1.0. - - .. _class_RichTextLabel_scroll_active: - -- :ref:`bool` **scroll_active** - If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. - - .. _class_RichTextLabel_scroll_following: - -- :ref:`bool` **scroll_following** - If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. - - .. _class_RichTextLabel_selection_enabled: - -- :ref:`bool` **selection_enabled** - If ``true``, the label allows text selection. - - .. _class_RichTextLabel_tab_size: - -- :ref:`int` **tab_size** - The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. - - .. _class_RichTextLabel_text: - -- :ref:`String` **text** - The raw text of the label. - -When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. - - .. _class_RichTextLabel_visible_characters: - -- :ref:`int` **visible_characters** - The restricted number of characters to display in the label. - - -Enums ------ +Enumerations +------------ .. _enum_RichTextLabel_ListType: @@ -191,24 +140,74 @@ Tutorials - :doc:`../tutorials/gui/bbcode_in_richtextlabel` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_RichTextLabel_bbcode_enabled: + +- :ref:`bool` **bbcode_enabled** - If ``true`` the label uses BBCode formatting. Default value: ``false``. + + .. _class_RichTextLabel_bbcode_text: + +- :ref:`String` **bbcode_text** - The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited. + + .. _class_RichTextLabel_meta_underlined: + +- :ref:`bool` **meta_underlined** - If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``. + + .. _class_RichTextLabel_override_selected_font_color: + +- :ref:`bool` **override_selected_font_color** - If ``true`` the label uses the custom font color. Default value: ``false``. + + .. _class_RichTextLabel_percent_visible: + +- :ref:`float` **percent_visible** - The text's visibility, as a :ref:`float` between 0.0 and 1.0. + + .. _class_RichTextLabel_scroll_active: + +- :ref:`bool` **scroll_active** - If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. + + .. _class_RichTextLabel_scroll_following: + +- :ref:`bool` **scroll_following** - If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. + + .. _class_RichTextLabel_selection_enabled: + +- :ref:`bool` **selection_enabled** - If ``true``, the label allows text selection. + + .. _class_RichTextLabel_tab_size: + +- :ref:`int` **tab_size** - The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. + + .. _class_RichTextLabel_text: + +- :ref:`String` **text** - The raw text of the label. + +When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify :ref:`bbcode_text`. + + .. _class_RichTextLabel_visible_characters: + +- :ref:`int` **visible_characters** - The restricted number of characters to display in the label. + + +Method Descriptions +------------------- .. _class_RichTextLabel_add_image: -- void **add_image** **(** :ref:`Texture` image **)** +- void **add_image** **(** :ref:`Texture` image **)** Adds an image's opening and closing tags to the tag stack. .. _class_RichTextLabel_add_text: -- void **add_text** **(** :ref:`String` text **)** +- void **add_text** **(** :ref:`String` text **)** Adds raw non-bbcode-parsed text to the tag stack. .. _class_RichTextLabel_append_bbcode: -- :ref:`Error` **append_bbcode** **(** :ref:`String` bbcode **)** +- :ref:`Error` **append_bbcode** **(** :ref:`String` bbcode **)** Parses ``bbcode`` and adds tags to the tag stack as needed. Returns the result of the parsing, ``OK`` if successful. @@ -238,7 +237,7 @@ Returns the total number of characters from text tags. Does not include bbcodes. .. _class_RichTextLabel_get_v_scroll: -- :ref:`VScrollBar` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the vertical scrollbar. @@ -256,7 +255,7 @@ Adds a newline tag to the tag stack. .. _class_RichTextLabel_parse_bbcode: -- :ref:`Error` **parse_bbcode** **(** :ref:`String` bbcode **)** +- :ref:`Error` **parse_bbcode** **(** :ref:`String` bbcode **)** The assignment version of :ref:`append_bbcode`. Clears the tag stack and inserts the new content. Returns ``OK`` if parses ``bbcode`` successfully. @@ -268,7 +267,7 @@ Terminates the current tag. Use after ``push_*`` methods to close bbcodes manual .. _class_RichTextLabel_push_align: -- void **push_align** **(** :ref:`Align` align **)** +- void **push_align** **(** :ref:`Align` align **)** Adds a ``[right]`` tag to the tag stack. @@ -280,13 +279,13 @@ Adds a ``[cell]`` tag to the tag stack. Must be inside a table tag. See :ref:`pu .. _class_RichTextLabel_push_color: -- void **push_color** **(** :ref:`Color` color **)** +- void **push_color** **(** :ref:`Color` color **)** Adds a ``[color]`` tag to the tag stack. .. _class_RichTextLabel_push_font: -- void **push_font** **(** :ref:`Font` font **)** +- void **push_font** **(** :ref:`Font` font **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. @@ -298,15 +297,15 @@ Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_siz .. _class_RichTextLabel_push_list: -- void **push_list** **(** :ref:`ListType` type **)** +- void **push_list** **(** :ref:`ListType` type **)** Adds a list tag to the tag stack. Similar to the bbcodes ``[ol]`` or ``[ul]``, but supports more list types. Not fully implemented! .. _class_RichTextLabel_push_meta: -- void **push_meta** **(** :ref:`Variant` data **)** +- void **push_meta** **(** :ref:`Variant` data **)** -Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. +Adds a meta tag to the tag stack. Similar to the bbcode ``[url=something]{text}[/url]``, but supports non-:ref:`String` metadata types. .. _class_RichTextLabel_push_table: diff --git a/classes/class_rid.rst b/classes/class_rid.rst index e79d795da..c4bd3eb58 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -12,13 +12,13 @@ RID Brief Description ----------------- -Handle for a :ref:`Resource`'s unique ID. +Handle for a :ref:`Resource`'s unique ID. -Member Functions ----------------- +Methods +------- +------------------------+------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | +| :ref:`RID` | :ref:`RID` **(** :ref:`Object` from **)** | +------------------------+------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_id` **(** **)** | +------------------------+------------------------------------------------------------------------+ @@ -26,21 +26,21 @@ Member Functions Description ----------- -The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as :ref:`VisualServer`. +The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as :ref:`VisualServer`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_RID_RID: -- :ref:`RID` **RID** **(** :ref:`Object` from **)** +- :ref:`RID` **RID** **(** :ref:`Object` from **)** -Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. +Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. .. _class_RID_get_id: - :ref:`int` **get_id** **(** **)** -Retrieve the ID of the referenced resource. +Returns the ID of the referenced resource. diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index d6f8bc377..b50ce3b77 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -7,10 +7,8 @@ RigidBody ========= -**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`VehicleBody` - +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`VehicleBody` **Category:** Core Brief Description @@ -18,27 +16,27 @@ Brief Description Physics Body whose position is determined through physics simulation in 3D space. -Member Functions ----------------- +Methods +------- +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | +| void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | +| void | :ref:`add_central_force` **(** :ref:`Vector3` force **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | +| void | :ref:`add_torque` **(** :ref:`Vector3` torque **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | +| void | :ref:`apply_central_impulse` **(** :ref:`Vector3` impulse **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | +| void | :ref:`apply_torque_impulse` **(** :ref:`Vector3` impulse **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | +| void | :ref:`set_axis_velocity` **(** :ref:`Vector3` axis_velocity **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -46,31 +44,31 @@ Signals .. _class_RigidBody_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Node` body **)** Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. .. _class_RigidBody_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Node` body **)** Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. .. _class_RigidBody_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** 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 :ref:`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. +This signal not only receives the body that collided with this one, but also its :ref:`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. .. _class_RigidBody_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** 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 :ref:`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. +This signal not only receives the body that stopped colliding with this one, but also its :ref:`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. .. _class_RigidBody_sleeping_state_changed: @@ -79,8 +77,37 @@ This signal not only receives the body that stopped colliding with this one, but Emitted when the body changes its sleeping state. Either by sleeping or waking up. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_RigidBody_Mode: + +enum **Mode** + +- **MODE_RIGID** = **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. +- **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody`, and can only move by user code. +- **MODE_CHARACTER** = **2** --- Character body. This behaves like a rigid body, but can not rotate. +- **MODE_KINEMATIC** = **3** --- Kinematic body. The body behaves like a :ref:`KinematicBody`, and can only move by user code. + + +Description +----------- + +This is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. + +A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. + +**Note:** Don't change a RigidBody'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. If you need to directly affect the body's state, use :ref:`_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 :ref:`custom_integrator`. + +Tutorials +--------- + +- :doc:`../tutorials/physics/physics_introduction` + +Property Descriptions +--------------------- .. _class_RigidBody_angular_damp: @@ -88,7 +115,7 @@ Member Variables .. _class_RigidBody_angular_velocity: -- :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. +- :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. .. _class_RigidBody_axis_lock_angular_x: @@ -154,7 +181,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody_linear_velocity: -- :ref:`Vector3` **linear_velocity** - RigidBody's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. +- :ref:`Vector3` **linear_velocity** - RigidBody's linear velocity. Can be used sporadically, but **DON'T SET THIS IN EVERY FRAME**, because physics may run in another thread and runs at a different granularity. Use :ref:`_integrate_forces` as your process loop for precise control of the body state. .. _class_RigidBody_mass: @@ -162,11 +189,11 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody_mode: -- :ref:`Mode` **mode** - The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. +- :ref:`Mode` **mode** - The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. .. _class_RigidBody_physics_material_override: -- :ref:`PhysicsMaterial` **physics_material_override** +- :ref:`PhysicsMaterial` **physics_material_override** .. _class_RigidBody_sleeping: @@ -177,81 +204,64 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`float` **weight** - RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". -Enums ------ - - .. _enum_RigidBody_Mode: - -enum **Mode** - -- **MODE_RIGID** = **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. -- **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody`, and can only move by user code. -- **MODE_CHARACTER** = **2** --- Character body. This behaves like a rigid body, but can not rotate. -- **MODE_KINEMATIC** = **3** --- Kinematic body. The body behaves like a :ref:`KinematicBody`, and can only move by user code. - - -Description ------------ - -This is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. - -A RigidBody has 4 behavior :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. - -**Note:** Don't change a RigidBody'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. If you need to directly affect the body's state, use :ref:`_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 :ref:`custom_integrator`. - -Tutorials ---------- - -- :doc:`../tutorials/physics/physics_introduction` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_RigidBody__integrate_forces: -- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual 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 :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. .. _class_RigidBody_add_central_force: -- void **add_central_force** **(** :ref:`Vector3` force **)** +- void **add_central_force** **(** :ref:`Vector3` force **)** + +Adds a constant directional force without affecting rotation. + +This is equivalent to ``add_force(force, Vector3(0,0,0))``. .. _class_RigidBody_add_force: -- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** +- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** + +Adds a constant force (i.e. acceleration). .. _class_RigidBody_add_torque: -- void **add_torque** **(** :ref:`Vector3` torque **)** +- void **add_torque** **(** :ref:`Vector3` torque **)** + +Adds a constant rotational force (i.e. a motor) without affecting position. .. _class_RigidBody_apply_central_impulse: -- void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** +- void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** + +Applies a single directional impulse without affecting rotation. + +This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. .. _class_RigidBody_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** 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 position are in global coordinates, and the position is relative to the object's origin. .. _class_RigidBody_apply_torque_impulse: -- void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** +- void **apply_torque_impulse** **(** :ref:`Vector3` impulse **)** Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. .. _class_RigidBody_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** const Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see :ref:`set_max_contacts_reported` to increase it. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. .. _class_RigidBody_set_axis_velocity: -- void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** +- void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** 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. diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 31d1ff52f..49fd63643 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -7,8 +7,7 @@ RigidBody2D =========== -**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,29 +15,29 @@ Brief Description A body that is controlled by the 2D physics engine. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | +| void | :ref:`_integrate_forces` **(** :ref:`Physics2DDirectBodyState` state **)** virtual | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | +| void | :ref:`add_central_force` **(** :ref:`Vector2` force **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | +| void | :ref:`add_force` **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_torque` **(** :ref:`float` torque **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | +| void | :ref:`apply_central_impulse` **(** :ref:`Vector2` impulse **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +| void | :ref:`apply_impulse` **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_torque_impulse` **(** :ref:`float` torque **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +| :ref:`Array` | :ref:`get_colliding_bodies` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | +| void | :ref:`set_axis_velocity` **(** :ref:`Vector2` axis_velocity **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +| :ref:`bool` | :ref:`test_motion` **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -46,27 +45,27 @@ Signals .. _class_RigidBody2D_body_entered: -- **body_entered** **(** :ref:`Object` body **)** +- **body_entered** **(** :ref:`Node` body **)** Emitted when a body enters into contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_exited: -- **body_exited** **(** :ref:`Object` body **)** +- **body_exited** **(** :ref:`Node` body **)** Emitted when a body exits contact with this one. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_shape_entered: -- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_body_shape_exited: -- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** -Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. +Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D` for shape index information. :ref:`contact_monitor` must be ``true`` and :ref:`contacts_reported` greater than ``0``. .. _class_RigidBody2D_sleeping_state_changed: @@ -75,8 +74,40 @@ Emitted when a body shape exits contact with this one. Reports colliding shape i Emitted when :ref:`sleeping` changes. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_RigidBody2D_CCDMode: + +enum **CCDMode** + +- **CCD_MODE_DISABLED** = **0** --- Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. +- **CCD_MODE_CAST_RAY** = **1** --- Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. +- **CCD_MODE_CAST_SHAPE** = **2** --- Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. + + .. _enum_RigidBody2D_Mode: + +enum **Mode** + +- **MODE_RIGID** = **0** --- 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. +- **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody2D` and does not move. +- **MODE_CHARACTER** = **2** --- Character mode. Similar to ``MODE_RIGID``, but the body can not rotate. +- **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D`, and must be moved by code. + + +Description +----------- + +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 :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. + +**Note:** You should not change a RigidBody2D's ``position`` or ``linear_velocity`` every frame or even very often. If you need to directly affect the body's state, use :ref:`_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 :ref:`custom_integrator`. + +Property Descriptions +--------------------- .. _class_RigidBody2D_angular_damp: @@ -88,7 +119,7 @@ Member Variables .. _class_RigidBody2D_applied_force: -- :ref:`Vector2` **applied_force** - The body's total applied force. +- :ref:`Vector2` **applied_force** - The body's total applied force. .. _class_RigidBody2D_applied_torque: @@ -112,7 +143,7 @@ Member Variables .. _class_RigidBody2D_continuous_cd: -- :ref:`CCDMode` **continuous_cd** - Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. +- :ref:`CCDMode` **continuous_cd** - Continuous collision detection mode. Default value: ``CCD_MODE_DISABLED``. 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 ``CCD_MODE_`` constants for details. @@ -126,7 +157,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody2D_gravity_scale: -- :ref:`float` **gravity_scale** - 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 :ref:`Area2D`\ s. Default value: ``1``. +- :ref:`float` **gravity_scale** - 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 :ref:`Area2D`\ s. Default value: ``1``. .. _class_RigidBody2D_inertia: @@ -138,7 +169,7 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody2D_linear_velocity: -- :ref:`Vector2` **linear_velocity** - The body's linear velocity. +- :ref:`Vector2` **linear_velocity** - The body's linear velocity. .. _class_RigidBody2D_mass: @@ -146,11 +177,11 @@ Continuous collision detection tries to predict where a moving body will collide .. _class_RigidBody2D_mode: -- :ref:`Mode` **mode** - The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. +- :ref:`Mode` **mode** - The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. .. _class_RigidBody2D_physics_material_override: -- :ref:`PhysicsMaterial` **physics_material_override** +- :ref:`PhysicsMaterial` **physics_material_override** .. _class_RigidBody2D_sleeping: @@ -161,54 +192,22 @@ Continuous collision detection tries to predict where a moving body will collide - :ref:`float` **weight** - The body's weight based on its mass and the "Default Gravity" value in "Project > Project Settings > Physics > 2d". -Enums ------ - - .. _enum_RigidBody2D_CCDMode: - -enum **CCDMode** - -- **CCD_MODE_DISABLED** = **0** --- Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. -- **CCD_MODE_CAST_RAY** = **1** --- Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise. -- **CCD_MODE_CAST_SHAPE** = **2** --- Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise. - - .. _enum_RigidBody2D_Mode: - -enum **Mode** - -- **MODE_RIGID** = **0** --- 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. -- **MODE_STATIC** = **1** --- Static mode. The body behaves like a :ref:`StaticBody2D` and does not move. -- **MODE_CHARACTER** = **2** --- Character mode. Similar to ``MODE_RIGID``, but the body can not rotate. -- **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D`, and must be moved by code. - - -Description ------------ - -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 :ref:`mode`\ s: Rigid, Static, Character, and Kinematic. - -**Note:** You should not change a RigidBody2D's ``position`` or ``linear_velocity`` every frame or even very often. If you need to directly affect the body's state, use :ref:`_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 :ref:`custom_integrator`. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_RigidBody2D__integrate_forces: -- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual +- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual 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 ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. .. _class_RigidBody2D_add_central_force: -- void **add_central_force** **(** :ref:`Vector2` force **)** +- void **add_central_force** **(** :ref:`Vector2` force **)** .. _class_RigidBody2D_add_force: -- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** +- void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. @@ -218,11 +217,11 @@ Adds a positioned force to the body. Both the force and the offset from the body .. _class_RigidBody2D_apply_central_impulse: -- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** +- void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** .. _class_RigidBody2D_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** +- void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** 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. @@ -232,20 +231,20 @@ Applies a positioned impulse to the body (which will be affected by the body mas .. _class_RigidBody2D_get_colliding_bodies: -- :ref:`Array` **get_colliding_bodies** **(** **)** const +- :ref:`Array` **get_colliding_bodies** **(** **)** const Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported` to set the maximum number reported. You must also set :ref:`contact_monitor` to ``true``. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. .. _class_RigidBody2D_set_axis_velocity: -- void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** +- void **set_axis_velocity** **(** :ref:`Vector2` axis_velocity **)** 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. .. _class_RigidBody2D_test_motion: -- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** +- :ref:`bool` **test_motion** **(** :ref:`Vector2` motion, :ref:`bool` infinite_inertia=true, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=null **)** -Returns ``true`` if a collision would result from moving in the given vector. ``margin`` increases the size of the shapes involved in the collision detection, and ``result`` is an object of type :ref:`Physics2DTestMotionResult`, which contains additional information about the collision (should there be one). +Returns ``true`` if a collision would result from moving in the given vector. ``margin`` increases the size of the shapes involved in the collision detection, and ``result`` is an object of type :ref:`Physics2DTestMotionResult`, which contains additional information about the collision (should there be one). diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 505083d05..24f6bdd43 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -7,8 +7,7 @@ RootMotionView ============== -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,12 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_RootMotionView_animation_path: -- :ref:`NodePath` **animation_path** +- :ref:`NodePath` **animation_path** .. _class_RootMotionView_cell_size: @@ -29,7 +28,7 @@ Member Variables .. _class_RootMotionView_color: -- :ref:`Color` **color** +- :ref:`Color` **color** .. _class_RootMotionView_radius: diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 097091f08..e65c4c39b 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -7,8 +7,7 @@ SceneState ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,53 +15,53 @@ Brief Description A script interface to a scene file's data. -Member Functions ----------------- +Methods +------- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | +| :ref:`Array` | :ref:`get_connection_binds` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_count` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_flags` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_connection_method` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_connection_signal` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | +| :ref:`NodePath` | :ref:`get_connection_source` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | +| :ref:`NodePath` | :ref:`get_connection_target` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | +| :ref:`PoolStringArray` | :ref:`get_node_groups` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_index` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | +| :ref:`PackedScene` | :ref:`get_node_instance` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_node_instance_placeholder` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_node_name` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | +| :ref:`NodePath` | :ref:`get_node_owner_path` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | +| :ref:`NodePath` | :ref:`get_node_path` **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_property_count` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +| :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_instance_placeholder` **(** :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_SceneState_GenEditState: @@ -78,12 +77,12 @@ Description Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SceneState_get_connection_binds: -- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const +- :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const Returns the list of bound parameters for the signal at ``idx``. @@ -97,29 +96,29 @@ Returns the number of signal connections in the scene. - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const -Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT_*`` flags. +Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT_*`` flags. .. _class_SceneState_get_connection_method: -- :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const Returns the method connected to the signal at ``idx``. .. _class_SceneState_get_connection_signal: -- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const +- :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const Returns the name of the signal at ``idx``. .. _class_SceneState_get_connection_source: -- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_source** **(** :ref:`int` idx **)** const Returns the path to the node that owns the signal at ``idx``, relative to the root node. .. _class_SceneState_get_connection_target: -- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_connection_target** **(** :ref:`int` idx **)** const Returns the path to the node that owns the method connected to the signal at ``idx``, relative to the root node. @@ -131,7 +130,7 @@ Returns the number of nodes in the scene. .. _class_SceneState_get_node_groups: -- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const +- :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const Returns the list of group names associated with the node at ``idx``. @@ -141,31 +140,31 @@ Returns the list of group names associated with the node at ``idx``. .. _class_SceneState_get_node_instance: -- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const +- :ref:`PackedScene` **get_node_instance** **(** :ref:`int` idx **)** const Returns the scene for the node at ``idx`` or ``null`` if the node is not an instance. .. _class_SceneState_get_node_instance_placeholder: -- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_instance_placeholder** **(** :ref:`int` idx **)** const -Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. +Returns the path to the represented scene file if the node at ``idx`` is an :ref:`InstancePlaceholder`. .. _class_SceneState_get_node_name: -- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const Returns the name of the node at ``idx``. .. _class_SceneState_get_node_owner_path: -- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const +- :ref:`NodePath` **get_node_owner_path** **(** :ref:`int` idx **)** const Returns the path to the owner of the node at ``idx``, relative to the root node. .. _class_SceneState_get_node_path: -- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const +- :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const Returns the path to the node at ``idx``. @@ -177,19 +176,19 @@ Returns the number of exported or overridden properties for the node at ``idx``. .. _class_SceneState_get_node_property_name: -- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`String` **get_node_property_name** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const Returns the name of the property at ``prop_idx`` for the node at ``idx``. .. _class_SceneState_get_node_property_value: -- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const Returns the value of the property at ``prop_idx`` for the node at ``idx``. .. _class_SceneState_get_node_type: -- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const +- :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const Returns the type of the node at ``idx``. @@ -197,6 +196,6 @@ Returns the type of the node at ``idx``. - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const -Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. +Returns ``true`` if the node at ``idx`` is an :ref:`InstancePlaceholder`. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 8a7612bcc..893957a3e 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -7,8 +7,7 @@ SceneTree ========= -**Inherits:** :ref:`MainLoop` **<** :ref:`Object` - +**Inherits:** :ref:`MainLoop` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,33 +15,33 @@ Brief Description SceneTree manages a hierarchy of nodes. -Member Functions ----------------- +Methods +------- +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call_group` **(** :ref:`String` group, :ref:`String` method **)** vararg | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | +| :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | +| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | +| :ref:`Array` | :ref:`get_nodes_in_group` **(** :ref:`String` group **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_rpc_sender_id` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_group` **(** :ref:`String` name **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_network_peer` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -50,27 +49,27 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_network_server` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | +| void | :ref:`notify_group` **(** :ref:`String` group, :ref:`int` notification **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`quit` **(** **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | +| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_auto_accept_quit` **(** :ref:`bool` enabled **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`set_group` **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_as_handled` **(** **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_quit_on_go_back` **(** :ref:`bool` enabled **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | +| void | :ref:`set_screen_stretch` **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -90,7 +89,7 @@ Emitted whenever this SceneTree's :ref:`network_peer` files, :ref:`int` screen **)** +- **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** Emitted whenever files are drag-and-dropped onto the window. @@ -114,19 +113,19 @@ Emitted whenever this SceneTree's :ref:`network_peer` node **)** +- **node_added** **(** :ref:`Node` node **)** Emitted whenever a node is added to the SceneTree. .. _class_SceneTree_node_configuration_warning_changed: -- **node_configuration_warning_changed** **(** :ref:`Object` node **)** +- **node_configuration_warning_changed** **(** :ref:`Node` node **)** Emitted when a node's configuration changed. Only emitted in tool mode. .. _class_SceneTree_node_removed: -- **node_removed** **(** :ref:`Object` node **)** +- **node_removed** **(** :ref:`Node` node **)** Emitted whenever a node is removed from the SceneTree. @@ -155,58 +154,8 @@ Emitted whenever this SceneTree's :ref:`network_peer` **current_scene** - The current scene. - - .. _class_SceneTree_debug_collisions_hint: - -- :ref:`bool` **debug_collisions_hint** - - .. _class_SceneTree_debug_navigation_hint: - -- :ref:`bool` **debug_navigation_hint** - - .. _class_SceneTree_edited_scene_root: - -- :ref:`Node` **edited_scene_root** - The root of the edited scene. - - .. _class_SceneTree_multiplayer: - -- :ref:`MultiplayerAPI` **multiplayer** - The default :ref:`MultiplayerAPI` instance for this SceneTree. - - .. _class_SceneTree_multiplayer_poll: - -- :ref:`bool` **multiplayer_poll** - If ``true`` (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. - -When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protecion when accessing the :ref:`MultiplayerAPI` from threads. - - .. _class_SceneTree_network_peer: - -- :ref:`NetworkedMultiplayerPeer` **network_peer** - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. - - .. _class_SceneTree_paused: - -- :ref:`bool` **paused** - If ``true`` the SceneTree is paused. - - .. _class_SceneTree_refuse_new_network_connections: - -- :ref:`bool` **refuse_new_network_connections** - If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. - - .. _class_SceneTree_root: - -- :ref:`Viewport` **root** - The SceneTree's :ref:`Viewport`. - - .. _class_SceneTree_use_font_oversampling: - -- :ref:`bool` **use_font_oversampling** - If ``true`` font oversampling is used. - - -Enums ------ +Enumerations +------------ .. _enum_SceneTree_GroupCallFlags: @@ -247,38 +196,88 @@ Tutorials - :doc:`../getting_started/step_by_step/scene_tree` - :doc:`../tutorials/viewports/multiple_resolutions` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_SceneTree_current_scene: + +- :ref:`Node` **current_scene** - The current scene. + + .. _class_SceneTree_debug_collisions_hint: + +- :ref:`bool` **debug_collisions_hint** + + .. _class_SceneTree_debug_navigation_hint: + +- :ref:`bool` **debug_navigation_hint** + + .. _class_SceneTree_edited_scene_root: + +- :ref:`Node` **edited_scene_root** - The root of the edited scene. + + .. _class_SceneTree_multiplayer: + +- :ref:`MultiplayerAPI` **multiplayer** - The default :ref:`MultiplayerAPI` instance for this SceneTree. + + .. _class_SceneTree_multiplayer_poll: + +- :ref:`bool` **multiplayer_poll** - If ``true`` (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. + +When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protecion when accessing the :ref:`MultiplayerAPI` from threads. + + .. _class_SceneTree_network_peer: + +- :ref:`NetworkedMultiplayerPeer` **network_peer** - The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with :ref:`is_network_server()`) and will set root node's network mode to master (see NETWORK_MODE\_\* constants in :ref:`Node`), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. + + .. _class_SceneTree_paused: + +- :ref:`bool` **paused** - If ``true`` the SceneTree is paused. + + .. _class_SceneTree_refuse_new_network_connections: + +- :ref:`bool` **refuse_new_network_connections** - If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. + + .. _class_SceneTree_root: + +- :ref:`Viewport` **root** - The SceneTree's :ref:`Viewport`. + + .. _class_SceneTree_use_font_oversampling: + +- :ref:`bool` **use_font_oversampling** - If ``true`` font oversampling is used. + + +Method Descriptions +------------------- .. _class_SceneTree_call_group: -- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group** **(** :ref:`String` group, :ref:`String` method **)** vararg Calls ``method`` on each member of the given group. .. _class_SceneTree_call_group_flags: -- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg +- :ref:`Variant` **call_group_flags** **(** :ref:`int` flags, :ref:`String` group, :ref:`String` method **)** vararg -Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. +Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags`. .. _class_SceneTree_change_scene: -- :ref:`Error` **change_scene** **(** :ref:`String` path **)** +- :ref:`Error` **change_scene** **(** :ref:`String` path **)** Changes to the scene at the given ``path``. .. _class_SceneTree_change_scene_to: -- :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** +- :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** -Changes to the given :ref:`PackedScene`. +Changes to the given :ref:`PackedScene`. .. _class_SceneTree_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** -Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer. +Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer. .. _class_SceneTree_get_frame: @@ -286,7 +285,7 @@ Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTree .. _class_SceneTree_get_network_connected_peers: -- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this SceneTree's :ref:`network_peer`. @@ -304,7 +303,7 @@ Returns the number of nodes in this SceneTree. .. _class_SceneTree_get_nodes_in_group: -- :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** +- :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** Returns all nodes assigned to the given group. @@ -316,7 +315,7 @@ Returns the sender's peer ID for the most recently received RPC call. .. _class_SceneTree_has_group: -- :ref:`bool` **has_group** **(** :ref:`String` name **)** const +- :ref:`bool` **has_group** **(** :ref:`String` name **)** const Returns ``true`` if the given group exists. @@ -340,19 +339,19 @@ Returns ``true`` if this SceneTree's :ref:`network_peer` group, :ref:`int` notification **)** +- void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``. .. _class_SceneTree_notify_group_flags: -- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** +- void **notify_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`int` notification **)** -Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. +Sends the given notification to all members of the ``group``, respecting the given :ref:`GroupCallFlags`. .. _class_SceneTree_queue_delete: -- void **queue_delete** **(** :ref:`Object` obj **)** +- void **queue_delete** **(** :ref:`Object` obj **)** Queues the given object for deletion, delaying the call to :ref:`Object.free` to after the current frame. @@ -364,7 +363,7 @@ Quits the application. .. _class_SceneTree_reload_current_scene: -- :ref:`Error` **reload_current_scene** **(** **)** +- :ref:`Error` **reload_current_scene** **(** **)** Reloads the currently active scene. @@ -376,15 +375,15 @@ If ``true`` the application automatically accepts quitting. .. _class_SceneTree_set_group: -- void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group** **(** :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** Sets the given ``property`` to ``value`` on all members of the given group. .. _class_SceneTree_set_group_flags: -- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** +- void **set_group_flags** **(** :ref:`int` call_flags, :ref:`String` group, :ref:`String` property, :ref:`Variant` value **)** -Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. +Sets the given ``property`` to ``value`` on all members of the given group, respecting the given :ref:`GroupCallFlags`. .. _class_SceneTree_set_input_as_handled: @@ -400,8 +399,8 @@ If ``true`` the application quits automatically on going back (e.g. on Android). .. _class_SceneTree_set_screen_stretch: -- void **set_screen_stretch** **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** +- void **set_screen_stretch** **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** -Configures screen stretching to the given :ref:`StretchMode`, :ref:`StretchAspect`, minimum size and ``shrink``. +Configures screen stretching to the given :ref:`StretchMode`, :ref:`StretchAspect`, minimum size and ``shrink``. diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 6d09ff0c3..39cf7b76e 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -7,8 +7,7 @@ SceneTreeTimer ============== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -24,8 +23,8 @@ Signals - **timeout** **(** **)** -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_SceneTreeTimer_time_left: diff --git a/classes/class_script.rst b/classes/class_script.rst index b41f34b82..d68733084 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -7,10 +7,8 @@ Script ====== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`CSharpScript`, :ref:`NativeScript`, :ref:`PluginScript` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`CSharpScript`, :ref:`NativeScript`, :ref:`PluginScript` **Category:** Core Brief Description @@ -18,93 +16,95 @@ Brief Description A class stored as a resource. -Member Functions ----------------- +Methods +------- +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_instance` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_base_script` **(** **)** const | +| :ref:`Script` | :ref:`get_base_script` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | +| :ref:`String` | :ref:`get_instance_base_type` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | +| :ref:`bool` | :ref:`has_script_signal` **(** :ref:`String` signal_name **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_source_code` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | +| :ref:`bool` | :ref:`instance_has` **(** :ref:`Object` base_object **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_tool` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | +| :ref:`Error` | :ref:`reload` **(** :ref:`bool` keep_state=false **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Script_source_code: - -- :ref:`String` **source_code** - The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically. - - Description ----------- -A class stored as a resource. The script exends the functionality of all objects that instance it. +A class stored as a resource. A script exends the functionality of all objects that instance it. -The 'new' method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. +The ``new`` method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. Tutorials --------- - :doc:`../getting_started/step_by_step/scripting` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Script_source_code: + +- :ref:`String` **source_code** - The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. + + +Method Descriptions +------------------- .. _class_Script_can_instance: - :ref:`bool` **can_instance** **(** **)** const -Returns true if the script can be instanced. +Returns ``true`` if the script can be instanced. .. _class_Script_get_base_script: -- :ref:`Script` **get_base_script** **(** **)** const +- :ref:`Script` **get_base_script** **(** **)** const Returns the script directly inherited by this script. .. _class_Script_get_instance_base_type: -- :ref:`String` **get_instance_base_type** **(** **)** const +- :ref:`String` **get_instance_base_type** **(** **)** const + +Returns the script's base type. .. _class_Script_has_script_signal: -- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const +- :ref:`bool` **has_script_signal** **(** :ref:`String` signal_name **)** const -Returns true if the script, or a base class, defines a signal with the given name. +Returns ``true`` if the script, or a base class, defines a signal with the given name. .. _class_Script_has_source_code: - :ref:`bool` **has_source_code** **(** **)** const -Returns true if the script contains non-empty source code. +Returns ``true`` if the script contains non-empty source code. .. _class_Script_instance_has: -- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const +- :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const -Returns true if 'base_object' is an instance of this script. +Returns ``true`` if ``base_object`` is an instance of this script. .. _class_Script_is_tool: - :ref:`bool` **is_tool** **(** **)** const -Returns true if the script is a tool script. A tool script can run in the editor. +Returns ``true`` if the script is a tool script. A tool script can run in the editor. .. _class_Script_reload: -- :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** +- :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** Reloads the script's class implementation. Returns an error code. diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index cfa5818ae..a56da0428 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -7,20 +7,19 @@ ScriptCreateDialog ================== -**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ConfirmationDialog` **<** :ref:`AcceptDialog` **<** :ref:`WindowDialog` **<** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -The Editor's popup dialog for creating new :ref:`Script` files. +The Editor's popup dialog for creating new :ref:`Script` files. -Member Functions ----------------- +Methods +------- +-------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path **)** | +| void | :ref:`config` **(** :ref:`String` inherits, :ref:`String` path **)** | +-------+-----------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -28,7 +27,7 @@ Signals .. _class_ScriptCreateDialog_script_created: -- **script_created** **(** :ref:`Object` script **)** +- **script_created** **(** :ref:`Script` script **)** Emitted when the user clicks the OK button. @@ -45,12 +44,12 @@ The ScriptCreateDialog creates script files according to a given template for a dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types dialog.popup_centered() -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ScriptCreateDialog_config: -- void **config** **(** :ref:`String` inherits, :ref:`String` path **)** +- void **config** **(** :ref:`String` inherits, :ref:`String` path **)** Prefills required fields to configure the ScriptCreateDialog for use. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index a67ad515e..8b0dce145 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -7,8 +7,7 @@ ScriptEditor ============ -**Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const | +| :ref:`bool` | :ref:`can_drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** | +| void | :ref:`drop_data_fw` **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_current_script` **(** **)** | +| :ref:`Script` | :ref:`get_current_script` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` point, :ref:`Control` from **)** | +| :ref:`Variant` | :ref:`get_drag_data_fw` **(** :ref:`Vector2` point, :ref:`Control` from **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | +| void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -38,46 +37,46 @@ Signals .. _class_ScriptEditor_editor_script_changed: -- **editor_script_changed** **(** :ref:`Object` script **)** +- **editor_script_changed** **(** :ref:`Script` script **)** -Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. +Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. .. _class_ScriptEditor_script_close: -- **script_close** **(** :ref:`Object` script **)** +- **script_close** **(** :ref:`Script` script **)** -Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. +Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ScriptEditor_can_drop_data_fw: -- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const +- :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const .. _class_ScriptEditor_drop_data_fw: -- void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** +- void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** .. _class_ScriptEditor_get_current_script: -- :ref:`Script` **get_current_script** **(** **)** +- :ref:`Script` **get_current_script** **(** **)** -Returns a :ref:`Script` that is currently active in editor. +Returns a :ref:`Script` that is currently active in editor. .. _class_ScriptEditor_get_drag_data_fw: -- :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** +- :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** .. _class_ScriptEditor_get_open_scripts: -- :ref:`Array` **get_open_scripts** **(** **)** const +- :ref:`Array` **get_open_scripts** **(** **)** const -Returns an array with all :ref:`Script` objects which are currently open in editor. +Returns an array with all :ref:`Script` objects which are currently open in editor. .. _class_ScriptEditor_open_script_create_dialog: -- void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** +- void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index aa53973cb..899659a08 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -7,10 +7,8 @@ ScrollBar ========= -**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`HScrollBar`, :ref:`VScrollBar` - +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`HScrollBar`, :ref:`VScrollBar` **Category:** Core Brief Description @@ -28,16 +26,16 @@ Signals Emitted whenever the scrollbar is being scrolled. -Member Variables ----------------- +Description +----------- + +Scrollbars are a :ref:`Range` based :ref:`Control`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar`) and Vertical (:ref:`VScrollBar`) versions are available. + +Property Descriptions +--------------------- .. _class_ScrollBar_custom_step: - :ref:`float` **custom_step** -Description ------------ - -Scrollbars are a :ref:`Range` based :ref:`Control`, that display a draggable area (the size of the page). Horizontal (:ref:`HScrollBar`) and Vertical (:ref:`VScrollBar`) versions are available. - diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 8154f134a..a2f74cdea 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -7,10 +7,8 @@ ScrollContainer =============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`EditorInspector` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`EditorInspector` **Category:** Core Brief Description @@ -18,13 +16,13 @@ Brief Description A helper node for displaying scrollable elements (e.g. lists). -Member Functions ----------------- +Methods +------- +--------------------------------------+---------------------------------------------------------------------------+ -| :ref:`HScrollBar` | :ref:`get_h_scrollbar` **(** **)** | +| :ref:`HScrollBar` | :ref:`get_h_scrollbar` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------+ -| :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | +| :ref:`VScrollBar` | :ref:`get_v_scrollbar` **(** **)** | +--------------------------------------+---------------------------------------------------------------------------+ Signals @@ -43,8 +41,13 @@ Emitted whenever scrolling stops. Emitted whenever scrolling is started. -Member Variables ----------------- +Description +----------- + +A ScrollContainer node with a :ref:`Control` child and scrollbar child (HScrollbar, :ref:`VScrollBar`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). + +Property Descriptions +--------------------- .. _class_ScrollContainer_scroll_deadzone: @@ -67,20 +70,15 @@ Member Variables - :ref:`bool` **scroll_vertical_enabled** - If ``true``, enables vertical scrolling. -Description ------------ - -A ScrollContainer node with a :ref:`Control` child and scrollbar child (HScrollbar, :ref:`VScrollBar`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_ScrollContainer_get_h_scrollbar: -- :ref:`HScrollBar` **get_h_scrollbar** **(** **)** +- :ref:`HScrollBar` **get_h_scrollbar** **(** **)** .. _class_ScrollContainer_get_v_scrollbar: -- :ref:`VScrollBar` **get_v_scrollbar** **(** **)** +- :ref:`VScrollBar` **get_v_scrollbar** **(** **)** diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index 5c22ab2d3..70a14eb0e 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -7,8 +7,7 @@ SegmentShape2D ============== -**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape2D` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description Segment shape for 2D collisions. -Member Variables ----------------- - - .. _class_SegmentShape2D_a: - -- :ref:`Vector2` **a** - The segment's first point position. - - .. _class_SegmentShape2D_b: - -- :ref:`Vector2` **b** - The segment's second point position. - - Description ----------- Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``. +Property Descriptions +--------------------- + + .. _class_SegmentShape2D_a: + +- :ref:`Vector2` **a** - The segment's first point position. + + .. _class_SegmentShape2D_b: + +- :ref:`Vector2` **b** - The segment's second point position. + + diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 6569afc7a..5cebdf1b0 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -7,8 +7,7 @@ Semaphore ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,32 +15,32 @@ Brief Description A synchronization Semaphore. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------+ -| :ref:`Error` | :ref:`post` **(** **)** | +| :ref:`Error` | :ref:`post` **(** **)** | +----------------------------------------+-----------------------------------------------+ -| :ref:`Error` | :ref:`wait` **(** **)** | +| :ref:`Error` | :ref:`wait` **(** **)** | +----------------------------------------+-----------------------------------------------+ Description ----------- -A synchronization Semaphore. Element used to synchronize multiple :ref:`Thread`\ s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see :ref:`Mutex`. +A synchronization Semaphore. Element used to synchronize multiple :ref:`Thread`\ s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see :ref:`Mutex`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Semaphore_post: -- :ref:`Error` **post** **(** **)** +- :ref:`Error` **post** **(** **)** Lowers the ``Semaphore``, allowing one more thread in. Returns OK on success, ERR_BUSY otherwise. .. _class_Semaphore_wait: -- :ref:`Error` **wait** **(** **)** +- :ref:`Error` **wait** **(** **)** Tries to wait for the ``Semaphore``, if its value is zero, blocks until non-zero. Returns OK on success, ERR_BUSY otherwise. diff --git a/classes/class_separator.rst b/classes/class_separator.rst index 5855a7ada..ef791dc64 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -7,10 +7,8 @@ Separator ========= -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`HSeparator`, :ref:`VSeparator` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`HSeparator`, :ref:`VSeparator` **Category:** Core Brief Description @@ -21,5 +19,5 @@ Base class for separators. Description ----------- -Separator is a :ref:`Control` used for separating other controls. It's purely a visual decoration. Horizontal (:ref:`HSeparator`) and Vertical (:ref:`VSeparator`) versions are available. +Separator is a :ref:`Control` used for separating other controls. It's purely a visual decoration. Horizontal (:ref:`HSeparator`) and Vertical (:ref:`VSeparator`) versions are available. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index d8ed965d9..0e3ddf630 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -7,10 +7,8 @@ Shader ====== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualShader` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualShader` **Category:** Core Brief Description @@ -18,29 +16,21 @@ Brief Description A custom shader program. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | +| :ref:`Texture` | :ref:`get_default_texture_param` **(** :ref:`String` param **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** const | +| :ref:`Mode` | :ref:`get_mode` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_param` **(** :ref:`String` name **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | +| void | :ref:`set_default_texture_param` **(** :ref:`String` param, :ref:`Texture` texture **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Shader_code: - -- :ref:`String` **code** - - -Enums ------ +Enumerations +------------ .. _enum_Shader_Mode: @@ -61,25 +51,33 @@ Tutorials - :doc:`../tutorials/shading/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Shader_code: + +- :ref:`String` **code** + + +Method Descriptions +------------------- .. _class_Shader_get_default_texture_param: -- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const +- :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const .. _class_Shader_get_mode: -- :ref:`Mode` **get_mode** **(** **)** const +- :ref:`Mode` **get_mode** **(** **)** const Returns the shader mode for the shader, eiter ``MODE_CANVAS_ITEM``, ``MODE_SPATIAL`` or ``MODE_PARTICLES`` .. _class_Shader_has_param: -- :ref:`bool` **has_param** **(** :ref:`String` name **)** const +- :ref:`bool` **has_param** **(** :ref:`String` name **)** const .. _class_Shader_set_default_texture_param: -- void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** +- void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 78bf1a341..95cde8d91 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -7,49 +7,48 @@ ShaderMaterial ============== -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A material that uses a custom :ref:`Shader` program. +A material that uses a custom :ref:`Shader` program. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | +| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ShaderMaterial_shader: - -- :ref:`Shader` **shader** - The :ref:`Shader` program used to render this material. - - Description ----------- -A material that uses a custom :ref:`Shader` program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. +A material that uses a custom :ref:`Shader` program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ShaderMaterial_shader: + +- :ref:`Shader` **shader** - The :ref:`Shader` program used to render this material. + + +Method Descriptions +------------------- .. _class_ShaderMaterial_get_shader_param: -- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const +- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const Returns the current value set for this material of a uniform in the shader. .. _class_ShaderMaterial_set_shader_param: -- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** +- void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** Changes the value set for this material of a uniform in the shader. diff --git a/classes/class_shape.rst b/classes/class_shape.rst index a6dcddd29..63d8d11b2 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -7,10 +7,8 @@ Shape ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`CylinderShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`ConcavePolygonShape` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`CylinderShape`, :ref:`RayShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`ConcavePolygonShape` **Category:** Core Brief Description @@ -21,10 +19,18 @@ Base class for all 3D shape resources. Description ----------- -Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a :ref:`PhysicsBody` or :ref:`Area`. +Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a :ref:`PhysicsBody` or :ref:`Area` objects. Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` +Property Descriptions +--------------------- + + .. _class_Shape_margin: + +- :ref:`float` **margin** + + diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index 2d1b0e8ce..f46d3023c 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -7,10 +7,8 @@ Shape2D ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`RayShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`CapsuleShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`RayShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`CapsuleShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core Brief Description @@ -18,27 +16,19 @@ Brief Description Base class for all 2D Shapes. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | +| :ref:`bool` | :ref:`collide` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | +| :ref:`Variant` | :ref:`collide_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | +| :ref:`bool` | :ref:`collide_with_motion` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | +| :ref:`Variant` | :ref:`collide_with_motion_and_get_contacts` **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Shape2D_custom_solver_bias: - -- :ref:`float` **custom_solver_bias** - - Description ----------- @@ -49,12 +39,20 @@ Tutorials - :doc:`../tutorials/physics/physics_introduction` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Shape2D_custom_solver_bias: + +- :ref:`float` **custom_solver_bias** + + +Method Descriptions +------------------- .. _class_Shape2D_collide: -- :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +- :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return whether this shape is colliding with another. @@ -62,7 +60,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_and_get_contacts: -- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** +- :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** Return a list of the points where this shape touches another. If there are no collisions, the list is empty. @@ -70,7 +68,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion: -- :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`bool` **collide_with_motion** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return whether this shape would collide with another, if a given movement was applied. @@ -78,7 +76,7 @@ This method needs the transformation matrix for this shape (``local_xform``), th .. _class_Shape2D_collide_with_motion_and_get_contacts: -- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** +- :ref:`Variant` **collide_with_motion_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Vector2` local_motion, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` shape_motion **)** Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 904ff5d89..046e3e9f2 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -7,8 +7,7 @@ ShortCut ======== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,48 +15,48 @@ Brief Description A shortcut for binding input. -Member Functions ----------------- +Methods +------- +------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | +| :ref:`String` | :ref:`get_as_text` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | +| :ref:`bool` | :ref:`is_shortcut` **(** :ref:`InputEvent` event **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** **)** const | +------------------------------+------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_ShortCut_shortcut: - -- :ref:`InputEvent` **shortcut** - The Shortcut's :ref:`InputEvent`. - -Generally the :ref:`InputEvent` is a keyboard key, though it can be any :ref:`InputEvent`. - - Description ----------- A shortcut for binding input. -Shortcuts are commonly used for interacting with a :ref:`Control` element from a :ref:`InputEvent`. +Shortcuts are commonly used for interacting with a :ref:`Control` element from a :ref:`InputEvent`. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_ShortCut_shortcut: + +- :ref:`InputEvent` **shortcut** - The Shortcut's :ref:`InputEvent`. + +Generally the :ref:`InputEvent` is a keyboard key, though it can be any :ref:`InputEvent`. + + +Method Descriptions +------------------- .. _class_ShortCut_get_as_text: -- :ref:`String` **get_as_text** **(** **)** const +- :ref:`String` **get_as_text** **(** **)** const -Returns the Shortcut's :ref:`InputEvent` as a :ref:`String`. +Returns the Shortcut's :ref:`InputEvent` as a :ref:`String`. .. _class_ShortCut_is_shortcut: -- :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const +- :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const -Returns ``true`` if the Shortcut's :ref:`InputEvent` equals ``event``. +Returns ``true`` if the Shortcut's :ref:`InputEvent` equals ``event``. .. _class_ShortCut_is_valid: diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index 6624782e9..ffc264de9 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -7,8 +7,7 @@ Skeleton ======== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,91 +15,91 @@ Brief Description Skeleton for characters and animated objects. -Member Functions ----------------- +Methods +------- +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bone` **(** :ref:`String` name **)** | +| void | :ref:`add_bone` **(** :ref:`String` name **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | +| void | :ref:`bind_child_node_to_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_bones` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_bone` **(** :ref:`String` name **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_custom_pose` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_global_pose` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | +| :ref:`String` | :ref:`get_bone_name` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_parent` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_pose` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_rest` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_bone_transform` **(** :ref:`int` bone_idx **)** const | +| :ref:`Transform` | :ref:`get_bone_transform` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | +| :ref:`Array` | :ref:`get_bound_child_nodes_to_bone` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | +| void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | +| void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | +| void | :ref:`physical_bones_start_simulation` **(** :ref:`Array` bones=[ ] **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`physical_bones_stop_simulation` **(** **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | +| void | :ref:`set_bone_custom_pose` **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_disable_rest` **(** :ref:`int` bone_idx, :ref:`bool` disable **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | +| void | :ref:`set_bone_global_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_ignore_animation` **(** :ref:`int` bone, :ref:`bool` ignore **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_parent` **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | +| void | :ref:`set_bone_pose` **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | +| void | :ref:`set_bone_rest` **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | +| void | :ref:`unbind_child_node_from_bone` **(** :ref:`int` bone_idx, :ref:`Node` node **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unparent_bone_and_rest` **(** :ref:`int` bone_idx **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ +Constants +--------- - **NOTIFICATION_UPDATE_SKELETON** = **50** Description ----------- -Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation`). Skeleton will support rag doll dynamics in the future. +Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation`). Skeleton will support rag doll dynamics in the future. The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Skeleton_add_bone: -- void **add_bone** **(** :ref:`String` name **)** +- void **add_bone** **(** :ref:`String` name **)** Add a bone, with name "name". :ref:`get_bone_count` will become the bone index. .. _class_Skeleton_bind_child_node_to_bone: -- void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** +- void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. @@ -112,7 +111,7 @@ Clear all the bones in this skeleton. .. _class_Skeleton_find_bone: -- :ref:`int` **find_bone** **(** :ref:`String` name **)** const +- :ref:`int` **find_bone** **(** :ref:`String` name **)** const Return the bone index that matches "name" as its name. @@ -124,19 +123,19 @@ Return the amount of bones in the skeleton. .. _class_Skeleton_get_bone_custom_pose: -- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_custom_pose** **(** :ref:`int` bone_idx **)** const Return the custom pose of the specified bone. Custom pose is applied on top of the rest pose. .. _class_Skeleton_get_bone_global_pose: -- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_global_pose** **(** :ref:`int` bone_idx **)** const Return the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. .. _class_Skeleton_get_bone_name: -- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const +- :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const Return the name of the bone at index "index". @@ -148,25 +147,25 @@ Return the bone index which is the parent of the bone at "bone_idx". If -1, then .. _class_Skeleton_get_bone_pose: -- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_pose** **(** :ref:`int` bone_idx **)** const Return the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. .. _class_Skeleton_get_bone_rest: -- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const Return the rest transform for a bone "bone_idx". .. _class_Skeleton_get_bone_transform: -- :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const +- :ref:`Transform` **get_bone_transform** **(** :ref:`int` bone_idx **)** const Return the combination of custom pose and pose. The returned transform is in skeleton's reference frame. .. _class_Skeleton_get_bound_child_nodes_to_bone: -- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const +- :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const Deprecated soon. @@ -176,15 +175,15 @@ Deprecated soon. .. _class_Skeleton_physical_bones_add_collision_exception: -- void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** +- void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** .. _class_Skeleton_physical_bones_remove_collision_exception: -- void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** +- void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** .. _class_Skeleton_physical_bones_start_simulation: -- void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** +- void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** .. _class_Skeleton_physical_bones_stop_simulation: @@ -192,7 +191,7 @@ Deprecated soon. .. _class_Skeleton_set_bone_custom_pose: -- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** +- void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** .. _class_Skeleton_set_bone_disable_rest: @@ -200,7 +199,7 @@ Deprecated soon. .. _class_Skeleton_set_bone_global_pose: -- void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +- void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** .. _class_Skeleton_set_bone_ignore_animation: @@ -214,19 +213,19 @@ Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, .. _class_Skeleton_set_bone_pose: -- void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** +- void **set_bone_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** Return the pose transform for bone "bone_idx". .. _class_Skeleton_set_bone_rest: -- void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** +- void **set_bone_rest** **(** :ref:`int` bone_idx, :ref:`Transform` rest **)** Set the rest transform for bone "bone_idx" .. _class_Skeleton_unbind_child_node_from_bone: -- void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** +- void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index 0431c1f15..f31193764 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -7,8 +7,7 @@ Skeleton2D ========== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+----------------------------------------------------------------------------------+ -| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | +| :ref:`Bone2D` | :ref:`get_bone` **(** :ref:`int` idx **)** | +------------------------------+----------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | +| :ref:`RID` | :ref:`get_skeleton` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Skeleton2D_get_bone: -- :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** +- :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** .. _class_Skeleton2D_get_bone_count: @@ -40,6 +39,6 @@ Member Function Description .. _class_Skeleton2D_get_skeleton: -- :ref:`RID` **get_skeleton** **(** **)** const +- :ref:`RID` **get_skeleton** **(** **)** const diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 4493acf3c..0bc1d49b2 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -7,8 +7,7 @@ SkeletonIK ========== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | +| :ref:`Skeleton` | :ref:`get_parent_skeleton` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_running` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------+ @@ -29,8 +28,8 @@ Member Functions | void | :ref:`stop` **(** **)** | +----------------------------------+-----------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_SkeletonIK_interpolation: @@ -38,7 +37,7 @@ Member Variables .. _class_SkeletonIK_magnet: -- :ref:`Vector3` **magnet** +- :ref:`Vector3` **magnet** .. _class_SkeletonIK_max_iterations: @@ -50,31 +49,31 @@ Member Variables .. _class_SkeletonIK_root_bone: -- :ref:`String` **root_bone** +- :ref:`String` **root_bone** .. _class_SkeletonIK_target: -- :ref:`Transform` **target** +- :ref:`Transform` **target** .. _class_SkeletonIK_target_node: -- :ref:`NodePath` **target_node** +- :ref:`NodePath` **target_node** .. _class_SkeletonIK_tip_bone: -- :ref:`String` **tip_bone** +- :ref:`String` **tip_bone** .. _class_SkeletonIK_use_magnet: - :ref:`bool` **use_magnet** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SkeletonIK_get_parent_skeleton: -- :ref:`Skeleton` **get_parent_skeleton** **(** **)** const +- :ref:`Skeleton` **get_parent_skeleton** **(** **)** const .. _class_SkeletonIK_is_running: diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 212bb0f99..32d93ebcd 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -7,31 +7,17 @@ Sky === -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`PanoramaSky`, :ref:`ProceduralSky` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`PanoramaSky`, :ref:`ProceduralSky` **Category:** Core Brief Description ----------------- -The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky`. +The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky`. -Member Variables ----------------- - - .. _class_Sky_radiance_size: - -- :ref:`RadianceSize` **radiance_size** - The Sky's radiance map size. - -The higher the radiance map size, the more detailed the lighting from the Sky will be. - -See RADIANCE_SIZE\_\* constants for values. Default size is RADIANCE_SIZE_512. - - -Enums ------ +Enumerations +------------ .. _enum_Sky_RadianceSize: @@ -50,5 +36,17 @@ enum **RadianceSize** Description ----------- -The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky`. +The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky`. + +Property Descriptions +--------------------- + + .. _class_Sky_radiance_size: + +- :ref:`RadianceSize` **radiance_size** - The Sky's radiance map size. + +The higher the radiance map size, the more detailed the lighting from the Sky will be. + +See RADIANCE_SIZE\_\* constants for values. Default size is RADIANCE_SIZE_512. + diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 59e626e98..b7b644461 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -7,10 +7,8 @@ Slider ====== -**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`HSlider`, :ref:`VSlider` - +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`HSlider`, :ref:`VSlider` **Category:** Core Brief Description @@ -18,8 +16,13 @@ Brief Description Base class for GUI Sliders. -Member Variables ----------------- +Description +----------- + +Base class for GUI Sliders. + +Property Descriptions +--------------------- .. _class_Slider_editable: @@ -27,7 +30,7 @@ Member Variables .. _class_Slider_focus_mode: -- :ref:`FocusMode` **focus_mode** +- :ref:`FocusMode` **focus_mode** .. _class_Slider_scrollable: @@ -42,8 +45,3 @@ Member Variables - :ref:`bool` **ticks_on_borders** -Description ------------ - -Base class for GUI Sliders. - diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 7f67de0f5..85050baeb 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -7,8 +7,7 @@ SliderJoint =========== -**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,45 @@ Brief Description Piston kind of slider between two bodies in 3D. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_SliderJoint_Param: + +enum **Param** + +- **PARAM_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. +- **PARAM_LINEAR_LIMIT_LOWER** = **1** --- The minimum difference between the pivot points on their x-axis before damping happens. +- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. +- **PARAM_LINEAR_LIMIT_RESTITUTION** = **3** --- The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. +- **PARAM_LINEAR_LIMIT_DAMPING** = **4** --- The amount of damping once the slider limits are surpassed. +- **PARAM_LINEAR_MOTION_SOFTNESS** = **5** --- A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. +- **PARAM_LINEAR_MOTION_RESTITUTION** = **6** --- The amount of restitution inside the slider limits. +- **PARAM_LINEAR_MOTION_DAMPING** = **7** --- The amount of damping inside the slider limits. +- **PARAM_LINEAR_ORTHOGONAL_SOFTNESS** = **8** --- A factor applied to the movement across axes orthogonal to the slider. +- **PARAM_LINEAR_ORTHOGONAL_RESTITUTION** = **9** --- The amount of restitution when movement is across axes orthogonal to the slider. +- **PARAM_LINEAR_ORTHOGONAL_DAMPING** = **10** --- The amount of damping when movement is across axes orthogonal to the slider. +- **PARAM_ANGULAR_LIMIT_UPPER** = **11** --- The upper limit of rotation in the slider. +- **PARAM_ANGULAR_LIMIT_LOWER** = **12** --- The lower limit of rotation in the slider. +- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **13** --- A factor applied to the all rotation once the limit is surpassed. +- **PARAM_ANGULAR_LIMIT_RESTITUTION** = **14** --- The amount of restitution of the rotation when the limit is surpassed. +- **PARAM_ANGULAR_LIMIT_DAMPING** = **15** --- The amount of damping of the rotation when the limit is surpassed. +- **PARAM_ANGULAR_MOTION_SOFTNESS** = **16** --- A factor applied to the all rotation in the limits. +- **PARAM_ANGULAR_MOTION_RESTITUTION** = **17** --- The amount of restitution of the rotation in the limits. +- **PARAM_ANGULAR_MOTION_DAMPING** = **18** --- The amount of damping of the rotation in the limits. +- **PARAM_ANGULAR_ORTHOGONAL_SOFTNESS** = **19** --- A factor applied to the all rotation across axes orthogonal to the slider. +- **PARAM_ANGULAR_ORTHOGONAL_RESTITUTION** = **20** --- The amount of restitution of the rotation across axes orthogonal to the slider. +- **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = **21** --- The amount of damping of the rotation across axes orthogonal to the slider. +- **PARAM_MAX** = **22** --- End flag of PARAM\_\* constants, used internally. + + +Description +----------- + +Slides across the x-axis of the Pivot object. + +Property Descriptions +--------------------- .. _class_SliderJoint_angular_limit/damping: @@ -114,40 +150,3 @@ Makes all rotation slower when between 0 and 1. - :ref:`float` **linear_ortho/softness** - A factor applied to the movement across axes orthogonal to the slider. -Enums ------ - - .. _enum_SliderJoint_Param: - -enum **Param** - -- **PARAM_LINEAR_LIMIT_UPPER** = **0** --- The maximum difference between the pivot points on their x-axis before damping happens. -- **PARAM_LINEAR_LIMIT_LOWER** = **1** --- The minimum difference between the pivot points on their x-axis before damping happens. -- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. -- **PARAM_LINEAR_LIMIT_RESTITUTION** = **3** --- The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. -- **PARAM_LINEAR_LIMIT_DAMPING** = **4** --- The amount of damping once the slider limits are surpassed. -- **PARAM_LINEAR_MOTION_SOFTNESS** = **5** --- A factor applied to the movement across the slider axis as long as the slider is in the limits. The lower, the slower the movement. -- **PARAM_LINEAR_MOTION_RESTITUTION** = **6** --- The amount of restitution inside the slider limits. -- **PARAM_LINEAR_MOTION_DAMPING** = **7** --- The amount of damping inside the slider limits. -- **PARAM_LINEAR_ORTHOGONAL_SOFTNESS** = **8** --- A factor applied to the movement across axes orthogonal to the slider. -- **PARAM_LINEAR_ORTHOGONAL_RESTITUTION** = **9** --- The amount of restitution when movement is across axes orthogonal to the slider. -- **PARAM_LINEAR_ORTHOGONAL_DAMPING** = **10** --- The amount of damping when movement is across axes orthogonal to the slider. -- **PARAM_ANGULAR_LIMIT_UPPER** = **11** --- The upper limit of rotation in the slider. -- **PARAM_ANGULAR_LIMIT_LOWER** = **12** --- The lower limit of rotation in the slider. -- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **13** --- A factor applied to the all rotation once the limit is surpassed. -- **PARAM_ANGULAR_LIMIT_RESTITUTION** = **14** --- The amount of restitution of the rotation when the limit is surpassed. -- **PARAM_ANGULAR_LIMIT_DAMPING** = **15** --- The amount of damping of the rotation when the limit is surpassed. -- **PARAM_ANGULAR_MOTION_SOFTNESS** = **16** --- A factor applied to the all rotation in the limits. -- **PARAM_ANGULAR_MOTION_RESTITUTION** = **17** --- The amount of restitution of the rotation in the limits. -- **PARAM_ANGULAR_MOTION_DAMPING** = **18** --- The amount of damping of the rotation in the limits. -- **PARAM_ANGULAR_ORTHOGONAL_SOFTNESS** = **19** --- A factor applied to the all rotation across axes orthogonal to the slider. -- **PARAM_ANGULAR_ORTHOGONAL_RESTITUTION** = **20** --- The amount of restitution of the rotation across axes orthogonal to the slider. -- **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = **21** --- The amount of damping of the rotation across axes orthogonal to the slider. -- **PARAM_MAX** = **22** --- End flag of PARAM\_\* constants, used internally. - - -Description ------------ - -Slides across the x-axis of the Pivot object. - diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index 6b4479d2d..85304efda 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -7,8 +7,7 @@ SoftBody ======== -**Inherits:** :ref:`MeshInstance` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`MeshInstance` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -28,7 +27,7 @@ Member Functions +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +| void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,8 +36,8 @@ Member Functions | void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_SoftBody_areaAngular_stiffness: @@ -66,7 +65,7 @@ Member Variables .. _class_SoftBody_parent_collision_ignore: -- :ref:`NodePath` **parent_collision_ignore** +- :ref:`NodePath` **parent_collision_ignore** .. _class_SoftBody_pose_matching_coefficient: @@ -89,12 +88,12 @@ Member Variables - :ref:`float` **volume_stiffness** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SoftBody_add_collision_exception_with: -- void **add_collision_exception_with** **(** :ref:`Node` body **)** +- void **add_collision_exception_with** **(** :ref:`Node` body **)** .. _class_SoftBody_get_collision_layer_bit: @@ -110,7 +109,7 @@ Member Function Description .. _class_SoftBody_remove_collision_exception_with: -- void **remove_collision_exception_with** **(** :ref:`Node` body **)** +- void **remove_collision_exception_with** **(** :ref:`Node` body **)** .. _class_SoftBody_set_collision_layer_bit: diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index f1e934a8e..68fd1f812 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -7,10 +7,8 @@ Spatial ======= -**Inherits:** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpringArm`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` - +**Inherits:** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`SpringArm`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`OrientedPathFollow`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` **Category:** Core Brief Description @@ -18,19 +16,21 @@ Brief Description Most basic 3D game object, parent of all 3D related nodes. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | +| void | :ref:`force_update_transform` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +| :ref:`World` | :ref:`get_world` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_scale` **(** :ref:`Vector3` scale **)** | +| void | :ref:`global_rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | +| void | :ref:`global_scale` **(** :ref:`Vector3` scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`hide` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,15 +44,15 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | +| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`orthonormalize` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +| void | :ref:`rotate` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_object_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +| void | :ref:`rotate_object_local` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate_x` **(** :ref:`float` angle **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -60,7 +60,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate_z` **(** :ref:`float` angle **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scale_object_local` **(** :ref:`Vector3` scale **)** | +| void | :ref:`scale_object_local` **(** :ref:`Vector3` scale **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,13 +76,13 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | +| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate_object_local` **(** :ref:`Vector3` offset **)** | +| void | :ref:`translate_object_local` **(** :ref:`Vector3` offset **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_gizmo` **(** **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -97,58 +97,20 @@ Signals Emitted when node visibility changes. -Member Variables ----------------- - - .. _class_Spatial_gizmo: - -- :ref:`SpatialGizmo` **gizmo** - The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. - - .. _class_Spatial_global_transform: - -- :ref:`Transform` **global_transform** - World space (global) :ref:`Transform` of this node. - - .. _class_Spatial_rotation: - -- :ref:`Vector3` **rotation** - Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in radians. - -Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. - - .. _class_Spatial_rotation_degrees: - -- :ref:`Vector3` **rotation_degrees** - Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in degrees. - - .. _class_Spatial_scale: - -- :ref:`Vector3` **scale** - Scale part of the local transformation. - - .. _class_Spatial_transform: - -- :ref:`Transform` **transform** - Local space :ref:`Transform` of this node, with respect to the parent node. - - .. _class_Spatial_translation: - -- :ref:`Vector3` **translation** - Local translation of this node. - - .. _class_Spatial_visible: - -- :ref:`bool` **visible** - Visibility of this node. Toggles if this node is rendered. - - -Numeric Constants ------------------ +Constants +--------- - **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). -- **NOTIFICATION_ENTER_WORLD** = **41** --- Spatial nodes receives this notification when they are registered to new :ref:`World` resource. -- **NOTIFICATION_EXIT_WORLD** = **42** --- Spatial nodes receives this notification when they are unregistered from current :ref:`World` resource. +- **NOTIFICATION_ENTER_WORLD** = **41** --- Spatial nodes receives this notification when they are registered to new :ref:`World` resource. +- **NOTIFICATION_EXIT_WORLD** = **42** --- Spatial nodes receives this notification when they are unregistered from current :ref:`World` resource. - **NOTIFICATION_VISIBILITY_CHANGED** = **43** --- Spatial nodes receives this notification when their visibility changes. Description ----------- -Most basic 3D game object, with a 3D :ref:`Transform` and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. +Most basic 3D game object, with a 3D :ref:`Transform` and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the Spatial object is set as top level. Affine operations in this coordinate system correspond to direct affine operations on the Spatial's transform. The word local below refers to this coordinate system. The coordinate system that is attached to the Spatial object itself is referred to as object-local coordinate system. @@ -157,36 +119,78 @@ Tutorials - :doc:`../tutorials/3d/introduction_to_3d` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Spatial_gizmo: + +- :ref:`SpatialGizmo` **gizmo** - The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. + + .. _class_Spatial_global_transform: + +- :ref:`Transform` **global_transform** - World space (global) :ref:`Transform` of this node. + + .. _class_Spatial_rotation: + +- :ref:`Vector3` **rotation** - Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). + +Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. + + .. _class_Spatial_rotation_degrees: + +- :ref:`Vector3` **rotation_degrees** - Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). + + .. _class_Spatial_scale: + +- :ref:`Vector3` **scale** - Scale part of the local transformation. + + .. _class_Spatial_transform: + +- :ref:`Transform` **transform** - Local space :ref:`Transform` of this node, with respect to the parent node. + + .. _class_Spatial_translation: + +- :ref:`Vector3` **translation** - Local translation of this node. + + .. _class_Spatial_visible: + +- :ref:`bool` **visible** - If ``true`` this node is drawn. Default value: ``true``. + + +Method Descriptions +------------------- + +.. _class_Spatial_force_update_transform: + +- void **force_update_transform** **(** **)** .. _class_Spatial_get_parent_spatial: -- :ref:`Spatial` **get_parent_spatial** **(** **)** const +- :ref:`Spatial` **get_parent_spatial** **(** **)** const -Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. +Returns the parent ``Spatial``, or an empty :ref:`Object` if no parent exists or parent is not of type ``Spatial``. .. _class_Spatial_get_world: -- :ref:`World` **get_world** **(** **)** const +- :ref:`World` **get_world** **(** **)** const -Returns the current :ref:`World` resource this Spatial node is registered to. +Returns the current :ref:`World` resource this Spatial node is registered to. .. _class_Spatial_global_rotate: -- void **global_rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- void **global_rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** -Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. +Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. .. _class_Spatial_global_scale: -- void **global_scale** **(** :ref:`Vector3` scale **)** +- void **global_scale** **(** :ref:`Vector3` scale **)** .. _class_Spatial_global_translate: -- void **global_translate** **(** :ref:`Vector3` offset **)** +- void **global_translate** **(** :ref:`Vector3` offset **)** -Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. +Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. .. _class_Spatial_hide: @@ -224,7 +228,7 @@ Returns whether the node is visible, taking into consideration that its parents .. _class_Spatial_look_at: -- void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** +- void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** Rotates itself so that the local -Z axis points towards the ``target`` position. @@ -234,7 +238,7 @@ Operations take place in global space. .. _class_Spatial_look_at_from_position: -- void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** +- void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** Moves the node to the specified ``position``, and then rotates itself to point toward the ``target`` as per :ref:`look_at`. Operations take place in global space. @@ -246,15 +250,15 @@ Resets this node's transformations (like scale, skew and taper) preserving its r .. _class_Spatial_rotate: -- void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** -Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. +Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. .. _class_Spatial_rotate_object_local: -- void **rotate_object_local** **(** :ref:`Vector3` axis, :ref:`float` angle **)** +- void **rotate_object_local** **(** :ref:`Vector3` axis, :ref:`float` angle **)** -Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. +Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. .. _class_Spatial_rotate_x: @@ -276,7 +280,7 @@ Rotates the local transformation around the Z axis by angle in radians. .. _class_Spatial_scale_object_local: -- void **scale_object_local** **(** :ref:`Vector3` scale **)** +- void **scale_object_local** **(** :ref:`Vector3` scale **)** Scales the local transformation by given 3D scale factors in object-local coordinate system. @@ -322,30 +326,30 @@ Enables rendering of this node. Change Spatial Visible property to "True". .. _class_Spatial_to_global: -- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const +- :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const -Transforms :ref:`Vector3` "local_point" from this node's local space to world space. +Transforms :ref:`Vector3` "local_point" from this node's local space to world space. .. _class_Spatial_to_local: -- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const +- :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const -Transforms :ref:`Vector3` "global_point" from world space to this node's local space. +Transforms :ref:`Vector3` "global_point" from world space to this node's local space. .. _class_Spatial_translate: -- void **translate** **(** :ref:`Vector3` offset **)** +- void **translate** **(** :ref:`Vector3` offset **)** -Changes the node's position by given offset :ref:`Vector3`. +Changes the node's position by given offset :ref:`Vector3`. .. _class_Spatial_translate_object_local: -- void **translate_object_local** **(** :ref:`Vector3` offset **)** +- void **translate_object_local** **(** :ref:`Vector3` offset **)** .. _class_Spatial_update_gizmo: - void **update_gizmo** **(** **)** -Updates the :ref:`SpatialGizmo` of this node. +Updates the :ref:`SpatialGizmo` of this node. diff --git a/classes/class_spatialgizmo.rst b/classes/class_spatialgizmo.rst index 64470508a..eb56cc279 100644 --- a/classes/class_spatialgizmo.rst +++ b/classes/class_spatialgizmo.rst @@ -7,10 +7,8 @@ SpatialGizmo ============ -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`EditorSpatialGizmo` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`EditorSpatialGizmo` **Category:** Core Brief Description diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 51c9835ac..366c4595c 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -7,8 +7,7 @@ SpatialMaterial =============== -**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,404 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_SpatialMaterial_albedo_color: - -- :ref:`Color` **albedo_color** - - .. _class_SpatialMaterial_albedo_texture: - -- :ref:`Texture` **albedo_texture** - - .. _class_SpatialMaterial_anisotropy: - -- :ref:`float` **anisotropy** - - .. _class_SpatialMaterial_anisotropy_enabled: - -- :ref:`bool` **anisotropy_enabled** - - .. _class_SpatialMaterial_anisotropy_flowmap: - -- :ref:`Texture` **anisotropy_flowmap** - - .. _class_SpatialMaterial_ao_enabled: - -- :ref:`bool` **ao_enabled** - - .. _class_SpatialMaterial_ao_light_affect: - -- :ref:`float` **ao_light_affect** - - .. _class_SpatialMaterial_ao_on_uv2: - -- :ref:`bool` **ao_on_uv2** - - .. _class_SpatialMaterial_ao_texture: - -- :ref:`Texture` **ao_texture** - - .. _class_SpatialMaterial_ao_texture_channel: - -- :ref:`TextureChannel` **ao_texture_channel** - - .. _class_SpatialMaterial_clearcoat: - -- :ref:`float` **clearcoat** - - .. _class_SpatialMaterial_clearcoat_enabled: - -- :ref:`bool` **clearcoat_enabled** - - .. _class_SpatialMaterial_clearcoat_gloss: - -- :ref:`float` **clearcoat_gloss** - - .. _class_SpatialMaterial_clearcoat_texture: - -- :ref:`Texture` **clearcoat_texture** - - .. _class_SpatialMaterial_depth_deep_parallax: - -- :ref:`bool` **depth_deep_parallax** - - .. _class_SpatialMaterial_depth_enabled: - -- :ref:`bool` **depth_enabled** - - .. _class_SpatialMaterial_depth_max_layers: - -- :ref:`int` **depth_max_layers** - - .. _class_SpatialMaterial_depth_min_layers: - -- :ref:`int` **depth_min_layers** - - .. _class_SpatialMaterial_depth_scale: - -- :ref:`float` **depth_scale** - - .. _class_SpatialMaterial_depth_texture: - -- :ref:`Texture` **depth_texture** - - .. _class_SpatialMaterial_detail_albedo: - -- :ref:`Texture` **detail_albedo** - - .. _class_SpatialMaterial_detail_blend_mode: - -- :ref:`BlendMode` **detail_blend_mode** - - .. _class_SpatialMaterial_detail_enabled: - -- :ref:`bool` **detail_enabled** - - .. _class_SpatialMaterial_detail_mask: - -- :ref:`Texture` **detail_mask** - - .. _class_SpatialMaterial_detail_normal: - -- :ref:`Texture` **detail_normal** - - .. _class_SpatialMaterial_detail_uv_layer: - -- :ref:`DetailUV` **detail_uv_layer** - - .. _class_SpatialMaterial_distance_fade_enable: - -- :ref:`bool` **distance_fade_enable** - - .. _class_SpatialMaterial_distance_fade_max_distance: - -- :ref:`float` **distance_fade_max_distance** - - .. _class_SpatialMaterial_distance_fade_min_distance: - -- :ref:`float` **distance_fade_min_distance** - - .. _class_SpatialMaterial_emission: - -- :ref:`Color` **emission** - - .. _class_SpatialMaterial_emission_enabled: - -- :ref:`bool` **emission_enabled** - - .. _class_SpatialMaterial_emission_energy: - -- :ref:`float` **emission_energy** - - .. _class_SpatialMaterial_emission_on_uv2: - -- :ref:`bool` **emission_on_uv2** - - .. _class_SpatialMaterial_emission_operator: - -- :ref:`EmissionOperator` **emission_operator** - - .. _class_SpatialMaterial_emission_texture: - -- :ref:`Texture` **emission_texture** - - .. _class_SpatialMaterial_flags_albedo_tex_force_srgb: - -- :ref:`bool` **flags_albedo_tex_force_srgb** - - .. _class_SpatialMaterial_flags_disable_ambient_light: - -- :ref:`bool` **flags_disable_ambient_light** - - .. _class_SpatialMaterial_flags_do_not_receive_shadows: - -- :ref:`bool` **flags_do_not_receive_shadows** - - .. _class_SpatialMaterial_flags_ensure_correct_normals: - -- :ref:`bool` **flags_ensure_correct_normals** - - .. _class_SpatialMaterial_flags_fixed_size: - -- :ref:`bool` **flags_fixed_size** - - .. _class_SpatialMaterial_flags_no_depth_test: - -- :ref:`bool` **flags_no_depth_test** - - .. _class_SpatialMaterial_flags_transparent: - -- :ref:`bool` **flags_transparent** - - .. _class_SpatialMaterial_flags_unshaded: - -- :ref:`bool` **flags_unshaded** - - .. _class_SpatialMaterial_flags_use_point_size: - -- :ref:`bool` **flags_use_point_size** - - .. _class_SpatialMaterial_flags_vertex_lighting: - -- :ref:`bool` **flags_vertex_lighting** - - .. _class_SpatialMaterial_flags_world_triplanar: - -- :ref:`bool` **flags_world_triplanar** - - .. _class_SpatialMaterial_metallic: - -- :ref:`float` **metallic** - - .. _class_SpatialMaterial_metallic_specular: - -- :ref:`float` **metallic_specular** - - .. _class_SpatialMaterial_metallic_texture: - -- :ref:`Texture` **metallic_texture** - - .. _class_SpatialMaterial_metallic_texture_channel: - -- :ref:`TextureChannel` **metallic_texture_channel** - - .. _class_SpatialMaterial_normal_enabled: - -- :ref:`bool` **normal_enabled** - - .. _class_SpatialMaterial_normal_scale: - -- :ref:`float` **normal_scale** - - .. _class_SpatialMaterial_normal_texture: - -- :ref:`Texture` **normal_texture** - - .. _class_SpatialMaterial_params_alpha_scissor_threshold: - -- :ref:`float` **params_alpha_scissor_threshold** - - .. _class_SpatialMaterial_params_billboard_keep_scale: - -- :ref:`bool` **params_billboard_keep_scale** - - .. _class_SpatialMaterial_params_billboard_mode: - -- :ref:`BillboardMode` **params_billboard_mode** - - .. _class_SpatialMaterial_params_blend_mode: - -- :ref:`BlendMode` **params_blend_mode** - - .. _class_SpatialMaterial_params_cull_mode: - -- :ref:`CullMode` **params_cull_mode** - - .. _class_SpatialMaterial_params_depth_draw_mode: - -- :ref:`DepthDrawMode` **params_depth_draw_mode** - - .. _class_SpatialMaterial_params_diffuse_mode: - -- :ref:`DiffuseMode` **params_diffuse_mode** - - .. _class_SpatialMaterial_params_grow: - -- :ref:`bool` **params_grow** - - .. _class_SpatialMaterial_params_grow_amount: - -- :ref:`float` **params_grow_amount** - - .. _class_SpatialMaterial_params_line_width: - -- :ref:`float` **params_line_width** - - .. _class_SpatialMaterial_params_point_size: - -- :ref:`float` **params_point_size** - - .. _class_SpatialMaterial_params_specular_mode: - -- :ref:`SpecularMode` **params_specular_mode** - - .. _class_SpatialMaterial_params_use_alpha_scissor: - -- :ref:`bool` **params_use_alpha_scissor** - - .. _class_SpatialMaterial_particles_anim_h_frames: - -- :ref:`int` **particles_anim_h_frames** - - .. _class_SpatialMaterial_particles_anim_loop: - -- :ref:`int` **particles_anim_loop** - - .. _class_SpatialMaterial_particles_anim_v_frames: - -- :ref:`int` **particles_anim_v_frames** - - .. _class_SpatialMaterial_proximity_fade_distance: - -- :ref:`float` **proximity_fade_distance** - - .. _class_SpatialMaterial_proximity_fade_enable: - -- :ref:`bool` **proximity_fade_enable** - - .. _class_SpatialMaterial_refraction_enabled: - -- :ref:`bool` **refraction_enabled** - - .. _class_SpatialMaterial_refraction_scale: - -- :ref:`float` **refraction_scale** - - .. _class_SpatialMaterial_refraction_texture: - -- :ref:`Texture` **refraction_texture** - - .. _class_SpatialMaterial_refraction_texture_channel: - -- :ref:`TextureChannel` **refraction_texture_channel** - - .. _class_SpatialMaterial_rim: - -- :ref:`float` **rim** - - .. _class_SpatialMaterial_rim_enabled: - -- :ref:`bool` **rim_enabled** - - .. _class_SpatialMaterial_rim_texture: - -- :ref:`Texture` **rim_texture** - - .. _class_SpatialMaterial_rim_tint: - -- :ref:`float` **rim_tint** - - .. _class_SpatialMaterial_roughness: - -- :ref:`float` **roughness** - - .. _class_SpatialMaterial_roughness_texture: - -- :ref:`Texture` **roughness_texture** - - .. _class_SpatialMaterial_roughness_texture_channel: - -- :ref:`TextureChannel` **roughness_texture_channel** - - .. _class_SpatialMaterial_subsurf_scatter_enabled: - -- :ref:`bool` **subsurf_scatter_enabled** - - .. _class_SpatialMaterial_subsurf_scatter_strength: - -- :ref:`float` **subsurf_scatter_strength** - - .. _class_SpatialMaterial_subsurf_scatter_texture: - -- :ref:`Texture` **subsurf_scatter_texture** - - .. _class_SpatialMaterial_transmission: - -- :ref:`Color` **transmission** - - .. _class_SpatialMaterial_transmission_enabled: - -- :ref:`bool` **transmission_enabled** - - .. _class_SpatialMaterial_transmission_texture: - -- :ref:`Texture` **transmission_texture** - - .. _class_SpatialMaterial_uv1_offset: - -- :ref:`Vector3` **uv1_offset** - - .. _class_SpatialMaterial_uv1_scale: - -- :ref:`Vector3` **uv1_scale** - - .. _class_SpatialMaterial_uv1_triplanar: - -- :ref:`bool` **uv1_triplanar** - - .. _class_SpatialMaterial_uv1_triplanar_sharpness: - -- :ref:`float` **uv1_triplanar_sharpness** - - .. _class_SpatialMaterial_uv2_offset: - -- :ref:`Vector3` **uv2_offset** - - .. _class_SpatialMaterial_uv2_scale: - -- :ref:`Vector3` **uv2_scale** - - .. _class_SpatialMaterial_uv2_triplanar: - -- :ref:`bool` **uv2_triplanar** - - .. _class_SpatialMaterial_uv2_triplanar_sharpness: - -- :ref:`float` **uv2_triplanar_sharpness** - - .. _class_SpatialMaterial_vertex_color_is_srgb: - -- :ref:`bool` **vertex_color_is_srgb** - - .. _class_SpatialMaterial_vertex_color_use_as_albedo: - -- :ref:`bool` **vertex_color_use_as_albedo** - - -Enums ------ +Enumerations +------------ .. _enum_SpatialMaterial_DetailUV: @@ -444,6 +47,15 @@ enum **TextureParam** - **TEXTURE_DETAIL_NORMAL** = **15** - **TEXTURE_MAX** = **16** + .. _enum_SpatialMaterial_DistanceFadeMode: + +enum **DistanceFadeMode** + +- **DISTANCE_FADE_DISABLED** = **0** +- **DISTANCE_FADE_PIXEL_ALPHA** = **1** +- **DISTANCE_FADE_PIXEL_DITHER** = **2** +- **DISTANCE_FADE_OBJECT_DITHER** = **3** + .. _enum_SpatialMaterial_DepthDrawMode: enum **DepthDrawMode** @@ -564,3 +176,399 @@ Tutorials - :doc:`../tutorials/3d/spatial_material` +Property Descriptions +--------------------- + + .. _class_SpatialMaterial_albedo_color: + +- :ref:`Color` **albedo_color** + + .. _class_SpatialMaterial_albedo_texture: + +- :ref:`Texture` **albedo_texture** + + .. _class_SpatialMaterial_anisotropy: + +- :ref:`float` **anisotropy** + + .. _class_SpatialMaterial_anisotropy_enabled: + +- :ref:`bool` **anisotropy_enabled** + + .. _class_SpatialMaterial_anisotropy_flowmap: + +- :ref:`Texture` **anisotropy_flowmap** + + .. _class_SpatialMaterial_ao_enabled: + +- :ref:`bool` **ao_enabled** + + .. _class_SpatialMaterial_ao_light_affect: + +- :ref:`float` **ao_light_affect** + + .. _class_SpatialMaterial_ao_on_uv2: + +- :ref:`bool` **ao_on_uv2** + + .. _class_SpatialMaterial_ao_texture: + +- :ref:`Texture` **ao_texture** + + .. _class_SpatialMaterial_ao_texture_channel: + +- :ref:`TextureChannel` **ao_texture_channel** + + .. _class_SpatialMaterial_clearcoat: + +- :ref:`float` **clearcoat** + + .. _class_SpatialMaterial_clearcoat_enabled: + +- :ref:`bool` **clearcoat_enabled** + + .. _class_SpatialMaterial_clearcoat_gloss: + +- :ref:`float` **clearcoat_gloss** + + .. _class_SpatialMaterial_clearcoat_texture: + +- :ref:`Texture` **clearcoat_texture** + + .. _class_SpatialMaterial_depth_deep_parallax: + +- :ref:`bool` **depth_deep_parallax** + + .. _class_SpatialMaterial_depth_enabled: + +- :ref:`bool` **depth_enabled** + + .. _class_SpatialMaterial_depth_max_layers: + +- :ref:`int` **depth_max_layers** + + .. _class_SpatialMaterial_depth_min_layers: + +- :ref:`int` **depth_min_layers** + + .. _class_SpatialMaterial_depth_scale: + +- :ref:`float` **depth_scale** + + .. _class_SpatialMaterial_depth_texture: + +- :ref:`Texture` **depth_texture** + + .. _class_SpatialMaterial_detail_albedo: + +- :ref:`Texture` **detail_albedo** + + .. _class_SpatialMaterial_detail_blend_mode: + +- :ref:`BlendMode` **detail_blend_mode** + + .. _class_SpatialMaterial_detail_enabled: + +- :ref:`bool` **detail_enabled** + + .. _class_SpatialMaterial_detail_mask: + +- :ref:`Texture` **detail_mask** + + .. _class_SpatialMaterial_detail_normal: + +- :ref:`Texture` **detail_normal** + + .. _class_SpatialMaterial_detail_uv_layer: + +- :ref:`DetailUV` **detail_uv_layer** + + .. _class_SpatialMaterial_distance_fade_max_distance: + +- :ref:`float` **distance_fade_max_distance** + + .. _class_SpatialMaterial_distance_fade_min_distance: + +- :ref:`float` **distance_fade_min_distance** + + .. _class_SpatialMaterial_distance_fade_mode: + +- :ref:`DistanceFadeMode` **distance_fade_mode** + + .. _class_SpatialMaterial_emission: + +- :ref:`Color` **emission** + + .. _class_SpatialMaterial_emission_enabled: + +- :ref:`bool` **emission_enabled** + + .. _class_SpatialMaterial_emission_energy: + +- :ref:`float` **emission_energy** + + .. _class_SpatialMaterial_emission_on_uv2: + +- :ref:`bool` **emission_on_uv2** + + .. _class_SpatialMaterial_emission_operator: + +- :ref:`EmissionOperator` **emission_operator** + + .. _class_SpatialMaterial_emission_texture: + +- :ref:`Texture` **emission_texture** + + .. _class_SpatialMaterial_flags_albedo_tex_force_srgb: + +- :ref:`bool` **flags_albedo_tex_force_srgb** + + .. _class_SpatialMaterial_flags_disable_ambient_light: + +- :ref:`bool` **flags_disable_ambient_light** + + .. _class_SpatialMaterial_flags_do_not_receive_shadows: + +- :ref:`bool` **flags_do_not_receive_shadows** + + .. _class_SpatialMaterial_flags_ensure_correct_normals: + +- :ref:`bool` **flags_ensure_correct_normals** + + .. _class_SpatialMaterial_flags_fixed_size: + +- :ref:`bool` **flags_fixed_size** + + .. _class_SpatialMaterial_flags_no_depth_test: + +- :ref:`bool` **flags_no_depth_test** + + .. _class_SpatialMaterial_flags_transparent: + +- :ref:`bool` **flags_transparent** + + .. _class_SpatialMaterial_flags_unshaded: + +- :ref:`bool` **flags_unshaded** + + .. _class_SpatialMaterial_flags_use_point_size: + +- :ref:`bool` **flags_use_point_size** + + .. _class_SpatialMaterial_flags_vertex_lighting: + +- :ref:`bool` **flags_vertex_lighting** + + .. _class_SpatialMaterial_flags_world_triplanar: + +- :ref:`bool` **flags_world_triplanar** + + .. _class_SpatialMaterial_metallic: + +- :ref:`float` **metallic** + + .. _class_SpatialMaterial_metallic_specular: + +- :ref:`float` **metallic_specular** + + .. _class_SpatialMaterial_metallic_texture: + +- :ref:`Texture` **metallic_texture** + + .. _class_SpatialMaterial_metallic_texture_channel: + +- :ref:`TextureChannel` **metallic_texture_channel** + + .. _class_SpatialMaterial_normal_enabled: + +- :ref:`bool` **normal_enabled** + + .. _class_SpatialMaterial_normal_scale: + +- :ref:`float` **normal_scale** + + .. _class_SpatialMaterial_normal_texture: + +- :ref:`Texture` **normal_texture** + + .. _class_SpatialMaterial_params_alpha_scissor_threshold: + +- :ref:`float` **params_alpha_scissor_threshold** + + .. _class_SpatialMaterial_params_billboard_keep_scale: + +- :ref:`bool` **params_billboard_keep_scale** + + .. _class_SpatialMaterial_params_billboard_mode: + +- :ref:`BillboardMode` **params_billboard_mode** + + .. _class_SpatialMaterial_params_blend_mode: + +- :ref:`BlendMode` **params_blend_mode** + + .. _class_SpatialMaterial_params_cull_mode: + +- :ref:`CullMode` **params_cull_mode** + + .. _class_SpatialMaterial_params_depth_draw_mode: + +- :ref:`DepthDrawMode` **params_depth_draw_mode** + + .. _class_SpatialMaterial_params_diffuse_mode: + +- :ref:`DiffuseMode` **params_diffuse_mode** + + .. _class_SpatialMaterial_params_grow: + +- :ref:`bool` **params_grow** + + .. _class_SpatialMaterial_params_grow_amount: + +- :ref:`float` **params_grow_amount** + + .. _class_SpatialMaterial_params_line_width: + +- :ref:`float` **params_line_width** + + .. _class_SpatialMaterial_params_point_size: + +- :ref:`float` **params_point_size** + + .. _class_SpatialMaterial_params_specular_mode: + +- :ref:`SpecularMode` **params_specular_mode** + + .. _class_SpatialMaterial_params_use_alpha_scissor: + +- :ref:`bool` **params_use_alpha_scissor** + + .. _class_SpatialMaterial_particles_anim_h_frames: + +- :ref:`int` **particles_anim_h_frames** + + .. _class_SpatialMaterial_particles_anim_loop: + +- :ref:`int` **particles_anim_loop** + + .. _class_SpatialMaterial_particles_anim_v_frames: + +- :ref:`int` **particles_anim_v_frames** + + .. _class_SpatialMaterial_proximity_fade_distance: + +- :ref:`float` **proximity_fade_distance** + + .. _class_SpatialMaterial_proximity_fade_enable: + +- :ref:`bool` **proximity_fade_enable** + + .. _class_SpatialMaterial_refraction_enabled: + +- :ref:`bool` **refraction_enabled** + + .. _class_SpatialMaterial_refraction_scale: + +- :ref:`float` **refraction_scale** + + .. _class_SpatialMaterial_refraction_texture: + +- :ref:`Texture` **refraction_texture** + + .. _class_SpatialMaterial_refraction_texture_channel: + +- :ref:`TextureChannel` **refraction_texture_channel** + + .. _class_SpatialMaterial_rim: + +- :ref:`float` **rim** + + .. _class_SpatialMaterial_rim_enabled: + +- :ref:`bool` **rim_enabled** + + .. _class_SpatialMaterial_rim_texture: + +- :ref:`Texture` **rim_texture** + + .. _class_SpatialMaterial_rim_tint: + +- :ref:`float` **rim_tint** + + .. _class_SpatialMaterial_roughness: + +- :ref:`float` **roughness** + + .. _class_SpatialMaterial_roughness_texture: + +- :ref:`Texture` **roughness_texture** + + .. _class_SpatialMaterial_roughness_texture_channel: + +- :ref:`TextureChannel` **roughness_texture_channel** + + .. _class_SpatialMaterial_subsurf_scatter_enabled: + +- :ref:`bool` **subsurf_scatter_enabled** + + .. _class_SpatialMaterial_subsurf_scatter_strength: + +- :ref:`float` **subsurf_scatter_strength** + + .. _class_SpatialMaterial_subsurf_scatter_texture: + +- :ref:`Texture` **subsurf_scatter_texture** + + .. _class_SpatialMaterial_transmission: + +- :ref:`Color` **transmission** + + .. _class_SpatialMaterial_transmission_enabled: + +- :ref:`bool` **transmission_enabled** + + .. _class_SpatialMaterial_transmission_texture: + +- :ref:`Texture` **transmission_texture** + + .. _class_SpatialMaterial_uv1_offset: + +- :ref:`Vector3` **uv1_offset** + + .. _class_SpatialMaterial_uv1_scale: + +- :ref:`Vector3` **uv1_scale** + + .. _class_SpatialMaterial_uv1_triplanar: + +- :ref:`bool` **uv1_triplanar** + + .. _class_SpatialMaterial_uv1_triplanar_sharpness: + +- :ref:`float` **uv1_triplanar_sharpness** + + .. _class_SpatialMaterial_uv2_offset: + +- :ref:`Vector3` **uv2_offset** + + .. _class_SpatialMaterial_uv2_scale: + +- :ref:`Vector3` **uv2_scale** + + .. _class_SpatialMaterial_uv2_triplanar: + +- :ref:`bool` **uv2_triplanar** + + .. _class_SpatialMaterial_uv2_triplanar_sharpness: + +- :ref:`float` **uv2_triplanar_sharpness** + + .. _class_SpatialMaterial_vertex_color_is_srgb: + +- :ref:`bool` **vertex_color_is_srgb** + + .. _class_SpatialMaterial_vertex_color_use_as_albedo: + +- :ref:`bool` **vertex_color_use_as_albedo** + + diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index 59fa3285c..863c6b314 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -7,8 +7,7 @@ SpatialVelocityTracker ====================== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,38 +15,38 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | +| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** :ref:`Vector3` position **)** | +| void | :ref:`reset` **(** :ref:`Vector3` position **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | +| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_SpatialVelocityTracker_track_physics_step: - :ref:`bool` **track_physics_step** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SpatialVelocityTracker_get_tracked_linear_velocity: -- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const +- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const .. _class_SpatialVelocityTracker_reset: -- void **reset** **(** :ref:`Vector3` position **)** +- void **reset** **(** :ref:`Vector3` position **)** .. _class_SpatialVelocityTracker_update_position: -- void **update_position** **(** :ref:`Vector3` position **)** +- void **update_position** **(** :ref:`Vector3` position **)** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 5129a816b..dda71b7c7 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -7,17 +7,21 @@ SphereMesh ========== -**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Class representing a spherical :ref:`PrimitiveMesh`. +Class representing a spherical :ref:`PrimitiveMesh`. -Member Variables ----------------- +Description +----------- + +Class representing a spherical :ref:`PrimitiveMesh`. + +Property Descriptions +--------------------- .. _class_SphereMesh_height: @@ -40,8 +44,3 @@ Member Variables - :ref:`int` **rings** - Number of segments along the height of the sphere. Defaults to 32. -Description ------------ - -Class representing a spherical :ref:`PrimitiveMesh`. - diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 6c512cb86..b2a54ed19 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -7,8 +7,7 @@ SphereShape =========== -**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Sphere shape for 3D collisions. -Member Variables ----------------- +Description +----------- + +Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. This shape is useful for modeling sphere-like 3D objects. + +Property Descriptions +--------------------- .. _class_SphereShape_radius: - :ref:`float` **radius** - The sphere's radius. The shape's diameter is double the radius. -Description ------------ - -Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody` or :ref:`Area`. This shape is useful for modeling sphere-like 3D objects. - diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index d679175d3..fc0a17f5b 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -7,8 +7,7 @@ SpinBox ======= -**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,20 @@ Brief Description Numerical input text field. -Member Functions ----------------- +Methods +------- +----------------------------------+---------------------------------------------------------------+ -| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +| :ref:`LineEdit` | :ref:`get_line_edit` **(** **)** | +----------------------------------+---------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +SpinBox is a numerical input text field. It allows entering integers and floats. + +Property Descriptions +--------------------- .. _class_SpinBox_editable: @@ -32,23 +36,18 @@ Member Variables .. _class_SpinBox_prefix: -- :ref:`String` **prefix** +- :ref:`String` **prefix** .. _class_SpinBox_suffix: -- :ref:`String` **suffix** +- :ref:`String` **suffix** -Description ------------ - -SpinBox is a numerical input text field. It allows entering integers and floats. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SpinBox_get_line_edit: -- :ref:`LineEdit` **get_line_edit** **(** **)** +- :ref:`LineEdit` **get_line_edit** **(** **)** diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index a4ce3cc8a..bcefb18d2 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -7,10 +7,8 @@ SplitContainer ============== -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`HSplitContainer`, :ref:`VSplitContainer` **Category:** Core Brief Description @@ -28,24 +26,8 @@ Signals Emitted when the dragger is dragged by user. -Member Variables ----------------- - - .. _class_SplitContainer_collapsed: - -- :ref:`bool` **collapsed** - - .. _class_SplitContainer_dragger_visibility: - -- :ref:`DraggerVisibility` **dragger_visibility** - Determines whether the dragger is visible. - - .. _class_SplitContainer_split_offset: - -- :ref:`int` **split_offset** - - -Enums ------ +Enumerations +------------ .. _enum_SplitContainer_DraggerVisibility: @@ -61,3 +43,19 @@ Description Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. +Property Descriptions +--------------------- + + .. _class_SplitContainer_collapsed: + +- :ref:`bool` **collapsed** + + .. _class_SplitContainer_dragger_visibility: + +- :ref:`DraggerVisibility` **dragger_visibility** - Determines whether the dragger is visible. + + .. _class_SplitContainer_split_offset: + +- :ref:`int` **split_offset** + + diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index db61eb4e1..748b3eae4 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -7,17 +7,26 @@ SpotLight ========= -**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Light` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Spotlight :ref:`Light`, such as a reflector spotlight or a lantern. +Spotlight :ref:`Light`, such as a reflector spotlight or a lantern. -Member Variables ----------------- +Description +----------- + +A SpotLight light is a type of :ref:`Light` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. TODO: Image of a spotlight. + +Tutorials +--------- + +- :doc:`../tutorials/3d/lights_and_shadows` + +Property Descriptions +--------------------- .. _class_SpotLight_spot_angle: @@ -36,13 +45,3 @@ Member Variables - :ref:`float` **spot_range** -Description ------------ - -A SpotLight light is a type of :ref:`Light` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light`. TODO: Image of a spotlight. - -Tutorials ---------- - -- :doc:`../tutorials/3d/lights_and_shadows` - diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index 1030bd6df..bba85d2a2 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -7,8 +7,7 @@ SpringArm ========= -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | +| void | :ref:`add_excluded_object` **(** :ref:`RID` RID **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_excluded_objects` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_hit_length` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | +| :ref:`bool` | :ref:`remove_excluded_object` **(** :ref:`RID` RID **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_SpringArm_collision_mask: @@ -42,19 +41,19 @@ Member Variables .. _class_SpringArm_shape: -- :ref:`Shape` **shape** +- :ref:`Shape` **shape** .. _class_SpringArm_spring_length: - :ref:`float` **spring_length** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SpringArm_add_excluded_object: -- void **add_excluded_object** **(** :ref:`RID` RID **)** +- void **add_excluded_object** **(** :ref:`RID` RID **)** .. _class_SpringArm_clear_excluded_objects: @@ -66,6 +65,6 @@ Member Function Description .. _class_SpringArm_remove_excluded_object: -- :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** +- :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 843d02bc6..2fb2d3900 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -7,8 +7,7 @@ Sprite ====== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,14 @@ Brief Description General purpose Sprite node. -Member Functions ----------------- +Methods +------- -+----------------------------+----------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | -+----------------------------+----------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_rect` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pixel_opaque` **(** :ref:`Vector2` pos **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------+ Signals ------- @@ -39,8 +40,13 @@ Emitted when the :ref:`frame` changes. Emitted when the :ref:`texture` changes. -Member Variables ----------------- +Description +----------- + +A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. + +Property Descriptions +--------------------- .. _class_Sprite_centered: @@ -64,11 +70,11 @@ Member Variables .. _class_Sprite_normal_map: -- :ref:`Texture` **normal_map** - The normal map gives depth to the Sprite. +- :ref:`Texture` **normal_map** - The normal map gives depth to the Sprite. .. _class_Sprite_offset: -- :ref:`Vector2` **offset** - The texture's drawing offset. +- :ref:`Vector2` **offset** - The texture's drawing offset. .. _class_Sprite_region_enabled: @@ -80,29 +86,28 @@ Member Variables .. _class_Sprite_region_rect: -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. .. _class_Sprite_texture: -- :ref:`Texture` **texture** - :ref:`Texture` object to draw. +- :ref:`Texture` **texture** - :ref:`Texture` object to draw. .. _class_Sprite_vframes: - :ref:`int` **vframes** - The number of rows in the sprite sheet. -Description ------------ - -A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Sprite_get_rect: -- :ref:`Rect2` **get_rect** **(** **)** const +- :ref:`Rect2` **get_rect** **(** **)** const Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. +.. _class_Sprite_is_pixel_opaque: + +- :ref:`bool` **is_pixel_opaque** **(** :ref:`Vector2` pos **)** const + diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index ffcce51fc..71a77fec9 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -7,8 +7,7 @@ Sprite3D ======== -**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -26,8 +25,13 @@ Signals Emitted when the :ref:`frame` changes. -Member Variables ----------------- +Description +----------- + +A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. + +Property Descriptions +--------------------- .. _class_Sprite3D_frame: @@ -43,19 +47,14 @@ Member Variables .. _class_Sprite3D_region_rect: -- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. +- :ref:`Rect2` **region_rect** - The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. .. _class_Sprite3D_texture: -- :ref:`Texture` **texture** - :ref:`Texture` object to draw. +- :ref:`Texture` **texture** - :ref:`Texture` object to draw. .. _class_Sprite3D_vframes: - :ref:`int` **vframes** - The number of rows in the sprite sheet. -Description ------------ - -A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. - diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index c5dc8fe63..99260741d 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -7,10 +7,8 @@ SpriteBase3D ============ -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`AnimatedSprite3D`, :ref:`Sprite3D` - +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`AnimatedSprite3D`, :ref:`Sprite3D` **Category:** Core Brief Description @@ -18,69 +16,17 @@ Brief Description 2D Sprite node in 3D environment. -Member Functions ----------------- +Methods +------- +------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_SpriteBase3D_alpha_cut: - -- :ref:`AlphaCutMode` **alpha_cut** - - .. _class_SpriteBase3D_axis: - -- :ref:`Axis` **axis** - The direction in which the front of the texture faces. - - .. _class_SpriteBase3D_centered: - -- :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. - - .. _class_SpriteBase3D_double_sided: - -- :ref:`bool` **double_sided** - If ``true`` texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. - - .. _class_SpriteBase3D_flip_h: - -- :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. - - .. _class_SpriteBase3D_flip_v: - -- :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. - - .. _class_SpriteBase3D_modulate: - -- :ref:`Color` **modulate** - A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. - - .. _class_SpriteBase3D_offset: - -- :ref:`Vector2` **offset** - The texture's drawing offset. - - .. _class_SpriteBase3D_opacity: - -- :ref:`float` **opacity** - The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. - - .. _class_SpriteBase3D_pixel_size: - -- :ref:`float` **pixel_size** - The size of one pixel's width on the Sprite to scale it in 3D. - - .. _class_SpriteBase3D_shaded: - -- :ref:`bool` **shaded** - If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. - - .. _class_SpriteBase3D_transparent: - -- :ref:`bool` **transparent** - If ``true`` the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: ``true``. - - -Enums ------ +Enumerations +------------ .. _enum_SpriteBase3D_AlphaCutMode: @@ -105,15 +51,67 @@ Description A node that displays 2D texture information in a 3D environment. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_SpriteBase3D_alpha_cut: + +- :ref:`AlphaCutMode` **alpha_cut** + + .. _class_SpriteBase3D_axis: + +- :ref:`Axis` **axis** - The direction in which the front of the texture faces. + + .. _class_SpriteBase3D_centered: + +- :ref:`bool` **centered** - If ``true`` texture will be centered. Default value: ``true``. + + .. _class_SpriteBase3D_double_sided: + +- :ref:`bool` **double_sided** - If ``true`` texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. + + .. _class_SpriteBase3D_flip_h: + +- :ref:`bool` **flip_h** - If ``true`` texture is flipped horizontally. Default value: ``false``. + + .. _class_SpriteBase3D_flip_v: + +- :ref:`bool` **flip_v** - If ``true`` texture is flipped vertically. Default value: ``false``. + + .. _class_SpriteBase3D_modulate: + +- :ref:`Color` **modulate** - A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. + + .. _class_SpriteBase3D_offset: + +- :ref:`Vector2` **offset** - The texture's drawing offset. + + .. _class_SpriteBase3D_opacity: + +- :ref:`float` **opacity** - The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. + + .. _class_SpriteBase3D_pixel_size: + +- :ref:`float` **pixel_size** - The size of one pixel's width on the Sprite to scale it in 3D. + + .. _class_SpriteBase3D_shaded: + +- :ref:`bool` **shaded** - If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. + + .. _class_SpriteBase3D_transparent: + +- :ref:`bool` **transparent** - If ``true`` the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: ``true``. + + +Method Descriptions +------------------- .. _class_SpriteBase3D_generate_triangle_mesh: -- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +- :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const .. _class_SpriteBase3D_get_item_rect: -- :ref:`Rect2` **get_item_rect** **(** **)** const +- :ref:`Rect2` **get_item_rect** **(** **)** const diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 45ed64182..380c5c48a 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -7,8 +7,7 @@ SpriteFrames ============ -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,74 +15,66 @@ Brief Description Sprite frame library for AnimatedSprite. -Member Functions ----------------- +Methods +------- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | +| void | :ref:`clear` **(** :ref:`String` anim **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_all` **(** **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_animation_names` **(** **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_SpriteFrames_frames: - -- :ref:`Array` **frames** - - Description ----------- -Sprite frame library for :ref:`AnimatedSprite`. Contains frames and animation data for playback. +Sprite frame library for :ref:`AnimatedSprite`. Contains frames and animation data for playback. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SpriteFrames_add_animation: -- void **add_animation** **(** :ref:`String` anim **)** +- void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the library. .. _class_SpriteFrames_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** +- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. .. _class_SpriteFrames_clear: -- void **clear** **(** :ref:`String` anim **)** +- void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. @@ -95,73 +86,73 @@ Removes all animations. A "default" animation will be created. .. _class_SpriteFrames_get_animation_loop: -- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const +- :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const If ``true`` the given animation will loop. .. _class_SpriteFrames_get_animation_names: -- :ref:`PoolStringArray` **get_animation_names** **(** **)** const +- :ref:`PoolStringArray` **get_animation_names** **(** **)** const Returns an array containing the names associated to each animation. Values are placed in alphabetical order. .. _class_SpriteFrames_get_animation_speed: -- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const +- :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const The animation's speed in frames per second. .. _class_SpriteFrames_get_frame: -- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const +- :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const Returns the animation's selected frame. .. _class_SpriteFrames_get_frame_count: -- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const +- :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const Returns the number of frames in the animation. .. _class_SpriteFrames_has_animation: -- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const +- :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true`` the named animation exists. .. _class_SpriteFrames_remove_animation: -- void **remove_animation** **(** :ref:`String` anim **)** +- void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. .. _class_SpriteFrames_remove_frame: -- void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** +- void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. .. _class_SpriteFrames_rename_animation: -- void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** +- void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. .. _class_SpriteFrames_set_animation_loop: -- void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** +- void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true`` the animation will loop. .. _class_SpriteFrames_set_animation_speed: -- void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** +- void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. .. _class_SpriteFrames_set_frame: -- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** +- void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** Sets the texture of the given frame. diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 51bf803ef..b994134f5 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -7,8 +7,7 @@ StaticBody ========== -**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,30 +15,6 @@ Brief Description Static body for 3D Physics. -Member Variables ----------------- - - .. _class_StaticBody_bounce: - -- :ref:`float` **bounce** - The body bounciness. - - .. _class_StaticBody_constant_angular_velocity: - -- :ref:`Vector3` **constant_angular_velocity** - The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. - - .. _class_StaticBody_constant_linear_velocity: - -- :ref:`Vector3` **constant_linear_velocity** - The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. - - .. _class_StaticBody_friction: - -- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). - - .. _class_StaticBody_physics_material_override: - -- :ref:`PhysicsMaterial` **physics_material_override** - - Description ----------- @@ -49,3 +24,27 @@ A static body can also be animated by using simulated motion mode. This is usefu Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). +Property Descriptions +--------------------- + + .. _class_StaticBody_bounce: + +- :ref:`float` **bounce** - The body bounciness. + + .. _class_StaticBody_constant_angular_velocity: + +- :ref:`Vector3` **constant_angular_velocity** - The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. + + .. _class_StaticBody_constant_linear_velocity: + +- :ref:`Vector3` **constant_linear_velocity** - The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. + + .. _class_StaticBody_friction: + +- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). + + .. _class_StaticBody_physics_material_override: + +- :ref:`PhysicsMaterial` **physics_material_override** + + diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index d6c9a52bb..b30df0021 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -7,8 +7,7 @@ StaticBody2D ============ -**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`PhysicsBody2D` **<** :ref:`CollisionObject2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,15 @@ Brief Description Static body for 2D Physics. -Member Variables ----------------- +Description +----------- + +Static body for 2D Physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms. + +Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt). + +Property Descriptions +--------------------- .. _class_StaticBody2D_bounce: @@ -29,7 +35,7 @@ Member Variables .. _class_StaticBody2D_constant_linear_velocity: -- :ref:`Vector2` **constant_linear_velocity** - Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. +- :ref:`Vector2` **constant_linear_velocity** - Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. .. _class_StaticBody2D_friction: @@ -37,13 +43,6 @@ Member Variables .. _class_StaticBody2D_physics_material_override: -- :ref:`PhysicsMaterial` **physics_material_override** +- :ref:`PhysicsMaterial` **physics_material_override** -Description ------------ - -Static body for 2D Physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms. - -Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt). - diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index dfce3ded4..b9283d314 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -7,10 +7,8 @@ StreamPeer ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP`, :ref:`StreamPeerGDNative` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP`, :ref:`StreamPeerGDNative` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Abstraction and base class for stream-based protocols. -Member Functions ----------------- +Methods +------- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_16` **(** **)** | @@ -32,15 +30,15 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_available_bytes` **(** **)** const | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | +| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_double` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_float` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | +| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | +| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u16` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ @@ -50,9 +48,9 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u8` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | +| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | +| :ref:`Variant` | :ref:`get_var` **(** **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_16` **(** :ref:`int` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ @@ -62,13 +60,13 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_8` **(** :ref:`int` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | +| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_double` **(** :ref:`float` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_float` **(** :ref:`float` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u16` **(** :ref:`int` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ @@ -78,26 +76,26 @@ Member Functions +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u8` **(** :ref:`int` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | +| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_var` **(** :ref:`Variant` value **)** | +| void | :ref:`put_var` **(** :ref:`Variant` value **)** | +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_StreamPeer_big_endian: - -- :ref:`bool` **big_endian** - If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding. - - Description ----------- StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_StreamPeer_big_endian: + +- :ref:`bool` **big_endian** - If ``true``, this ``StreamPeer`` will using big-endian format for encoding and decoding. + + +Method Descriptions +------------------- .. _class_StreamPeer_get_16: @@ -131,7 +129,7 @@ Return the amount of bytes this ``StreamPeer`` has available. .. _class_StreamPeer_get_data: -- :ref:`Array` **get_data** **(** :ref:`int` bytes **)** +- :ref:`Array` **get_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. @@ -149,13 +147,13 @@ Get a single-precision float from the stream. .. _class_StreamPeer_get_partial_data: -- :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** +- :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. .. _class_StreamPeer_get_string: -- :ref:`String` **get_string** **(** :ref:`int` bytes **)** +- :ref:`String` **get_string** **(** :ref:`int` bytes **)** Get a string with byte-length "bytes" from the stream. @@ -185,13 +183,13 @@ Get an unsigned byte from the stream. .. _class_StreamPeer_get_utf8_string: -- :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** +- :ref:`String` **get_utf8_string** **(** :ref:`int` bytes **)** Get a utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). .. _class_StreamPeer_get_var: -- :ref:`Variant` **get_var** **(** **)** +- :ref:`Variant` **get_var** **(** **)** Get a Variant from the stream. @@ -221,7 +219,7 @@ Put a signed byte into the stream. .. _class_StreamPeer_put_data: -- :ref:`Error` **put_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`Error` **put_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. @@ -239,7 +237,7 @@ Put a single-precision float into the stream. .. _class_StreamPeer_put_partial_data: -- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** +- :ref:`Array` **put_partial_data** **(** :ref:`PoolByteArray` data **)** Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. @@ -269,13 +267,13 @@ Put an unsigned byte into the stream. .. _class_StreamPeer_put_utf8_string: -- void **put_utf8_string** **(** :ref:`String` value **)** +- void **put_utf8_string** **(** :ref:`String` value **)** Put a zero-terminated utf8 string into the stream. .. _class_StreamPeer_put_var: -- void **put_var** **(** :ref:`Variant` value **)** +- void **put_var** **(** :ref:`Variant` value **)** Put a Variant into the stream. diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 5734c8d57..7fc8d409a 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -7,8 +7,7 @@ StreamPeerBuffer ================ -**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | +| :ref:`StreamPeerBuffer` | :ref:`duplicate` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_position` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -33,16 +32,16 @@ Member Functions | void | :ref:`seek` **(** :ref:`int` position **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_StreamPeerBuffer_data_array: -- :ref:`PoolByteArray` **data_array** +- :ref:`PoolByteArray` **data_array** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_StreamPeerBuffer_clear: @@ -50,7 +49,7 @@ Member Function Description .. _class_StreamPeerBuffer_duplicate: -- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const +- :ref:`StreamPeerBuffer` **duplicate** **(** **)** const .. _class_StreamPeerBuffer_get_position: diff --git a/classes/class_streampeergdnative.rst b/classes/class_streampeergdnative.rst index e48948812..8e1ae50e9 100644 --- a/classes/class_streampeergdnative.rst +++ b/classes/class_streampeergdnative.rst @@ -7,8 +7,7 @@ StreamPeerGDNative ================== -**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index efa51bb6a..bd482074b 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -7,8 +7,7 @@ StreamPeerSSL ============= -**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,23 @@ Brief Description SSL Stream peer. -Member Functions ----------------- +Methods +------- +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` base **)** | +| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` base **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | +| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_stream` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** const | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_StreamPeerSSL_blocking_handshake: - -- :ref:`bool` **blocking_handshake** - - -Enums ------ +Enumerations +------------ .. _enum_StreamPeerSSL_Status: @@ -62,18 +53,26 @@ Tutorials - :doc:`../tutorials/networking/ssl_certificates` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_StreamPeerSSL_blocking_handshake: + +- :ref:`bool` **blocking_handshake** + + +Method Descriptions +------------------- .. _class_StreamPeerSSL_accept_stream: -- :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** +- :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** .. _class_StreamPeerSSL_connect_to_stream: -- :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** +- :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** -Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". +Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". .. _class_StreamPeerSSL_disconnect_from_stream: @@ -83,7 +82,7 @@ Disconnect from host. .. _class_StreamPeerSSL_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 6f64548a7..5db4c03a8 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -7,8 +7,7 @@ StreamPeerTCP ============= -**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,27 @@ Brief Description TCP Stream peer. -Member Functions ----------------- +Methods +------- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_host` **(** **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connected_port` **(** **)** const | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** const | +| :ref:`Status` | :ref:`get_status` **(** **)** const | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_StreamPeerTCP_Status: @@ -53,12 +52,12 @@ Description TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_StreamPeerTCP_connect_to_host: -- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** +- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure. @@ -70,7 +69,7 @@ Disconnect from host. .. _class_StreamPeerTCP_get_connected_host: -- :ref:`String` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. @@ -82,7 +81,7 @@ Return the port of this peer. .. _class_StreamPeerTCP_get_status: -- :ref:`Status` **get_status** **(** **)** const +- :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 3bc320ff4..f362c4a30 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -7,8 +7,7 @@ StreamTexture ============= -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description A .stex texture. -Member Variables ----------------- - - .. _class_StreamTexture_load_path: - -- :ref:`String` **load_path** - The StreamTexture's filepath to a .stex file. - - Description ----------- A texture that is loaded from a .stex file. +Property Descriptions +--------------------- + + .. _class_StreamTexture_load_path: + +- :ref:`String` **load_path** - The StreamTexture's filepath to a .stex file. + + diff --git a/classes/class_string.rst b/classes/class_string.rst index 197f6eaba..1fdce9dfc 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -14,107 +14,107 @@ Brief Description Built-in string class. -Member Functions ----------------- +Methods +------- +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`bool` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`int` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`float` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Vector2` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Rect2` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Vector3` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Transform2D` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Plane` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Quat` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`AABB` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Basis` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Transform` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Color` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolByteArray` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolIntArray` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolRealArray` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolStringArray` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector2Array` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolVector3Array` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | +| :ref:`String` | :ref:`String` **(** :ref:`PoolColorArray` from **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | +| :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | +| :ref:`PoolStringArray` | :ref:`bigrams` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_escape` **(** **)** | +| :ref:`String` | :ref:`c_escape` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`c_unescape` **(** **)** | +| :ref:`String` | :ref:`c_unescape` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capitalize` **(** **)** | +| :ref:`String` | :ref:`capitalize` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | +| :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`dedent` **(** **)** | +| :ref:`String` | :ref:`dedent` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | +| :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | +| :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | +| :ref:`int` | :ref:`find_last` **(** :ref:`String` what **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | +| :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`format` **(** var values, :ref:`String` placeholder={_} **)** | +| :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_base_dir` **(** **)** | +| :ref:`String` | :ref:`get_base_dir` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_basename` **(** **)** | +| :ref:`String` | :ref:`get_basename` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_extension` **(** **)** | +| :ref:`String` | :ref:`get_extension` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | +| :ref:`String` | :ref:`get_file` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | +| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_abs_path` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_rel_path` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | +| :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | +| :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_float` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -126,83 +126,83 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`json_escape` **(** **)** | +| :ref:`String` | :ref:`json_escape` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | +| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | +| :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | +| :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | +| :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | +| :ref:`PoolByteArray` | :ref:`md5_buffer` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`md5_text` **(** **)** | +| :ref:`String` | :ref:`md5_text` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | +| :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`ord_at` **(** :ref:`int` at **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | +| :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | +| :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_decode` **(** **)** | +| :ref:`String` | :ref:`percent_decode` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_encode` **(** **)** | +| :ref:`String` | :ref:`percent_encode` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | +| :ref:`String` | :ref:`plus_file` **(** :ref:`String` file **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | +| :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | +| :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +| :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +| :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | +| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`rsplit` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | +| :ref:`PoolStringArray` | :ref:`rsplit` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | +| :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | +| :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sha256_text` **(** **)** | +| :ref:`String` | :ref:`sha256_text` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | +| :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | +| :ref:`PoolStringArray` | :ref:`split` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | +| :ref:`PoolRealArray` | :ref:`split_floats` **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | +| :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=True, :ref:`bool` right=True **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | +| :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | +| :ref:`PoolByteArray` | :ref:`to_ascii` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`to_float` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_lower` **(** **)** | +| :ref:`String` | :ref:`to_lower` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`to_upper` **(** **)** | +| :ref:`String` | :ref:`to_upper` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | +| :ref:`PoolByteArray` | :ref:`to_utf8` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | +| :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | +| :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_escape` **(** **)** | +| :ref:`String` | :ref:`xml_escape` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xml_unescape` **(** **)** | +| :ref:`String` | :ref:`xml_unescape` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -210,192 +210,192 @@ Description This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_String_String: -- :ref:`String` **String** **(** :ref:`bool` from **)** +- :ref:`String` **String** **(** :ref:`bool` from **)** Constructs a new String from the given :ref:`bool`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`int` from **)** +- :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`float` from **)** +- :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Vector2` from **)** +- :ref:`String` **String** **(** :ref:`Vector2` from **)** -Constructs a new String from the given :ref:`Vector2`. +Constructs a new String from the given :ref:`Vector2`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Rect2` from **)** +- :ref:`String` **String** **(** :ref:`Rect2` from **)** -Constructs a new String from the given :ref:`Rect2`. +Constructs a new String from the given :ref:`Rect2`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Vector3` from **)** +- :ref:`String` **String** **(** :ref:`Vector3` from **)** -Constructs a new String from the given :ref:`Vector3`. +Constructs a new String from the given :ref:`Vector3`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Transform2D` from **)** +- :ref:`String` **String** **(** :ref:`Transform2D` from **)** -Constructs a new String from the given :ref:`Transform2D`. +Constructs a new String from the given :ref:`Transform2D`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Plane` from **)** +- :ref:`String` **String** **(** :ref:`Plane` from **)** -Constructs a new String from the given :ref:`Plane`. +Constructs a new String from the given :ref:`Plane`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Quat` from **)** +- :ref:`String` **String** **(** :ref:`Quat` from **)** -Constructs a new String from the given :ref:`Quat`. +Constructs a new String from the given :ref:`Quat`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`AABB` from **)** +- :ref:`String` **String** **(** :ref:`AABB` from **)** -Constructs a new String from the given :ref:`AABB`. +Constructs a new String from the given :ref:`AABB`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Basis` from **)** +- :ref:`String` **String** **(** :ref:`Basis` from **)** -Constructs a new String from the given :ref:`Basis`. +Constructs a new String from the given :ref:`Basis`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Transform` from **)** +- :ref:`String` **String** **(** :ref:`Transform` from **)** -Constructs a new String from the given :ref:`Transform`. +Constructs a new String from the given :ref:`Transform`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Color` from **)** +- :ref:`String` **String** **(** :ref:`Color` from **)** -Constructs a new String from the given :ref:`Color`. +Constructs a new String from the given :ref:`Color`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`NodePath` from **)** +- :ref:`String` **String** **(** :ref:`NodePath` from **)** -Constructs a new String from the given :ref:`NodePath`. +Constructs a new String from the given :ref:`NodePath`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`RID` from **)** +- :ref:`String` **String** **(** :ref:`RID` from **)** -Constructs a new String from the given :ref:`RID`. +Constructs a new String from the given :ref:`RID`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Dictionary` from **)** +- :ref:`String` **String** **(** :ref:`Dictionary` from **)** -Constructs a new String from the given :ref:`Dictionary`. +Constructs a new String from the given :ref:`Dictionary`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`Array` from **)** +- :ref:`String` **String** **(** :ref:`Array` from **)** -Constructs a new String from the given :ref:`Array`. +Constructs a new String from the given :ref:`Array`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** -Constructs a new String from the given :ref:`PoolByteArray`. +Constructs a new String from the given :ref:`PoolByteArray`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** -Constructs a new String from the given :ref:`PoolIntArray`. +Constructs a new String from the given :ref:`PoolIntArray`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** -Constructs a new String from the given :ref:`PoolRealArray`. +Constructs a new String from the given :ref:`PoolRealArray`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** -Constructs a new String from the given :ref:`PoolStringArray`. +Constructs a new String from the given :ref:`PoolStringArray`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** +- :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** -Constructs a new String from the given :ref:`PoolVector2Array`. +Constructs a new String from the given :ref:`PoolVector2Array`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** +- :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** -Constructs a new String from the given :ref:`PoolVector3Array`. +Constructs a new String from the given :ref:`PoolVector3Array`. .. _class_String_String: -- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** +- :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** -Constructs a new String from the given :ref:`PoolColorArray`. +Constructs a new String from the given :ref:`PoolColorArray`. .. _class_String_begins_with: -- :ref:`bool` **begins_with** **(** :ref:`String` text **)** +- :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. .. _class_String_bigrams: -- :ref:`PoolStringArray` **bigrams** **(** **)** +- :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. .. _class_String_c_escape: -- :ref:`String` **c_escape** **(** **)** +- :ref:`String` **c_escape** **(** **)** Returns a copy of the string with special characters escaped using the C language standard. .. _class_String_c_unescape: -- :ref:`String` **c_unescape** **(** **)** +- :ref:`String` **c_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. .. _class_String_capitalize: -- :ref:`String` **capitalize** **(** **)** +- :ref:`String` **capitalize** **(** **)** Changes the case of some letters. Replaces underscores with spaces, converts all letters to lowercase, then capitalizes first and every letter following the space character. For ``capitalize camelCase mixed_with_underscores`` it will return ``Capitalize Camelcase Mixed With Underscores``. .. _class_String_casecmp_to: -- :ref:`int` **casecmp_to** **(** :ref:`String` to **)** +- :ref:`int` **casecmp_to** **(** :ref:`String` to **)** Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. .. _class_String_dedent: -- :ref:`String` **dedent** **(** **)** +- :ref:`String` **dedent** **(** **)** Removes indentation from string. @@ -407,7 +407,7 @@ Returns ``true`` if the string is empty. .. _class_String_ends_with: -- :ref:`bool` **ends_with** **(** :ref:`String` text **)** +- :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. @@ -419,49 +419,49 @@ Erases ``chars`` characters from the string starting from ``position``. .. _class_String_find: -- :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** +- :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. .. _class_String_find_last: -- :ref:`int` **find_last** **(** :ref:`String` what **)** +- :ref:`int` **find_last** **(** :ref:`String` what **)** Finds the last occurrence of a substring. Returns the starting position of the substring or -1 if not found. .. _class_String_findn: -- :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** +- :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. .. _class_String_format: -- :ref:`String` **format** **(** var values, :ref:`String` placeholder={_} **)** +- :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder={_} **)** Formats the string by replacing all occurrences of ``placeholder`` with ``values``. .. _class_String_get_base_dir: -- :ref:`String` **get_base_dir** **(** **)** +- :ref:`String` **get_base_dir** **(** **)** If the string is a valid file path, returns the base directory name. .. _class_String_get_basename: -- :ref:`String` **get_basename** **(** **)** +- :ref:`String` **get_basename** **(** **)** If the string is a valid file path, returns the full file path without the extension. .. _class_String_get_extension: -- :ref:`String` **get_extension** **(** **)** +- :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. .. _class_String_get_file: -- :ref:`String` **get_file** **(** **)** +- :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. @@ -479,7 +479,7 @@ Converts a string containing a hexadecimal number into an integer. .. _class_String_insert: -- :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** +- :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. @@ -497,13 +497,13 @@ If the string is a path to a file or directory, returns ``true`` if the path is .. _class_String_is_subsequence_of: -- :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** +- :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string. .. _class_String_is_subsequence_ofi: -- :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** +- :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string, without considering case. @@ -539,13 +539,13 @@ Returns ``true`` if this string contains a valid IP address. .. _class_String_json_escape: -- :ref:`String` **json_escape** **(** **)** +- :ref:`String` **json_escape** **(** **)** Returns a copy of the string with special characters escaped using the JSON standard. .. _class_String_left: -- :ref:`String` **left** **(** :ref:`int` position **)** +- :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. @@ -557,37 +557,37 @@ Returns the string's amount of characters. .. _class_String_lstrip: -- :ref:`String` **lstrip** **(** :ref:`String` chars **)** +- :ref:`String` **lstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the left. .. _class_String_match: -- :ref:`bool` **match** **(** :ref:`String` expr **)** +- :ref:`bool` **match** **(** :ref:`String` expr **)** Does a simple expression match, where '\*' matches zero or more arbitrary characters and '?' matches any single character except '.'. .. _class_String_matchn: -- :ref:`bool` **matchn** **(** :ref:`String` expr **)** +- :ref:`bool` **matchn** **(** :ref:`String` expr **)** Does a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). .. _class_String_md5_buffer: -- :ref:`PoolByteArray` **md5_buffer** **(** **)** +- :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. .. _class_String_md5_text: -- :ref:`String` **md5_text** **(** **)** +- :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. .. _class_String_nocasecmp_to: -- :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** +- :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** Performs a case-insensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal. @@ -599,67 +599,67 @@ Returns the character code at position ``at``. .. _class_String_pad_decimals: -- :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** +- :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` after the decimal point. .. _class_String_pad_zeros: -- :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** +- :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** Formats a number to have an exact number of ``digits`` before the decimal point. .. _class_String_percent_decode: -- :ref:`String` **percent_decode** **(** **)** +- :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. .. _class_String_percent_encode: -- :ref:`String` **percent_encode** **(** **)** +- :ref:`String` **percent_encode** **(** **)** Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). .. _class_String_plus_file: -- :ref:`String` **plus_file** **(** :ref:`String` file **)** +- :ref:`String` **plus_file** **(** :ref:`String` file **)** If the string is a path, this concatenates ``file`` at the end of the string as a subpath. E.g. ``"this/is".plus_file("path") == "this/is/path"``. .. _class_String_replace: -- :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** +- :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. .. _class_String_replacen: -- :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** +- :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. Ignores case. .. _class_String_rfind: -- :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** +- :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. .. _class_String_rfindn: -- :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** +- :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** Performs a search for a substring, but starts from the end of the string instead of the beginning. Ignores case. .. _class_String_right: -- :ref:`String` **right** **(** :ref:`int` position **)** +- :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. .. _class_String_rsplit: -- :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** +- :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** Splits the string by a ``divisor`` string and returns an array of the substrings, starting from right. @@ -669,29 +669,29 @@ If ``maxsplit`` is specified, then it is number of splits to do, default is 0 wh .. _class_String_rstrip: -- :ref:`String` **rstrip** **(** :ref:`String` chars **)** +- :ref:`String` **rstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the right. .. _class_String_sha256_buffer: -- :ref:`PoolByteArray` **sha256_buffer** **(** **)** +- :ref:`PoolByteArray` **sha256_buffer** **(** **)** .. _class_String_sha256_text: -- :ref:`String` **sha256_text** **(** **)** +- :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. .. _class_String_similarity: -- :ref:`float` **similarity** **(** :ref:`String` text **)** +- :ref:`float` **similarity** **(** :ref:`String` text **)** Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. .. _class_String_split: -- :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** +- :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** Splits the string by a divisor string and returns an array of the substrings. @@ -701,7 +701,7 @@ If ``maxsplit`` is given, at most maxsplit number of splits occur, and the remai .. _class_String_split_floats: -- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** +- :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** Splits the string in floats by using a divisor string and returns an array of the substrings. @@ -709,21 +709,21 @@ Splits the string in floats by using a divisor string and returns an array of th .. _class_String_strip_edges: -- :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** +- :ref:`String` **strip_edges** **(** :ref:`bool` left=True, :ref:`bool` right=True **)** Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. .. _class_String_substr: -- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** +- :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len **)** Returns part of the string from the position ``from`` with length ``len``. .. _class_String_to_ascii: -- :ref:`PoolByteArray` **to_ascii** **(** **)** +- :ref:`PoolByteArray` **to_ascii** **(** **)** -Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is sped up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. +Converts the String (which is a character array) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is sped up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. .. _class_String_to_float: @@ -739,43 +739,43 @@ Converts a string containing an integer number into an ``int``. .. _class_String_to_lower: -- :ref:`String` **to_lower** **(** **)** +- :ref:`String` **to_lower** **(** **)** Returns the string converted to lowercase. .. _class_String_to_upper: -- :ref:`String` **to_upper** **(** **)** +- :ref:`String` **to_upper** **(** **)** Returns the string converted to uppercase. .. _class_String_to_utf8: -- :ref:`PoolByteArray` **to_utf8** **(** **)** +- :ref:`PoolByteArray` **to_utf8** **(** **)** -Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). +Converts the String (which is an array of characters) to :ref:`PoolByteArray` (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). .. _class_String_trim_prefix: -- :ref:`String` **trim_prefix** **(** :ref:`String` prefix **)** +- :ref:`String` **trim_prefix** **(** :ref:`String` prefix **)** Removes a given string from the start if it starts with it or leaves the string unchanged. .. _class_String_trim_suffix: -- :ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** +- :ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** Removes a given string from the end if it ends with it or leaves the string unchanged. .. _class_String_xml_escape: -- :ref:`String` **xml_escape** **(** **)** +- :ref:`String` **xml_escape** **(** **)** Returns a copy of the string with special characters escaped using the XML standard. .. _class_String_xml_unescape: -- :ref:`String` **xml_unescape** **(** **)** +- :ref:`String` **xml_unescape** **(** **)** Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 22e368f5c..862a05ff7 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -7,10 +7,8 @@ StyleBox ======== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`StyleBoxLine`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`StyleBoxLine`, :ref:`StyleBoxFlat`, :ref:`StyleBoxTexture`, :ref:`StyleBoxEmpty` **Category:** Core Brief Description @@ -18,25 +16,30 @@ Brief Description Base class for drawing stylized boxes for the UI. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_center_size` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | +| :ref:`float` | :ref:`get_margin` **(** :ref:`Margin` margin **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_minimum_size` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | +| :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +StyleBox is :ref:`Resource` that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. + +Property Descriptions +--------------------- .. _class_StyleBox_content_margin_bottom: @@ -55,43 +58,38 @@ Member Variables - :ref:`float` **content_margin_top** -Description ------------ - -StyleBox is :ref:`Resource` that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_StyleBox_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const .. _class_StyleBox_get_center_size: -- :ref:`Vector2` **get_center_size** **(** **)** const +- :ref:`Vector2` **get_center_size** **(** **)** const .. _class_StyleBox_get_margin: -- :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const +- :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const Return the offset of margin "margin" (see MARGIN\_\* enum). .. _class_StyleBox_get_minimum_size: -- :ref:`Vector2` **get_minimum_size** **(** **)** const +- :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size that this stylebox can be shrunk to. .. _class_StyleBox_get_offset: -- :ref:`Vector2` **get_offset** **(** **)** const +- :ref:`Vector2` **get_offset** **(** **)** const Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``. .. _class_StyleBox_test_mask: -- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const +- :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const Test a position in a rectangle, return whether it passes the mask test. diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 55a4be732..8389c0a4b 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -7,8 +7,7 @@ StyleBoxEmpty ============= -**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index c740a93d5..3e73dc972 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -7,8 +7,7 @@ StyleBoxFlat ============ -**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Customizable Stylebox with a given set of parameters. (no texture required) -Member Functions ----------------- +Methods +------- +------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_border_width_min` **(** **)** const | @@ -33,8 +32,38 @@ Member Functions | void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | +------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: + + - Color + + - Border width (individual width for each border) + + - Rounded corners (individual radius for each corner) + + - Shadow + + About corner radius: + + Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + +:: + + height = 30 + corner_radius_top_left = 50 + corner_radius_bottom_left = 100 + +The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will **never** be more than the height. Result: + +:: + + corner_radius_top_left: 10 + corner_radius_bottom_left: 20 + +Property Descriptions +--------------------- .. _class_StyleBoxFlat_anti_aliasing: @@ -46,7 +75,7 @@ Member Variables .. _class_StyleBoxFlat_bg_color: -- :ref:`Color` **bg_color** - The background color of the stylebox. +- :ref:`Color` **bg_color** - The background color of the stylebox. .. _class_StyleBoxFlat_border_blend: @@ -54,7 +83,7 @@ Member Variables .. _class_StyleBoxFlat_border_color: -- :ref:`Color` **border_color** - Sets the color of the border. +- :ref:`Color` **border_color** - Sets the color of the border. .. _class_StyleBoxFlat_border_width_bottom: @@ -118,45 +147,15 @@ For corner radius smaller than 30: 8-12 should be enough ... .. _class_StyleBoxFlat_shadow_color: -- :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) +- :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) .. _class_StyleBoxFlat_shadow_size: - :ref:`int` **shadow_size** - The shadow size in pixels. -Description ------------ - -This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: - - - Color - - - Border width (individual width for each border) - - - Rounded corners (individual radius for each corner) - - - Shadow - - About corner radius: - - Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: - -:: - - height = 30 - corner_radius_top_left = 50 - corner_radius_bottom_left = 100 - -The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will **never** be more than the height. Result: - -:: - - corner_radius_top_left: 10 - corner_radius_bottom_left: 20 - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_StyleBoxFlat_get_border_width_min: diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 822ae5f95..3d210a0df 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -7,8 +7,7 @@ StyleBoxLine ============ -**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,12 +15,12 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_StyleBoxLine_color: -- :ref:`Color` **color** +- :ref:`Color` **color** .. _class_StyleBoxLine_grow_begin: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 8bcdca4a3..aab34241d 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -7,8 +7,7 @@ StyleBoxTexture =============== -**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Texture Based 3x3 scale style. -Member Functions ----------------- +Methods +------- +-------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | @@ -33,16 +32,33 @@ Signals - **texture_changed** **(** **)** -Member Variables ----------------- +Enumerations +------------ + + .. _enum_StyleBoxTexture_AxisStretchMode: + +enum **AxisStretchMode** + +- **AXIS_STRETCH_MODE_STRETCH** = **0** +- **AXIS_STRETCH_MODE_TILE** = **1** +- **AXIS_STRETCH_MODE_TILE_FIT** = **2** + + +Description +----------- + +Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. + +Property Descriptions +--------------------- .. _class_StyleBoxTexture_axis_stretch_horizontal: -- :ref:`AxisStretchMode` **axis_stretch_horizontal** +- :ref:`AxisStretchMode` **axis_stretch_horizontal** .. _class_StyleBoxTexture_axis_stretch_vertical: -- :ref:`AxisStretchMode` **axis_stretch_vertical** +- :ref:`AxisStretchMode` **axis_stretch_vertical** .. _class_StyleBoxTexture_draw_center: @@ -82,40 +98,23 @@ Member Variables .. _class_StyleBoxTexture_modulate_color: -- :ref:`Color` **modulate_color** +- :ref:`Color` **modulate_color** .. _class_StyleBoxTexture_normal_map: -- :ref:`Texture` **normal_map** +- :ref:`Texture` **normal_map** .. _class_StyleBoxTexture_region_rect: -- :ref:`Rect2` **region_rect** +- :ref:`Rect2` **region_rect** .. _class_StyleBoxTexture_texture: -- :ref:`Texture` **texture** +- :ref:`Texture` **texture** -Enums ------ - - .. _enum_StyleBoxTexture_AxisStretchMode: - -enum **AxisStretchMode** - -- **AXIS_STRETCH_MODE_STRETCH** = **0** -- **AXIS_STRETCH_MODE_TILE** = **1** -- **AXIS_STRETCH_MODE_TILE_FIT** = **2** - - -Description ------------ - -Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_StyleBoxTexture_set_expand_margin_all: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 70ae6f798..5a479430e 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -7,8 +7,7 @@ SurfaceTool =========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,43 +15,43 @@ Brief Description Helper tool to create geometry. -Member Functions ----------------- +Methods +------- +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | +| void | :ref:`add_color` **(** :ref:`Color` color **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_index` **(** :ref:`int` index **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_to_format` **(** :ref:`int` flags **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | +| void | :ref:`append_from` **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | +| void | :ref:`begin` **(** :ref:`PrimitiveType` primitive **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | +| :ref:`ArrayMesh` | :ref:`commit` **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | +| void | :ref:`create_from` **(** :ref:`Mesh` existing, :ref:`int` surface **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`deindex` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -62,13 +61,13 @@ Member Functions +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`index` **(** **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | +| void | :ref:`set_material` **(** :ref:`Material` material **)** | +------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like +The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like :: @@ -78,24 +77,24 @@ The ``SurfaceTool`` is used to construct a :ref:`Mesh` by specifying st.add_uv(Vector2(0, 0)) st.add_vertex(Vector3(0, 0, 0)) -The ``SurfaceTool`` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. +The ``SurfaceTool`` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. It is very important that vertex attributes are passed **before** the call to :ref:`add_vertex`, failure to do this will result in an error when committing the vertex information to a mesh. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_SurfaceTool_add_bones: -- void **add_bones** **(** :ref:`PoolIntArray` bones **)** +- void **add_bones** **(** :ref:`PoolIntArray` bones **)** Add an array of bones for the next Vertex to use. .. _class_SurfaceTool_add_color: -- void **add_color** **(** :ref:`Color` color **)** +- void **add_color** **(** :ref:`Color` color **)** -Specify a :ref:`Color` for the next Vertex to use. +Specify a :ref:`Color` for the next Vertex to use. .. _class_SurfaceTool_add_index: @@ -105,7 +104,7 @@ Adds an index to index array if you are using indexed Vertices. Does not need to .. _class_SurfaceTool_add_normal: -- void **add_normal** **(** :ref:`Vector3` normal **)** +- void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. @@ -117,7 +116,7 @@ Specify whether current Vertex (if using only Vertex arrays) or current index (i .. _class_SurfaceTool_add_tangent: -- void **add_tangent** **(** :ref:`Plane` tangent **)** +- void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. @@ -127,41 +126,41 @@ Specify a Tangent for the next Vertex to use. .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolColorArray` colors=PoolColorArray( ), :ref:`PoolVector2Array` uv2s=PoolVector2Array( ), :ref:`PoolVector3Array` normals=PoolVector3Array( ), :ref:`Array` tangents=[ ] **)** -Insert a triangle fan made of array data into :ref:`Mesh` being constructed. +Insert a triangle fan made of array data into :ref:`Mesh` being constructed. .. _class_SurfaceTool_add_uv: -- void **add_uv** **(** :ref:`Vector2` uv **)** +- void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. .. _class_SurfaceTool_add_uv2: -- void **add_uv2** **(** :ref:`Vector2` uv2 **)** +- void **add_uv2** **(** :ref:`Vector2` uv2 **)** Specify an optional second set of UV coordinates for next Vertex to use. .. _class_SurfaceTool_add_vertex: -- void **add_vertex** **(** :ref:`Vector3` vertex **)** +- void **add_vertex** **(** :ref:`Vector3` vertex **)** Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). .. _class_SurfaceTool_add_weights: -- void **add_weights** **(** :ref:`PoolRealArray` weights **)** +- void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight value for next Vertex to use. .. _class_SurfaceTool_append_from: -- void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** +- void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** .. _class_SurfaceTool_begin: -- void **begin** **(** :ref:`PrimitiveType` primitive **)** +- void **begin** **(** :ref:`PrimitiveType` primitive **)** Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). @@ -173,13 +172,13 @@ Clear all information passed into the surface tool so far. .. _class_SurfaceTool_commit: -- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** +- :ref:`ArrayMesh` **commit** **(** :ref:`ArrayMesh` existing=null, :ref:`int` flags=97280 **)** -Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. +Returns a constructed :ref:`ArrayMesh` from current information passed in. If an existing :ref:`ArrayMesh` is passed in as an argument, will add an extra surface to the existing :ref:`ArrayMesh`. .. _class_SurfaceTool_create_from: -- void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** +- void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** .. _class_SurfaceTool_deindex: @@ -207,8 +206,8 @@ Shrinks Vertex array by creating an index array. Avoids reusing Vertices. .. _class_SurfaceTool_set_material: -- void **set_material** **(** :ref:`Material` material **)** +- void **set_material** **(** :ref:`Material` material **)** -Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. +Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index a5f1025a3..c8113619a 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -7,8 +7,7 @@ TabContainer ============ -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,35 +15,35 @@ Brief Description Tabbed Container. -Member Functions ----------------- +Methods +------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | +| :ref:`Control` | :ref:`get_current_tab_control` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Popup` | :ref:`get_popup` **(** **)** const | +| :ref:`Popup` | :ref:`get_popup` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_previous_tab` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | +| :ref:`Control` | :ref:`get_tab_control` **(** :ref:`int` idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_count` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +| void | :ref:`set_popup` **(** :ref:`Node` popup **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -56,7 +55,7 @@ Signals - **pre_popup_pressed** **(** **)** -Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. +Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. .. _class_TabContainer_tab_changed: @@ -71,28 +70,8 @@ Emitted when switching to another tab. Emitted when a tab is selected, even if it is the current tab. -Member Variables ----------------- - - .. _class_TabContainer_current_tab: - -- :ref:`int` **current_tab** - The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. - - .. _class_TabContainer_drag_to_rearrange_enabled: - -- :ref:`bool` **drag_to_rearrange_enabled** - - .. _class_TabContainer_tab_align: - -- :ref:`TabAlign` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. - - .. _class_TabContainer_tabs_visible: - -- :ref:`bool` **tabs_visible** - If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. - - -Enums ------ +Enumerations +------------ .. _enum_TabContainer_TabAlign: @@ -108,26 +87,46 @@ Description Sets the active tab's ``visible`` property to the value ``true``. Sets all other children's to ``false``. -Ignores non-:ref:`Control` children. +Ignores non-:ref:`Control` children. Individual tabs are always visible unless you use :ref:`set_tab_disabled` and :ref:`set_tab_title` to hide it. -To hide only a tab's content, nest the content inside a child :ref:`Control`, so it receives the ``TabContainer``'s visibility setting instead. +To hide only a tab's content, nest the content inside a child :ref:`Control`, so it receives the ``TabContainer``'s visibility setting instead. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_TabContainer_current_tab: + +- :ref:`int` **current_tab** - The current tab index. When set, this index's :ref:`Control` node's ``visible`` property is set to ``true`` and all others are set to ``false``. + + .. _class_TabContainer_drag_to_rearrange_enabled: + +- :ref:`bool` **drag_to_rearrange_enabled** + + .. _class_TabContainer_tab_align: + +- :ref:`TabAlign` **tab_align** - The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. + + .. _class_TabContainer_tabs_visible: + +- :ref:`bool` **tabs_visible** - If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. + + +Method Descriptions +------------------- .. _class_TabContainer_get_current_tab_control: -- :ref:`Control` **get_current_tab_control** **(** **)** const +- :ref:`Control` **get_current_tab_control** **(** **)** const -Returns the child :ref:`Control` node located at the active tab index. +Returns the child :ref:`Control` node located at the active tab index. .. _class_TabContainer_get_popup: -- :ref:`Popup` **get_popup** **(** **)** const +- :ref:`Popup` **get_popup** **(** **)** const -Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. +Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. .. _class_TabContainer_get_previous_tab: @@ -137,9 +136,9 @@ Returns the previously active tab index. .. _class_TabContainer_get_tab_control: -- :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const +- :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const -Returns the currently visible tab's :ref:`Control` node. +Returns the currently visible tab's :ref:`Control` node. .. _class_TabContainer_get_tab_count: @@ -155,13 +154,13 @@ Returns ``true`` if the tab at index ``tab_idx`` is disabled. .. _class_TabContainer_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const -Returns the :ref:`Texture` for the tab at index ``tab_idx`` or null if the tab has no :ref:`Texture`. +Returns the :ref:`Texture` for the tab at index ``tab_idx`` or null if the tab has no :ref:`Texture`. .. _class_TabContainer_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const Returns the title of the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. @@ -171,9 +170,9 @@ Returns the title of the tab at index ``tab_idx``. Tab titles default to the nam .. _class_TabContainer_set_popup: -- void **set_popup** **(** :ref:`Node` popup **)** +- void **set_popup** **(** :ref:`Node` popup **)** -If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. +If set on a :ref:`Popup` node instance, a popup menu icon appears in the top-right corner of the ``TabContainer``. Clicking it will expand the :ref:`Popup` node. .. _class_TabContainer_set_tab_disabled: @@ -183,13 +182,13 @@ If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its titl .. _class_TabContainer_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** Sets an icon for the tab at index ``tab_idx``. .. _class_TabContainer_set_tab_title: -- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** Sets a title for the tab at index ``tab_idx``. Tab titles default to the name of the indexed child node, but this can be overridden with :ref:`set_tab_title`. diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 96e551b13..50c2d274f 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -7,8 +7,7 @@ Tabs ==== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description Tabs Control. -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | +| void | :ref:`add_tab` **(** :ref:`String` title="", :ref:`Texture` icon=null **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_tab_visible` **(** :ref:`int` idx **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ @@ -32,13 +31,13 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tab_disabled` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +| :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_offset` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +| :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tabs_rearrange_group` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ @@ -50,9 +49,9 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tab_disabled` **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +| void | :ref:`set_tab_icon` **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +| void | :ref:`set_tab_title` **(** :ref:`int` tab_idx, :ref:`String` title **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tabs_rearrange_group` **(** :ref:`int` group_id **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ @@ -85,32 +84,8 @@ Signals - **tab_hover** **(** :ref:`int` tab **)** -Member Variables ----------------- - - .. _class_Tabs_current_tab: - -- :ref:`int` **current_tab** - - .. _class_Tabs_drag_to_rearrange_enabled: - -- :ref:`bool` **drag_to_rearrange_enabled** - - .. _class_Tabs_scrolling_enabled: - -- :ref:`bool` **scrolling_enabled** - - .. _class_Tabs_tab_align: - -- :ref:`TabAlign` **tab_align** - - .. _class_Tabs_tab_close_display_policy: - -- :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** - - -Enums ------ +Enumerations +------------ .. _enum_Tabs_CloseButtonDisplayPolicy: @@ -134,14 +109,38 @@ enum **TabAlign** Description ----------- -Simple tabs control, similar to :ref:`TabContainer` but is only in charge of drawing tabs, not interact with children. +Simple tabs control, similar to :ref:`TabContainer` but is only in charge of drawing tabs, not interact with children. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Tabs_current_tab: + +- :ref:`int` **current_tab** + + .. _class_Tabs_drag_to_rearrange_enabled: + +- :ref:`bool` **drag_to_rearrange_enabled** + + .. _class_Tabs_scrolling_enabled: + +- :ref:`bool` **scrolling_enabled** + + .. _class_Tabs_tab_align: + +- :ref:`TabAlign` **tab_align** + + .. _class_Tabs_tab_close_display_policy: + +- :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** + + +Method Descriptions +------------------- .. _class_Tabs_add_tab: -- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** +- void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** .. _class_Tabs_ensure_tab_visible: @@ -165,7 +164,7 @@ Member Function Description .. _class_Tabs_get_tab_icon: -- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +- :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const .. _class_Tabs_get_tab_offset: @@ -173,13 +172,13 @@ Member Function Description .. _class_Tabs_get_tab_rect: -- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const +- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const -Returns tab :ref:`Rect2` with local position and size. +Returns tab :ref:`Rect2` with local position and size. .. _class_Tabs_get_tab_title: -- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +- :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const .. _class_Tabs_get_tabs_rearrange_group: @@ -205,11 +204,11 @@ Rearrange tab. .. _class_Tabs_set_tab_icon: -- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** +- void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** .. _class_Tabs_set_tab_title: -- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** +- void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** .. _class_Tabs_set_tabs_rearrange_group: diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index dd2267da7..724d436d1 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -7,8 +7,7 @@ TCP_Server ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,26 +15,26 @@ Brief Description TCP Server. -Member Functions ----------------- +Methods +------- +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connection_available` **(** **)** const | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`String` bind_address="*" **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | +| :ref:`StreamPeerTCP` | :ref:`take_connection` **(** **)** | +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Description ----------- -TCP Server class. Listens to connections on a port and returns a :ref:`StreamPeerTCP` when got a connection. +TCP Server class. Listens to connections on a port and returns a :ref:`StreamPeerTCP` when got a connection. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_TCP_Server_is_connection_available: @@ -45,7 +44,7 @@ Return true if a connection is available for taking. .. _class_TCP_Server_listen: -- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** +- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** Listen on the "port" binding to "bind_address". @@ -63,7 +62,7 @@ Stop listening. .. _class_TCP_Server_take_connection: -- :ref:`StreamPeerTCP` **take_connection** **(** **)** +- :ref:`StreamPeerTCP` **take_connection** **(** **)** If a connection is available, return a StreamPeerTCP with the connection/ diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 8e7e82f94..9ead4ac3d 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -7,8 +7,7 @@ TextEdit ======== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Multiline text editing control. -Member Functions ----------------- +Methods +------- +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | +| void | :ref:`add_color_region` **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | +| void | :ref:`add_keyword_color` **(** :ref:`String` keyword, :ref:`Color` color **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_fold` **(** :ref:`int` line **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -48,31 +47,31 @@ Member Functions +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fold_line` **(** :ref:`int` line **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | +| :ref:`Array` | :ref:`get_breakpoints` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | +| :ref:`Color` | :ref:`get_keyword_color` **(** :ref:`String` keyword **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | +| :ref:`String` | :ref:`get_line` **(** :ref:`int` line **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_line_count` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +| :ref:`PopupMenu` | :ref:`get_menu` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_from_column` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_from_line` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selection_text` **(** **)** const | +| :ref:`String` | :ref:`get_selection_text` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to_column` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selection_to_line` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | +| :ref:`String` | :ref:`get_word_under_cursor` **(** **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** const | +| :ref:`bool` | :ref:`has_keyword_color` **(** :ref:`String` keyword **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | +| void | :ref:`insert_text_at_cursor` **(** :ref:`String` text **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_folded` **(** :ref:`int` line **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -88,7 +87,7 @@ Member Functions +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_breakpoints` **(** **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | +| :ref:`PoolIntArray` | :ref:`search` **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -126,7 +125,7 @@ Emitted when the cursor changes. .. _class_TextEdit_symbol_lookup: -- **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** +- **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** .. _class_TextEdit_text_changed: @@ -135,8 +134,37 @@ Emitted when the cursor changes. Emitted when the text changes. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_TextEdit_MenuItems: + +enum **MenuItems** + +- **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. +- **MENU_COPY** = **1** --- Copies the selected text. +- **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position). +- **MENU_CLEAR** = **3** --- Erases the whole :ref:`TextEdit` text. +- **MENU_SELECT_ALL** = **4** --- Selects the whole :ref:`TextEdit` text. +- **MENU_UNDO** = **5** --- Undoes the previous action. +- **MENU_MAX** = **6** + + .. _enum_TextEdit_SearchFlags: + +enum **SearchFlags** + +- **SEARCH_MATCH_CASE** = **1** --- Match case when searching. +- **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching. +- **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. + + +Description +----------- + +TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo. + +Property Descriptions +--------------------- .. _class_TextEdit_breakpoint_gutter: @@ -200,7 +228,7 @@ If ``false`` the context menu disregards mouse location. .. _class_TextEdit_text: -- :ref:`String` **text** - String value of the :ref:`TextEdit`. +- :ref:`String` **text** - String value of the :ref:`TextEdit`. .. _class_TextEdit_v_scroll_speed: @@ -211,47 +239,18 @@ If ``false`` the context menu disregards mouse location. - :ref:`bool` **wrap_enabled** -Enums ------ - - .. _enum_TextEdit_MenuItems: - -enum **MenuItems** - -- **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text. -- **MENU_COPY** = **1** --- Copies the selected text. -- **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position). -- **MENU_CLEAR** = **3** --- Erases the whole :ref:`TextEdit` text. -- **MENU_SELECT_ALL** = **4** --- Selects the whole :ref:`TextEdit` text. -- **MENU_UNDO** = **5** --- Undoes the previous action. -- **MENU_MAX** = **6** - - .. _enum_TextEdit_SearchFlags: - -enum **SearchFlags** - -- **SEARCH_MATCH_CASE** = **1** --- Match case when searching. -- **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching. -- **SEARCH_BACKWARDS** = **4** --- Search from end to beginning. - - -Description ------------ - -TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_TextEdit_add_color_region: -- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** +- void **add_color_region** **(** :ref:`String` begin_key, :ref:`String` end_key, :ref:`Color` color, :ref:`bool` line_only=false **)** Add color region (given the delimiters) and its colors. .. _class_TextEdit_add_keyword_color: -- void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** +- void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** Add a keyword and its color. @@ -319,17 +318,17 @@ Clears the current selection. .. _class_TextEdit_get_breakpoints: -- :ref:`Array` **get_breakpoints** **(** **)** const +- :ref:`Array` **get_breakpoints** **(** **)** const Return an array containing the line number of each breakpoint. .. _class_TextEdit_get_keyword_color: -- :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const +- :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const .. _class_TextEdit_get_line: -- :ref:`String` **get_line** **(** :ref:`int` line **)** const +- :ref:`String` **get_line** **(** :ref:`int` line **)** const Return the text of a specific line. @@ -341,7 +340,7 @@ Return the amount of total lines in the text. .. _class_TextEdit_get_menu: -- :ref:`PopupMenu` **get_menu** **(** **)** const +- :ref:`PopupMenu` **get_menu** **(** **)** const .. _class_TextEdit_get_selection_from_column: @@ -357,7 +356,7 @@ Return the selection begin line. .. _class_TextEdit_get_selection_text: -- :ref:`String` **get_selection_text** **(** **)** const +- :ref:`String` **get_selection_text** **(** **)** const Return the text inside the selection. @@ -375,15 +374,15 @@ Return the selection end line. .. _class_TextEdit_get_word_under_cursor: -- :ref:`String` **get_word_under_cursor** **(** **)** const +- :ref:`String` **get_word_under_cursor** **(** **)** const .. _class_TextEdit_has_keyword_color: -- :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const +- :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const .. _class_TextEdit_insert_text_at_cursor: -- void **insert_text_at_cursor** **(** :ref:`String` text **)** +- void **insert_text_at_cursor** **(** :ref:`String` text **)** Insert a given text at the cursor position. @@ -425,7 +424,7 @@ Removes all the breakpoints (without firing "breakpoint_toggled" signal). .. _class_TextEdit_search: -- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const +- :ref:`PoolIntArray` **search** **(** :ref:`String` key, :ref:`int` flags, :ref:`int` from_line, :ref:`int` from_column **)** const Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum. diff --git a/classes/class_textfile.rst b/classes/class_textfile.rst index 088f5860b..6e508cb97 100644 --- a/classes/class_textfile.rst +++ b/classes/class_textfile.rst @@ -7,8 +7,7 @@ TextFile ======== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 19db5b93d..85a73e9cb 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -7,10 +7,8 @@ Texture ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`AnimatedTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`ProxyTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`AnimatedTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core Brief Description @@ -18,37 +16,29 @@ Brief Description Texture for 2D and 3D. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_data` **(** **)** const | +| :ref:`Image` | :ref:`get_data` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_alpha` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Texture_flags: - -- :ref:`int` **flags** - The texture's flags. - - -Enums ------ +Enumerations +------------ .. _enum_Texture_Flags: @@ -69,28 +59,36 @@ More effective on planes often shown going to the horrizon as those textures (Wa Description ----------- -A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. +A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D :ref:`Sprite` or GUI :ref:`Control`. Textures are often created by loading them from a file. See :ref:`@GDScript.load`. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Texture_flags: + +- :ref:`int` **flags** - The texture's flags. + + +Method Descriptions +------------------- .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect: -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect_region: -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null, :ref:`bool` clip_uv=true **)** const .. _class_Texture_get_data: -- :ref:`Image` **get_data** **(** **)** const +- :ref:`Image` **get_data** **(** **)** const .. _class_Texture_get_height: @@ -100,7 +98,7 @@ Return the texture height. .. _class_Texture_get_size: -- :ref:`Vector2` **get_size** **(** **)** const +- :ref:`Vector2` **get_size** **(** **)** const Return the texture size. diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 259c97ed9..244aee133 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -7,8 +7,7 @@ Texture3D ========= -**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_texturearray.rst b/classes/class_texturearray.rst index 23b974f10..bb694b048 100644 --- a/classes/class_texturearray.rst +++ b/classes/class_texturearray.rst @@ -7,8 +7,7 @@ TextureArray ============ -**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`TextureLayered` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index f504844e4..3b975482e 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -7,8 +7,7 @@ TextureButton ============= -**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,44 +15,8 @@ Brief Description Texture-based button. Supports Pressed, Hover, Disabled and Focused states. -Member Variables ----------------- - - .. _class_TextureButton_expand: - -- :ref:`bool` **expand** - If ``true`` the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false`` the texture will not scale with the node. Default value: ``false``. - - .. _class_TextureButton_stretch_mode: - -- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. - - .. _class_TextureButton_texture_click_mask: - -- :ref:`BitMap` **texture_click_mask** - Pure black and white Bitmap image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. - - .. _class_TextureButton_texture_disabled: - -- :ref:`Texture` **texture_disabled** - Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. - - .. _class_TextureButton_texture_focused: - -- :ref:`Texture` **texture_focused** - Texture to display when the node has mouse or keyboard focus. - - .. _class_TextureButton_texture_hover: - -- :ref:`Texture` **texture_hover** - Texture to display when the mouse hovers the node. - - .. _class_TextureButton_texture_normal: - -- :ref:`Texture` **texture_normal** - Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. - - .. _class_TextureButton_texture_pressed: - -- :ref:`Texture` **texture_pressed** - Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the :ref:`BaseButton.shortcut` key. - - -Enums ------ +Enumerations +------------ .. _enum_TextureButton_StretchMode: @@ -71,7 +34,43 @@ enum **StretchMode** Description ----------- -``TextureButton`` has the same functionality as :ref:`Button`, except it uses sprites instead of Godot's :ref:`Theme` resource. It is faster to create, but it doesn't support localization like more complex Controls. +``TextureButton`` has the same functionality as :ref:`Button`, except it uses sprites instead of Godot's :ref:`Theme` resource. It is faster to create, but it doesn't support localization like more complex Controls. The Normal state's texture is required. Others are optional. +Property Descriptions +--------------------- + + .. _class_TextureButton_expand: + +- :ref:`bool` **expand** - If ``true`` the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false`` the texture will not scale with the node. Default value: ``false``. + + .. _class_TextureButton_stretch_mode: + +- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle, **only if** :ref:`expand` is ``true``. Set it to one of the ``STRETCH_*`` constants. See the constants to learn more. + + .. _class_TextureButton_texture_click_mask: + +- :ref:`BitMap` **texture_click_mask** - Pure black and white Bitmap image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. + + .. _class_TextureButton_texture_disabled: + +- :ref:`Texture` **texture_disabled** - Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. + + .. _class_TextureButton_texture_focused: + +- :ref:`Texture` **texture_focused** - Texture to display when the node has mouse or keyboard focus. + + .. _class_TextureButton_texture_hover: + +- :ref:`Texture` **texture_hover** - Texture to display when the mouse hovers the node. + + .. _class_TextureButton_texture_normal: + +- :ref:`Texture` **texture_normal** - Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. + + .. _class_TextureButton_texture_pressed: + +- :ref:`Texture` **texture_pressed** - Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the enter key or if the player presses the :ref:`BaseButton.shortcut` key. + + diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 408fe0fbe..79c836a25 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -7,10 +7,8 @@ TextureLayered ============== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`TextureArray`, :ref:`Texture3D` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`TextureArray`, :ref:`Texture3D` **Category:** Core Brief Description @@ -18,41 +16,29 @@ Brief Description -Member Functions ----------------- +Methods +------- +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** | +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_depth` **(** **)** const | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`get_format` **(** **)** const | +| :ref:`Format` | :ref:`get_format` **(** **)** const | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_height` **(** **)** const | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | +| :ref:`Image` | :ref:`get_layer_data` **(** :ref:`int` layer **)** const | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_width` **(** **)** const | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_data_partial` **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** | +| void | :ref:`set_data_partial` **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | +| void | :ref:`set_layer_data` **(** :ref:`Image` image, :ref:`int` layer **)** | +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_TextureLayered_data: - -- :ref:`Dictionary` **data** - - .. _class_TextureLayered_flags: - -- :ref:`int` **flags** - - -Enums ------ +Enumerations +------------ .. _enum_TextureLayered_Flags: @@ -64,12 +50,24 @@ enum **Flags** - **FLAGS_DEFAULT** = **4** -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_TextureLayered_data: + +- :ref:`Dictionary` **data** + + .. _class_TextureLayered_flags: + +- :ref:`int` **flags** + + +Method Descriptions +------------------- .. _class_TextureLayered_create: -- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** .. _class_TextureLayered_get_depth: @@ -77,7 +75,7 @@ Member Function Description .. _class_TextureLayered_get_format: -- :ref:`Format` **get_format** **(** **)** const +- :ref:`Format` **get_format** **(** **)** const .. _class_TextureLayered_get_height: @@ -85,7 +83,7 @@ Member Function Description .. _class_TextureLayered_get_layer_data: -- :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const +- :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const .. _class_TextureLayered_get_width: @@ -93,10 +91,10 @@ Member Function Description .. _class_TextureLayered_set_data_partial: -- void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** +- void **set_data_partial** **(** :ref:`Image` image, :ref:`int` x_offset, :ref:`int` y_offset, :ref:`int` layer, :ref:`int` mipmap=0 **)** .. _class_TextureLayered_set_layer_data: -- void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** +- void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 4d51ef8c8..966115ced 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -7,8 +7,7 @@ TextureProgress =============== -**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,31 @@ Brief Description Texture-based progress bar. Useful for loading screens and life or stamina bars. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_TextureProgress_FillMode: + +enum **FillMode** + +- **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress` fills from left to right. +- **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress` fills from right to left. +- **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress` fills from top to bototm. +- **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. +- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. +- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. +- **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** +- **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** +- **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** + + +Description +----------- + +TextureProgress works like :ref:`ProgressBar` but it uses up to 3 textures instead of Godot's :ref:`Theme` resource. Works horizontally, vertically, and radially. + +Property Descriptions +--------------------- .. _class_TextureProgress_fill_mode: @@ -25,11 +47,11 @@ Member Variables .. _class_TextureProgress_nine_patch_stretch: -- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. +- :ref:`bool` **nine_patch_stretch** - If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. .. _class_TextureProgress_radial_center_offset: -- :ref:`Vector2` **radial_center_offset** - Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. +- :ref:`Vector2` **radial_center_offset** - Offsets :ref:`texture_progress` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. .. _class_TextureProgress_radial_fill_degrees: @@ -59,51 +81,28 @@ See :ref:`Range.value`, :ref:`Range.max_value` **texture_over** - :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. +- :ref:`Texture` **texture_over** - :ref:`Texture` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress`. .. _class_TextureProgress_texture_progress: -- :ref:`Texture` **texture_progress** - :ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. +- :ref:`Texture` **texture_progress** - :ref:`Texture` that clips based on the node's ``value`` and :ref:`fill_mode`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``. -The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. +The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. .. _class_TextureProgress_texture_under: -- :ref:`Texture` **texture_under** - :ref:`Texture` that draws under the progress bar. The bar's background. +- :ref:`Texture` **texture_under** - :ref:`Texture` that draws under the progress bar. The bar's background. .. _class_TextureProgress_tint_over: -- :ref:`Color` **tint_over** +- :ref:`Color` **tint_over** .. _class_TextureProgress_tint_progress: -- :ref:`Color` **tint_progress** +- :ref:`Color` **tint_progress** .. _class_TextureProgress_tint_under: -- :ref:`Color` **tint_under** +- :ref:`Color` **tint_under** -Enums ------ - - .. _enum_TextureProgress_FillMode: - -enum **FillMode** - -- **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress` fills from left to right. -- **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress` fills from right to left. -- **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress` fills from top to bototm. -- **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress` fills from bottom to top. -- **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress` fills clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. -- **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress` fills counter-clockwise. See :ref:`radial_center_offset`, :ref:`radial_initial_angle` and :ref:`radial_fill_degrees` to refine its behavior. -- **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** -- **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** -- **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** - - -Description ------------ - -TextureProgress works like :ref:`ProgressBar` but it uses up to 3 textures instead of Godot's :ref:`Theme` resource. Works horizontally, vertically, and radially. - diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index c5930fc86..83548e8f7 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -7,8 +7,7 @@ TextureRect =========== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,8 @@ Brief Description Control for drawing textures. -Member Variables ----------------- - - .. _class_TextureRect_expand: - -- :ref:`bool` **expand** - If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. - - .. _class_TextureRect_stretch_mode: - -- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. - - .. _class_TextureRect_texture: - -- :ref:`Texture` **texture** - The node's :ref:`Texture` resource. - - -Enums ------ +Enumerations +------------ .. _enum_TextureRect_StretchMode: @@ -54,3 +37,19 @@ Description Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the :ref:`stretch_mode` property. It can scale, tile, or stay centered inside its bounding rectangle. +Property Descriptions +--------------------- + + .. _class_TextureRect_expand: + +- :ref:`bool` **expand** - If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. + + .. _class_TextureRect_stretch_mode: + +- :ref:`StretchMode` **stretch_mode** - Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. + + .. _class_TextureRect_texture: + +- :ref:`Texture` **texture** - The node's :ref:`Texture` resource. + + diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 186706b6a..88a4a12d6 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -7,8 +7,7 @@ Theme ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,114 +15,114 @@ Brief Description Theme for controls. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | +| void | :ref:`clear_color` **(** :ref:`String` name, :ref:`String` type **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | +| void | :ref:`clear_constant` **(** :ref:`String` name, :ref:`String` type **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | +| void | :ref:`clear_font` **(** :ref:`String` name, :ref:`String` type **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | +| void | :ref:`clear_icon` **(** :ref:`String` name, :ref:`String` type **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | +| void | :ref:`clear_stylebox` **(** :ref:`String` name, :ref:`String` type **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`copy_default_theme` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Color` | :ref:`get_color` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_color_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_constant_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_font_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_icon_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`StyleBox` | :ref:`get_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_stylebox_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_stylebox_types` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | +| :ref:`PoolStringArray` | :ref:`get_type_list` **(** :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_color` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_constant` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_font` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_icon` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +| :ref:`bool` | :ref:`has_stylebox` **(** :ref:`String` name, :ref:`String` type **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | +| void | :ref:`set_color` **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | +| void | :ref:`set_constant` **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | +| void | :ref:`set_font` **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | +| void | :ref:`set_icon` **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | +| void | :ref:`set_stylebox` **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Theme_default_font: - -- :ref:`Font` **default_font** - The theme's default font. - - Description ----------- -Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any :ref:`Control`, and it and its children will automatically use it. +Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any :ref:`Control`, and it and its children will automatically use it. Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Theme_default_font: + +- :ref:`Font` **default_font** - The theme's default font. + + +Method Descriptions +------------------- .. _class_Theme_clear_color: -- void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** -Clears theme :ref:`Color` at ``name`` if Theme has ``type``. +Clears theme :ref:`Color` at ``name`` if Theme has ``type``. .. _class_Theme_clear_constant: -- void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** Clears theme constant at ``name`` if Theme has ``type``. .. _class_Theme_clear_font: -- void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** -Clears :ref:`Font` at ``name`` if Theme has ``type``. +Clears :ref:`Font` at ``name`` if Theme has ``type``. .. _class_Theme_clear_icon: -- void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** Clears icon at ``name`` if Theme has ``type``. .. _class_Theme_clear_stylebox: -- void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** +- void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** -Clears :ref:`StyleBox` at ``name`` if Theme has ``type``. +Clears :ref:`StyleBox` at ``name`` if Theme has ``type``. .. _class_Theme_copy_default_theme: @@ -133,87 +132,87 @@ Sets theme values to a copy of the default theme values. .. _class_Theme_get_color: -- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const -Returns the :ref:`Color` at ``name`` if Theme has ``type``. +Returns the :ref:`Color` at ``name`` if Theme has ``type``. .. _class_Theme_get_color_list: -- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_color_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if Theme has ``type``. +Returns all of the :ref:`Color`\ s as a :ref:`PoolStringArray` filled with each :ref:`Color`'s name, for use in :ref:`get_color`, if Theme has ``type``. .. _class_Theme_get_constant: -- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type **)** const Returns the constant at ``name`` if Theme has ``type``. .. _class_Theme_get_constant_list: -- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_constant_list** **(** :ref:`String` type **)** const -Returns all of the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if Theme has ``type``. +Returns all of the constants as a :ref:`PoolStringArray` filled with each constant's name, for use in :ref:`get_constant`, if Theme has ``type``. .. _class_Theme_get_font: -- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const -Returns the :ref:`Font` at ``name`` if Theme has ``type``. +Returns the :ref:`Font` at ``name`` if Theme has ``type``. .. _class_Theme_get_font_list: -- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_font_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if Theme has ``type``. +Returns all of the :ref:`Font`\ s as a :ref:`PoolStringArray` filled with each :ref:`Font`'s name, for use in :ref:`get_font`, if Theme has ``type``. .. _class_Theme_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const -Returns the icon :ref:`Texture` at ``name`` if Theme has ``type``. +Returns the icon :ref:`Texture` at ``name`` if Theme has ``type``. .. _class_Theme_get_icon_list: -- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_icon_list** **(** :ref:`String` type **)** const -Returns all of the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if Theme has ``type``. +Returns all of the icons as a :ref:`PoolStringArray` filled with each :ref:`Texture`'s name, for use in :ref:`get_icon`, if Theme has ``type``. .. _class_Theme_get_stylebox: -- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const -Returns the icon :ref:`StyleBox` at ``name`` if Theme has ``type``. +Returns the icon :ref:`StyleBox` at ``name`` if Theme has ``type``. .. _class_Theme_get_stylebox_list: -- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_stylebox_list** **(** :ref:`String` type **)** const -Returns all of the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if Theme has ``type``. +Returns all of the :ref:`StyleBox`\ s as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s name, for use in :ref:`get_stylebox`, if Theme has ``type``. .. _class_Theme_get_stylebox_types: -- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const +- :ref:`PoolStringArray` **get_stylebox_types** **(** **)** const -Returns all of the :ref:`StyleBox` types as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if Theme has ``type``. +Returns all of the :ref:`StyleBox` types as a :ref:`PoolStringArray` filled with each :ref:`StyleBox`'s type, for use in :ref:`get_stylebox` and/or :ref:`get_stylebox_list`, if Theme has ``type``. .. _class_Theme_get_type_list: -- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const +- :ref:`PoolStringArray` **get_type_list** **(** :ref:`String` type **)** const -Returns all of the types in ``type`` as a :ref:`PoolStringArray` for use in any of the get\_\* functions, if Theme has ``type``. +Returns all of the types in ``type`` as a :ref:`PoolStringArray` for use in any of the get\_\* functions, if Theme has ``type``. .. _class_Theme_has_color: -- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const -Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. +Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. .. _class_Theme_has_constant: -- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const Returns ``true`` if constant with ``name`` is in ``type``. @@ -221,39 +220,39 @@ Returns ``false`` if Theme does not have ``type``. .. _class_Theme_has_font: -- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const -Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. +Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. .. _class_Theme_has_icon: -- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const -Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``type``. +Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. .. _class_Theme_has_stylebox: -- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const +- :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const -Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type``. +Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. .. _class_Theme_set_color: -- void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** +- void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** -Sets Theme's :ref:`Color` to ``color`` at ``name`` in ``type``. +Sets Theme's :ref:`Color` to ``color`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. .. _class_Theme_set_constant: -- void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** +- void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** Sets Theme's constant to ``constant`` at ``name`` in ``type``. @@ -261,25 +260,25 @@ Does nothing if Theme does not have ``type``. .. _class_Theme_set_font: -- void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** +- void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** -Sets Theme's :ref:`Font` to ``font`` at ``name`` in ``type``. +Sets Theme's :ref:`Font` to ``font`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. .. _class_Theme_set_icon: -- void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** -Sets Theme's icon :ref:`Texture` to ``texture`` at ``name`` in ``type``. +Sets Theme's icon :ref:`Texture` to ``texture`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. .. _class_Theme_set_stylebox: -- void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** +- void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** -Sets Theme's :ref:`StyleBox` to ``stylebox`` at ``name`` in ``type``. +Sets Theme's :ref:`StyleBox` to ``stylebox`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 853234a5d..5851fcf9a 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -7,8 +7,7 @@ Thread ====== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,21 +15,21 @@ Brief Description A unit of execution in a process. -Member Functions ----------------- +Methods +------- +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | +| :ref:`String` | :ref:`get_id` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | +| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_Thread_Priority: @@ -44,14 +43,14 @@ enum **Priority** Description ----------- -A unit of execution in a process. Can run methods on :ref:`Object`\ s simultaneously. The use of synchronization via :ref:`Mutex`, :ref:`Semaphore` is advised if working with shared objects. +A unit of execution in a process. Can run methods on :ref:`Object`\ s simultaneously. The use of synchronization via :ref:`Mutex`, :ref:`Semaphore` is advised if working with shared objects. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Thread_get_id: -- :ref:`String` **get_id** **(** **)** const +- :ref:`String` **get_id** **(** **)** const Returns the current ``Thread``\ s id, uniquely identifying it among all threads. @@ -63,7 +62,7 @@ Returns true if this ``Thread`` is currently active. An active ``Thread`` cannot .. _class_Thread_start: -- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** +- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** Starts a new ``Thread`` that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the ``Thread`` can be changed by passing a PRIORITY\_\* enum. @@ -71,7 +70,7 @@ Returns OK on success, or ERR_CANT_CREATE on failure. .. _class_Thread_wait_to_finish: -- :ref:`Variant` **wait_to_finish** **(** **)** +- :ref:`Variant` **wait_to_finish** **(** **)** Joins the ``Thread`` and waits for it to finish. Returns what the method called returned. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index d4fd82798..3a81f30b7 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -7,8 +7,7 @@ TileMap ======= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Node for 2D tile-based maps. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | @@ -26,17 +25,17 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +| :ref:`Array` | :ref:`get_used_cells` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | +| :ref:`Array` | :ref:`get_used_cells_by_id` **(** :ref:`int` id **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_cell_transposed` **(** :ref:`int` x, :ref:`int` y **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -44,25 +43,23 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_cell_y_flipped` **(** :ref:`int` x, :ref:`int` y **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +| void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_celld` **(** :ref:`Vector2` position, :ref:`Dictionary` data **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_bitmask_area` **(** :ref:`Vector2` position **)** | +| void | :ref:`update_bitmask_area` **(** :ref:`Vector2` position **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_bitmask_region` **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** | +| void | :ref:`update_bitmask_region` **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_dirty_quadrants` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -75,8 +72,51 @@ Signals Emitted when a tilemap setting has changed. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_TileMap_HalfOffset: + +enum **HalfOffset** + +- **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. +- **HALF_OFFSET_Y** = **1** --- Half offset on the Y coordinate. +- **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled. + + .. _enum_TileMap_TileOrigin: + +enum **TileOrigin** + +- **TILE_ORIGIN_TOP_LEFT** = **0** --- Tile origin at its top-left corner. +- **TILE_ORIGIN_CENTER** = **1** --- Tile origin at its center. +- **TILE_ORIGIN_BOTTOM_LEFT** = **2** --- Tile origin at its bottom-left corner. + + .. _enum_TileMap_Mode: + +enum **Mode** + +- **MODE_SQUARE** = **0** --- Orthogonal orientation mode. +- **MODE_ISOMETRIC** = **1** --- Isometric orientation mode. +- **MODE_CUSTOM** = **2** --- Custom orientation mode. + + +Constants +--------- + +- **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist. + +Description +----------- + +Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet` which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. + +Tutorials +--------- + +- :doc:`../tutorials/2d/using_tilemaps` + +Property Descriptions +--------------------- .. _class_TileMap_cell_clip_uv: @@ -84,11 +124,11 @@ Member Variables .. _class_TileMap_cell_custom_transform: -- :ref:`Transform2D` **cell_custom_transform** - The custom :ref:`Transform2D` to be applied to the TileMap's cells. +- :ref:`Transform2D` **cell_custom_transform** - The custom :ref:`Transform2D` to be applied to the TileMap's cells. .. _class_TileMap_cell_half_offset: -- :ref:`HalfOffset` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. +- :ref:`HalfOffset` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. .. _class_TileMap_cell_quadrant_size: @@ -96,11 +136,11 @@ Member Variables .. _class_TileMap_cell_size: -- :ref:`Vector2` **cell_size** - The TileMap's cell size. +- :ref:`Vector2` **cell_size** - The TileMap's cell size. .. _class_TileMap_cell_tile_origin: -- :ref:`TileOrigin` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. +- :ref:`TileOrigin` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. .. _class_TileMap_cell_y_sort: @@ -128,7 +168,7 @@ Member Variables .. _class_TileMap_mode: -- :ref:`Mode` **mode** - The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. +- :ref:`Mode` **mode** - The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. .. _class_TileMap_occluder_light_mask: @@ -136,54 +176,11 @@ Member Variables .. _class_TileMap_tile_set: -- :ref:`TileSet` **tile_set** - The assigned :ref:`TileSet`. +- :ref:`TileSet` **tile_set** - The assigned :ref:`TileSet`. -Numeric Constants ------------------ - -- **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist. - -Enums ------ - - .. _enum_TileMap_HalfOffset: - -enum **HalfOffset** - -- **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. -- **HALF_OFFSET_Y** = **1** --- Half offset on the Y coordinate. -- **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled. - - .. _enum_TileMap_TileOrigin: - -enum **TileOrigin** - -- **TILE_ORIGIN_TOP_LEFT** = **0** --- Tile origin at its top-left corner. -- **TILE_ORIGIN_CENTER** = **1** --- Tile origin at its center. -- **TILE_ORIGIN_BOTTOM_LEFT** = **2** --- Tile origin at its bottom-left corner. - - .. _enum_TileMap_Mode: - -enum **Mode** - -- **MODE_SQUARE** = **0** --- Orthogonal orientation mode. -- **MODE_ISOMETRIC** = **1** --- Isometric orientation mode. -- **MODE_CUSTOM** = **2** --- Custom orientation mode. - - -Description ------------ - -Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet` which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. - -Tutorials ---------- - -- :doc:`../tutorials/2d/using_tilemaps` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_TileMap_clear: @@ -205,7 +202,7 @@ Returns the tile index of the given cell. .. _class_TileMap_get_cellv: -- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Returns the tile index of the cell given by a Vector2. @@ -223,19 +220,19 @@ Returns ``true`` if the given collision mask bit is set. .. _class_TileMap_get_used_cells: -- :ref:`Array` **get_used_cells** **(** **)** const +- :ref:`Array` **get_used_cells** **(** **)** const -Returns a :ref:`Vector2` array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). +Returns a :ref:`Vector2` array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from ``-1``). .. _class_TileMap_get_used_cells_by_id: -- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const +- :ref:`Array` **get_used_cells_by_id** **(** :ref:`int` id **)** const Returns an array of all cells with the given tile id. .. _class_TileMap_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** +- :ref:`Rect2` **get_used_rect** **(** **)** Returns a rectangle enclosing the used (non-empty) tiles of the map. @@ -259,7 +256,7 @@ Returns ``true`` if the given cell is flipped in the y axis. .. _class_TileMap_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const Returns the global position corresponding to the given tilemap (grid-based) coordinates. @@ -267,7 +264,7 @@ Optionally, the tilemap's half offset can be ignored. .. _class_TileMap_set_cell: -- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** +- void **set_cell** **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** Sets the tile index for the cell given by a Vector2. @@ -279,13 +276,9 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. -.. _class_TileMap_set_celld: - -- void **set_celld** **(** :ref:`Vector2` position, :ref:`Dictionary` data **)** - .. _class_TileMap_set_cellv: -- void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Sets the tile index for the given cell. @@ -311,13 +304,13 @@ Sets the given collision mask bit. .. _class_TileMap_update_bitmask_area: -- void **update_bitmask_area** **(** :ref:`Vector2` position **)** +- void **update_bitmask_area** **(** :ref:`Vector2` position **)** Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates. .. _class_TileMap_update_bitmask_region: -- void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** +- void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** Applies autotiling rules to the cells in the given region (specified by grid-based x and y coordinates). @@ -331,7 +324,7 @@ Updates the tile map's quadrants, allowing things such as navigation and collisi .. _class_TileMap_world_to_map: -- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const +- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const Returns the tilemap (grid-based) coordinatescorresponding to the given global position. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 77b47c739..20b043d7a 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -7,8 +7,7 @@ TileSet ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,105 +15,113 @@ Brief Description Tile library for tilemaps. -Member Functions ----------------- +Methods +------- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual | +| :ref:`Vector2` | :ref:`_forward_subtile_selection` **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_tile_bound` **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** const | +| :ref:`BitmaskMode` | :ref:`autotile_get_bitmask_mode` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | +| :ref:`Vector2` | :ref:`autotile_get_size` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_bitmask_mode` **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`autotile_set_size` **(** :ref:`int` id, :ref:`Vector2` size **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_tile` **(** :ref:`int` id **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tile` **(** :ref:`int` id **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | +| :ref:`Color` | :ref:`tile_get_modulate` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :ref:`int` id **)** const | +| :ref:`TileMode` | :ref:`tile_get_tile_mode` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`tile_get_z_index` **(** :ref:`int` id **)** const | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | +| void | :ref:`tile_set_modulate` **(** :ref:`int` id, :ref:`Color` color **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_tile_mode` **(** :ref:`int` id, :ref:`TileMode` tilemode **)** | +| void | :ref:`tile_set_tile_mode` **(** :ref:`int` id, :ref:`TileMode` tilemode **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`tile_set_z_index` **(** :ref:`int` id, :ref:`int` z_index **)** | +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_TileSet_BitmaskMode: @@ -149,16 +156,16 @@ enum **AutotileBindings** Description ----------- -A TileSet is a library of tiles for a :ref:`TileMap`. It contains a list of tiles, each consisting of a sprite and optional collision shapes. +A TileSet is a library of tiles for a :ref:`TileMap`. It contains a list of tiles, each consisting of a sprite and optional collision shapes. Tiles are referenced by a unique integer ID. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_TileSet__forward_subtile_selection: -- :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual +- :ref:`Vector2` **_forward_subtile_selection** **(** :ref:`int` autotile_id, :ref:`int` bitmask, :ref:`Object` tilemap, :ref:`Vector2` tile_location **)** virtual .. _class_TileSet__is_tile_bound: @@ -166,11 +173,19 @@ Member Function Description .. _class_TileSet_autotile_get_bitmask_mode: -- :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const +- :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const + +.. _class_TileSet_autotile_get_size: + +- :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const .. _class_TileSet_autotile_set_bitmask_mode: -- void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** +- void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** + +.. _class_TileSet_autotile_set_size: + +- void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** .. _class_TileSet_clear: @@ -186,7 +201,7 @@ Creates a new tile which will be referenced by the given ID. .. _class_TileSet_find_tile_by_name: -- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const +- :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const Returns the first tile matching the given name. @@ -198,7 +213,7 @@ Returns the ID following the last currently used ID, useful when creating a new .. _class_TileSet_get_tiles_ids: -- :ref:`Array` **get_tiles_ids** **(** **)** const +- :ref:`Array` **get_tiles_ids** **(** **)** const Returns an array of all currently used tile IDs. @@ -210,95 +225,99 @@ Removes the tile referenced by the given ID. .. _class_TileSet_tile_add_shape: -- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false, :ref:`Vector2` autotile_coord=Vector2( 0, 0 ) **)** .. _class_TileSet_tile_get_light_occluder: -- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const +- :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Returns the light occluder of the tile. .. _class_TileSet_tile_get_material: -- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const +- :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Returns the material of the tile. .. _class_TileSet_tile_get_modulate: -- :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const +- :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_name: -- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const +- :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Returns the name of the tile. .. _class_TileSet_tile_get_navigation_polygon: -- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const +- :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const Returns the navigation polygon of the tile. .. _class_TileSet_tile_get_navigation_polygon_offset: -- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_navigation_polygon_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's navigation polygon. .. _class_TileSet_tile_get_normal_map: -- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_occluder_offset: -- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's light occluder. .. _class_TileSet_tile_get_region: -- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const +- :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const Returns the tile sub-region in the texture. .. _class_TileSet_tile_get_shape: -- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shape_count: - :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const +.. _class_TileSet_tile_get_shape_offset: + +- :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id **)** const + .. _class_TileSet_tile_get_shape_one_way: - :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shape_transform: -- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const +- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shapes: -- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const +- :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Returns the array of shapes of the tile. .. _class_TileSet_tile_get_texture: -- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const +- :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Returns the texture of the tile. .. _class_TileSet_tile_get_texture_offset: -- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const +- :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const Returns the texture offset of the tile. .. _class_TileSet_tile_get_tile_mode: -- :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const +- :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const .. _class_TileSet_tile_get_z_index: @@ -306,61 +325,65 @@ Returns the texture offset of the tile. .. _class_TileSet_tile_set_light_occluder: -- void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** +- void **tile_set_light_occluder** **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** Sets a light occluder for the tile. .. _class_TileSet_tile_set_material: -- void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** +- void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Sets the tile's material. .. _class_TileSet_tile_set_modulate: -- void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** +- void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** Sets the tile's modulation color. .. _class_TileSet_tile_set_name: -- void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** +- void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Sets the tile's name. .. _class_TileSet_tile_set_navigation_polygon: -- void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** +- void **tile_set_navigation_polygon** **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** Sets the tile's navigation polygon. .. _class_TileSet_tile_set_navigation_polygon_offset: -- void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** +- void **tile_set_navigation_polygon_offset** **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** Sets an offset for the tile's navigation polygon. .. _class_TileSet_tile_set_normal_map: -- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** +- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** Sets the tile's normal map texture. .. _class_TileSet_tile_set_occluder_offset: -- void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** +- void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** Set an offset for the tile's light occluder. .. _class_TileSet_tile_set_region: -- void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** +- void **tile_set_region** **(** :ref:`int` id, :ref:`Rect2` region **)** Set the tile's sub-region in the texture. This is common in texture atlases. .. _class_TileSet_tile_set_shape: -- void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** +- void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** + +.. _class_TileSet_tile_set_shape_offset: + +- void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Vector2` shape_offset **)** .. _class_TileSet_tile_set_shape_one_way: @@ -368,31 +391,31 @@ Set the tile's sub-region in the texture. This is common in texture atlases. .. _class_TileSet_tile_set_shape_transform: -- void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** +- void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** .. _class_TileSet_tile_set_shapes: -- void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** +- void **tile_set_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** Sets an array of shapes for the tile, enabling collision. .. _class_TileSet_tile_set_texture: -- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** +- void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Sets the tile's texture. .. _class_TileSet_tile_set_texture_offset: -- void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** +- void **tile_set_texture_offset** **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** Sets the tile's texture offset. .. _class_TileSet_tile_set_tile_mode: -- void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** +- void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** -Sets the tile's :ref:`TileMode`. +Sets the tile's :ref:`TileMode`. .. _class_TileSet_tile_set_z_index: diff --git a/classes/class_timer.rst b/classes/class_timer.rst index fea058b29..2c6da7290 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -7,8 +7,7 @@ Timer ===== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description A countdown timer. -Member Functions ----------------- +Methods +------- +--------------------------+-----------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_stopped` **(** **)** const | @@ -37,8 +36,24 @@ Signals Emitted when the Timer reaches 0. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Timer_TimerProcessMode: + +enum **TimerProcessMode** + +- **TIMER_PROCESS_PHYSICS** = **0** --- Update the Timer during the physics step at each frame (fixed framerate processing). +- **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame. + + +Description +----------- + +Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode. + +Property Descriptions +--------------------- .. _class_Timer_autostart: @@ -54,7 +69,7 @@ Member Variables .. _class_Timer_process_mode: -- :ref:`TimerProcessMode` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value. +- :ref:`TimerProcessMode` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value. .. _class_Timer_time_left: @@ -65,24 +80,8 @@ Member Variables - :ref:`float` **wait_time** - Wait time in seconds. -Enums ------ - - .. _enum_Timer_TimerProcessMode: - -enum **TimerProcessMode** - -- **TIMER_PROCESS_PHYSICS** = **0** --- Update the Timer during the physics step at each frame (fixed framerate processing). -- **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame. - - -Description ------------ - -Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Timer_is_stopped: diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index ecca850a6..65c21889b 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -7,8 +7,7 @@ ToolButton ========== -**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Button` **<** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,7 +18,7 @@ Flat button helper class. Description ----------- -This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: +This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: :: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 7a08b5733..a139a1b43 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -7,8 +7,7 @@ TouchScreenButton ================= -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Button for touch screen devices. -Member Functions ----------------- +Methods +------- +--------------------------+-------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pressed` **(** **)** const | @@ -39,48 +38,8 @@ Emitted when the button is pressed (down). Emitted when the button is released (up). -Member Variables ----------------- - - .. _class_TouchScreenButton_action: - -- :ref:`String` **action** - The button's action. Actions can be handled with :ref:`InputEventAction`. - - .. _class_TouchScreenButton_bitmask: - -- :ref:`BitMap` **bitmask** - The button's bitmask. - - .. _class_TouchScreenButton_normal: - -- :ref:`Texture` **normal** - The button's texture for the normal state. - - .. _class_TouchScreenButton_passby_press: - -- :ref:`bool` **passby_press** - If ``true`` passby presses are enabled. - - .. _class_TouchScreenButton_pressed: - -- :ref:`Texture` **pressed** - The button's texture for the pressed state. - - .. _class_TouchScreenButton_shape: - -- :ref:`Shape2D` **shape** - The button's shape. - - .. _class_TouchScreenButton_shape_centered: - -- :ref:`bool` **shape_centered** - If ``true`` the button's shape is centered. - - .. _class_TouchScreenButton_shape_visible: - -- :ref:`bool` **shape_visible** - If ``true`` the button's shape is visible. - - .. _class_TouchScreenButton_visibility_mode: - -- :ref:`VisibilityMode` **visibility_mode** - The button's visibility mode. See ``VISIBILITY_*`` constants. - - -Enums ------ +Enumerations +------------ .. _enum_TouchScreenButton_VisibilityMode: @@ -95,8 +54,48 @@ Description Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_TouchScreenButton_action: + +- :ref:`String` **action** - The button's action. Actions can be handled with :ref:`InputEventAction`. + + .. _class_TouchScreenButton_bitmask: + +- :ref:`BitMap` **bitmask** - The button's bitmask. + + .. _class_TouchScreenButton_normal: + +- :ref:`Texture` **normal** - The button's texture for the normal state. + + .. _class_TouchScreenButton_passby_press: + +- :ref:`bool` **passby_press** - If ``true`` passby presses are enabled. + + .. _class_TouchScreenButton_pressed: + +- :ref:`Texture` **pressed** - The button's texture for the pressed state. + + .. _class_TouchScreenButton_shape: + +- :ref:`Shape2D` **shape** - The button's shape. + + .. _class_TouchScreenButton_shape_centered: + +- :ref:`bool` **shape_centered** - If ``true`` the button's shape is centered. + + .. _class_TouchScreenButton_shape_visible: + +- :ref:`bool` **shape_visible** - If ``true`` the button's shape is visible. + + .. _class_TouchScreenButton_visibility_mode: + +- :ref:`VisibilityMode` **visibility_mode** - The button's visibility mode. See ``VISIBILITY_*`` constants. + + +Method Descriptions +------------------- .. _class_TouchScreenButton_is_pressed: diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 8491790ce..3dd1aa025 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -14,55 +14,43 @@ Brief Description 3D Transformation. 3x4 matrix. -Member Functions ----------------- +Methods +------- +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Transform2D` from **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Quat` from **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | +| :ref:`Transform` | :ref:`Transform` **(** :ref:`Basis` from **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | +| :ref:`Transform` | :ref:`affine_inverse` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | +| :ref:`Transform` | :ref:`interpolate_with` **(** :ref:`Transform` transform, :ref:`float` weight **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`inverse` **(** **)** | +| :ref:`Transform` | :ref:`inverse` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +| :ref:`Transform` | :ref:`looking_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | +| :ref:`Transform` | :ref:`orthonormalized` **(** **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +| :ref:`Transform` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +| :ref:`Transform` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | +| :ref:`Transform` | :ref:`translated` **(** :ref:`Vector3` ofs **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform` **(** var v **)** | +| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform_inv` **(** var v **)** | +| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Transform_basis: - -- :ref:`Basis` **basis** - The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - - .. _class_Transform_origin: - -- :ref:`Vector3` **origin** - The translation offset of the transform. - - -Numeric Constants ------------------ +Constants +--------- - **IDENTITY** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** @@ -72,7 +60,7 @@ Numeric Constants Description ----------- -Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a :ref:`Basis` "basis" and an :ref:`Vector3` "origin". It is similar to a 3x4 matrix. +Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a :ref:`Basis` "basis" and an :ref:`Vector3` "origin". It is similar to a 3x4 matrix. Tutorials --------- @@ -80,60 +68,72 @@ Tutorials - :doc:`../tutorials/math/index` - :doc:`../tutorials/3d/using_transforms` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Transform_basis: + +- :ref:`Basis` **basis** - The basis is a matrix containing 3 :ref:`Vector3` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + .. _class_Transform_origin: + +- :ref:`Vector3` **origin** - The translation offset of the transform. + + +Method Descriptions +------------------- .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** +- :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** -Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). +Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** -Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. +Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** -Constructs the Transform from a :ref:`Transform2D`. +Constructs the Transform from a :ref:`Transform2D`. .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** -Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). +Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). .. _class_Transform_Transform: -- :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** +- :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** -Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). +Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). .. _class_Transform_affine_inverse: -- :ref:`Transform` **affine_inverse** **(** **)** +- :ref:`Transform` **affine_inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. .. _class_Transform_interpolate_with: -- :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** +- :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** Interpolates the transform to other Transform by weight amount (0-1). .. _class_Transform_inverse: -- :ref:`Transform` **inverse** **(** **)** +- :ref:`Transform` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). .. _class_Transform_looking_at: -- :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** +- :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** Returns a copy of the transform rotated such that its -Z axis points towards the ``target`` position. @@ -143,38 +143,38 @@ Operations take place in global space. .. _class_Transform_orthonormalized: -- :ref:`Transform` **orthonormalized** **(** **)** +- :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. .. _class_Transform_rotated: -- :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the transform around given axis by phi. The axis must be a normalized vector. .. _class_Transform_scaled: -- :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** +- :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. .. _class_Transform_translated: -- :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** +- :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. .. _class_Transform_xform: -- var **xform** **(** var v **)** +- :ref:`Variant` **xform** **(** :ref:`Variant` v **)** -Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. +Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. .. _class_Transform_xform_inv: -- var **xform_inv** **(** var v **)** +- :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** -Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. +Inverse-transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 1f7b58f7c..d68574f5a 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -14,63 +14,47 @@ Brief Description 2D Transformation. 3x2 matrix. -Member Functions ----------------- +Methods +------- +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | +| :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | +| :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | +| :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_origin` **(** **)** | +| :ref:`Vector2` | :ref:`get_origin` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scale` **(** **)** | +| :ref:`Vector2` | :ref:`get_scale` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | +| :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`inverse` **(** **)** | +| :ref:`Transform2D` | :ref:`inverse` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | +| :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | +| :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` phi **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | +| :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | +| :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform` **(** var v **)** | +| :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| var | :ref:`xform_inv` **(** var v **)** | +| :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Transform2D_origin: - -- :ref:`Vector2` **origin** - The transform's translation offset. - - .. _class_Transform2D_x: - -- :ref:`Vector2` **x** - The X axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - - .. _class_Transform2D_y: - -- :ref:`Vector2` **y** - The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. - - -Numeric Constants ------------------ +Constants +--------- - **IDENTITY** = **Transform2D( 1, 0, 0, 1, 0, 0 )** - **FLIP_X** = **Transform2D( -1, 0, 0, 1, 0, 0 )** @@ -79,50 +63,66 @@ Numeric Constants Description ----------- -Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of a two :ref:`Vector2` x, y and :ref:`Vector2` "origin". It is similar to a 3x2 matrix. +Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of a two :ref:`Vector2` x, y and :ref:`Vector2` "origin". It is similar to a 3x2 matrix. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Transform2D_origin: + +- :ref:`Vector2` **origin** - The transform's translation offset. + + .. _class_Transform2D_x: + +- :ref:`Vector2` **x** - The X axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + .. _class_Transform2D_y: + +- :ref:`Vector2` **y** - The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object. + + +Method Descriptions +------------------- .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** -Constructs the transform from a 3D :ref:`Transform`. +Constructs the transform from a 3D :ref:`Transform`. .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** -Constructs the transform from 3 :ref:`Vector2`\ s representing x, y, and origin. +Constructs the transform from 3 :ref:`Vector2`\ s representing x, y, and origin. .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. .. _class_Transform2D_affine_inverse: -- :ref:`Transform2D` **affine_inverse** **(** **)** +- :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. .. _class_Transform2D_basis_xform: -- :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** +- :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Transforms the given vector by this transform's basis (no translation). .. _class_Transform2D_basis_xform_inv: -- :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** +- :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Inverse-transforms the given vector by this transform's basis (no translation). .. _class_Transform2D_get_origin: -- :ref:`Vector2` **get_origin** **(** **)** +- :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). @@ -134,56 +134,56 @@ Returns the transform's rotation (in radians). .. _class_Transform2D_get_scale: -- :ref:`Vector2` **get_scale** **(** **)** +- :ref:`Vector2` **get_scale** **(** **)** Returns the scale. .. _class_Transform2D_interpolate_with: -- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** +- :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** Returns a transform interpolated between this transform and another by a given weight (0-1). .. _class_Transform2D_inverse: -- :ref:`Transform2D` **inverse** **(** **)** +- :ref:`Transform2D` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). .. _class_Transform2D_orthonormalized: -- :ref:`Transform2D` **orthonormalized** **(** **)** +- :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. .. _class_Transform2D_rotated: -- :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** +- :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by the given angle (in radians). .. _class_Transform2D_scaled: -- :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** +- :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the given factor. .. _class_Transform2D_translated: -- :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** +- :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the given offset. .. _class_Transform2D_xform: -- var **xform** **(** var v **)** +- :ref:`Variant` **xform** **(** :ref:`Variant` v **)** -Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. +Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. .. _class_Transform2D_xform_inv: -- var **xform_inv** **(** var v **)** +- :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** -Inverse-transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. +Inverse-transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 2172efa72..98819b3d5 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -7,10 +7,8 @@ Translation =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`PHashTranslation` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`PHashTranslation` **Category:** Core Brief Description @@ -18,52 +16,52 @@ Brief Description Language Translation. -Member Functions ----------------- +Methods +------- +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | +| void | :ref:`add_message` **(** :ref:`String` src_message, :ref:`String` xlated_message **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | +| void | :ref:`erase_message` **(** :ref:`String` src_message **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | +| :ref:`String` | :ref:`get_message` **(** :ref:`String` src_message **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_message_count` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_message_list` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_Translation_locale: - -- :ref:`String` **locale** - - Description ----------- Translations are resources that can be loaded/unloaded on demand. They map a string to another string. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Translation_locale: + +- :ref:`String` **locale** + + +Method Descriptions +------------------- .. _class_Translation_add_message: -- void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** +- void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** Add a message for translation. .. _class_Translation_erase_message: -- void **erase_message** **(** :ref:`String` src_message **)** +- void **erase_message** **(** :ref:`String` src_message **)** Erase a message. .. _class_Translation_get_message: -- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const +- :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Return a message for translation. @@ -73,7 +71,7 @@ Return a message for translation. .. _class_Translation_get_message_list: -- :ref:`PoolStringArray` **get_message_list** **(** **)** const +- :ref:`PoolStringArray` **get_message_list** **(** **)** const Return all the messages (keys). diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 57eb31e74..b38814ccb 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -7,8 +7,7 @@ TranslationServer ================= -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,31 +15,31 @@ Brief Description Server that manages all translations. Translations can be set to it and removed from it. -Member Functions ----------------- +Methods +------- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | +| void | :ref:`add_translation` **(** :ref:`Translation` translation **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale` **(** **)** const | +| :ref:`String` | :ref:`get_locale` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | +| :ref:`String` | :ref:`get_locale_name` **(** :ref:`String` locale **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | +| void | :ref:`remove_translation` **(** :ref:`Translation` translation **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_locale` **(** :ref:`String` locale **)** | +| void | :ref:`set_locale` **(** :ref:`String` locale **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | +| :ref:`String` | :ref:`translate` **(** :ref:`String` message **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_TranslationServer_add_translation: -- void **add_translation** **(** :ref:`Translation` translation **)** +- void **add_translation** **(** :ref:`Translation` translation **)** .. _class_TranslationServer_clear: @@ -48,22 +47,22 @@ Member Function Description .. _class_TranslationServer_get_locale: -- :ref:`String` **get_locale** **(** **)** const +- :ref:`String` **get_locale** **(** **)** const .. _class_TranslationServer_get_locale_name: -- :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const +- :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const .. _class_TranslationServer_remove_translation: -- void **remove_translation** **(** :ref:`Translation` translation **)** +- void **remove_translation** **(** :ref:`Translation` translation **)** .. _class_TranslationServer_set_locale: -- void **set_locale** **(** :ref:`String` locale **)** +- void **set_locale** **(** :ref:`String` locale **)** .. _class_TranslationServer_translate: -- :ref:`String` **translate** **(** :ref:`String` message **)** const +- :ref:`String` **translate** **(** :ref:`String` message **)** const diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 4767a394b..09e4a50e2 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -7,8 +7,7 @@ Tree ==== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,45 +15,45 @@ Brief Description Control to show a tree of items. -Member Functions ----------------- +Methods +------- +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_column_titles_visible` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`create_item` **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** | +| :ref:`TreeItem` | :ref:`create_item` **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_cursor_is_visible` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | +| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_column_width` **(** :ref:`int` column **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_custom_popup_rect` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | +| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | +| :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edited_column` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | +| :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | +| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | +| :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_pressed_button` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_root` **(** **)** | +| :ref:`TreeItem` | :ref:`get_root` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | +| :ref:`Vector2` | :ref:`get_scroll` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | +| :ref:`TreeItem` | :ref:`get_selected` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_column` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +61,7 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_column_min_width` **(** :ref:`int` column, :ref:`int` min_width **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | +| void | :ref:`set_column_title` **(** :ref:`int` column, :ref:`String` title **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_column_titles_visible` **(** :ref:`bool` visible **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +71,7 @@ Signals .. _class_Tree_button_pressed: -- **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** +- **button_pressed** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`int` id **)** Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). @@ -96,7 +95,7 @@ Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. .. _class_Tree_empty_tree_rmb_selected: -- **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** +- **empty_tree_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. @@ -108,7 +107,7 @@ Emitted when an item's label is double-clicked. .. _class_Tree_item_collapsed: -- **item_collapsed** **(** :ref:`Object` item **)** +- **item_collapsed** **(** :ref:`TreeItem` item **)** Emitted when an item is collapsed by a click on the folding arrow. @@ -136,7 +135,7 @@ Emitted when an item is edited using the right mouse button. .. _class_Tree_item_rmb_selected: -- **item_rmb_selected** **(** :ref:`Vector2` position **)** +- **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. @@ -148,7 +147,7 @@ Emitted when an item is selected with right mouse button. .. _class_Tree_multi_selected: -- **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** +- **multi_selected** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. @@ -157,8 +156,46 @@ Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. - **nothing_selected** **(** **)** -Member Variables ----------------- +Enumerations +------------ + + .. _enum_Tree_DropModeFlags: + +enum **DropModeFlags** + +- **DROP_MODE_DISABLED** = **0** +- **DROP_MODE_ON_ITEM** = **1** +- **DROP_MODE_INBETWEEN** = **2** + + .. _enum_Tree_SelectMode: + +enum **SelectMode** + +- **SELECT_SINGLE** = **0** --- Allow selection of a single item at a time. +- **SELECT_ROW** = **1** +- **SELECT_MULTI** = **2** --- Allow selection of multiple items at the same time. + + +Description +----------- + +This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structured displays and interactions. + +Trees are built via code, using :ref:`TreeItem` objects to create the structure. They have a single root but multiple roots can be simulated if a dummy hidden root is added. + +:: + + func _ready(): + var tree = Tree.new() + var root = tree.create_item() + tree.set_hide_root(true) + var child1 = tree.create_item(root) + var child2 = tree.create_item(root) + var subchild1 = tree.create_item(child1) + subchild1.set_text(0, "Subchild1") + +Property Descriptions +--------------------- .. _class_Tree_allow_reselect: @@ -186,49 +223,11 @@ Member Variables .. _class_Tree_select_mode: -- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. +- :ref:`SelectMode` **select_mode** - Allow single or multiple selection. See the ``SELECT_*`` constants. -Enums ------ - - .. _enum_Tree_DropModeFlags: - -enum **DropModeFlags** - -- **DROP_MODE_DISABLED** = **0** -- **DROP_MODE_ON_ITEM** = **1** -- **DROP_MODE_INBETWEEN** = **2** - - .. _enum_Tree_SelectMode: - -enum **SelectMode** - -- **SELECT_SINGLE** = **0** --- Allow selection of a single item at a time. -- **SELECT_ROW** = **1** -- **SELECT_MULTI** = **2** --- Allow selection of multiple items at the same time. - - -Description ------------ - -This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structured displays and interactions. - -Trees are built via code, using :ref:`TreeItem` objects to create the structure. They have a single root but multiple roots can be simulated if a dummy hidden root is added. - -:: - - func _ready(): - var tree = Tree.new() - var root = tree.create_item() - tree.set_hide_root(true) - var child1 = tree.create_item(root) - var child2 = tree.create_item(root) - var subchild1 = tree.create_item(child1) - subchild1.set_text(0, "Subchild1") - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Tree_are_column_titles_visible: @@ -244,7 +243,7 @@ Clears the tree. This removes all items. .. _class_Tree_create_item: -- :ref:`Object` **create_item** **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** +- :ref:`TreeItem` **create_item** **(** :ref:`Object` parent=null, :ref:`int` idx=-1 **)** Create an item in the tree and add it as the last child of ``parent``. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. @@ -256,13 +255,13 @@ Makes the currently selected item visible. This will scroll the tree to make sur .. _class_Tree_get_column_at_position: -- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Returns the column index under the given point. .. _class_Tree_get_column_title: -- :ref:`String` **get_column_title** **(** :ref:`int` column **)** const +- :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. @@ -274,13 +273,13 @@ Returns the column's width in pixels. .. _class_Tree_get_custom_popup_rect: -- :ref:`Rect2` **get_custom_popup_rect** **(** **)** const +- :ref:`Rect2` **get_custom_popup_rect** **(** **)** const Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See :ref:`TreeItem.set_cell_mode`. .. _class_Tree_get_drop_section_at_position: -- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const If :ref:`drop_mode_flags` includes ``DROP_MODE_INBETWEEN``, returns -1 if ``position`` is the upper part of a tree item at that position, 1 for the lower part, and additionally 0 for the middle part if :ref:`drop_mode_flags` includes ``DROP_MODE_ON_ITEM``. @@ -288,7 +287,7 @@ Otherwise, returns 0. If there are no tree item at ``position``, returns -100. .. _class_Tree_get_edited: -- :ref:`TreeItem` **get_edited** **(** **)** const +- :ref:`TreeItem` **get_edited** **(** **)** const Returns the currently edited item. This is only available for custom cell mode. @@ -300,19 +299,19 @@ Returns the column for the currently edited item. This is only available for cus .. _class_Tree_get_item_area_rect: -- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const +- :ref:`Rect2` **get_item_area_rect** **(** :ref:`Object` item, :ref:`int` column=-1 **)** const Returns the rectangle area for the specified item. If column is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. .. _class_Tree_get_item_at_position: -- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const +- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const Returns the tree item at the specified position (relative to the tree origin position). .. _class_Tree_get_next_selected: -- :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** +- :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Returns the next selected item after the given one. @@ -324,19 +323,19 @@ Returns the last pressed button's index. .. _class_Tree_get_root: -- :ref:`TreeItem` **get_root** **(** **)** +- :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. .. _class_Tree_get_scroll: -- :ref:`Vector2` **get_scroll** **(** **)** const +- :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. .. _class_Tree_get_selected: -- :ref:`TreeItem` **get_selected** **(** **)** const +- :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. @@ -350,7 +349,7 @@ Returns the current selection's column. - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** -If ``true`` the column will have the "Expand" flag of :ref:`Control`. +If ``true`` the column will have the "Expand" flag of :ref:`Control`. .. _class_Tree_set_column_min_width: @@ -360,7 +359,7 @@ Set the minimum width of a column. .. _class_Tree_set_column_title: -- void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** +- void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** Set the title of a column. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 920417526..721e5d230 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -7,20 +7,19 @@ TreeItem ======== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description ----------------- -Control for a single item inside a :ref:`Tree`. +Control for a single item inside a :ref:`Tree`. -Member Functions ----------------- +Methods +------- +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,45 +29,45 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | +| :ref:`TreeCellMode` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | +| :ref:`Variant` | :ref:`get_metadata` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** const | +| :ref:`TextAlign` | :ref:`get_text_align` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -86,35 +85,35 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_to_top` **(** **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Object` child **)** | +| void | :ref:`remove_child` **(** :ref:`Object` child **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` column **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,31 +121,15 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`TextAlign` text_align **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_TreeItem_collapsed: - -- :ref:`bool` **collapsed** - If ``true`` the TreeItem is collapsed. - - .. _class_TreeItem_custom_minimum_height: - -- :ref:`int` **custom_minimum_height** - The custom minimum height. - - .. _class_TreeItem_disable_folding: - -- :ref:`bool` **disable_folding** - If ``true`` folding is disabled for this TreeItem. - - -Enums ------ +Enumerations +------------ .. _enum_TreeItem_TreeCellMode: @@ -171,16 +154,32 @@ enum **TextAlign** Description ----------- -Control for a single item inside a :ref:`Tree`. May have child ``TreeItem``\ s and be styled as well as contain buttons. +Control for a single item inside a :ref:`Tree`. May have child ``TreeItem``\ s and be styled as well as contain buttons. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_TreeItem_collapsed: + +- :ref:`bool` **collapsed** - If ``true`` the TreeItem is collapsed. + + .. _class_TreeItem_custom_minimum_height: + +- :ref:`int` **custom_minimum_height** - The custom minimum height. + + .. _class_TreeItem_disable_folding: + +- :ref:`bool` **disable_folding** - If ``true`` folding is disabled for this TreeItem. + + +Method Descriptions +------------------- .. _class_TreeItem_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** -Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling ``get_buton_count()`` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. +Adds a button with :ref:`Texture` ``button`` at column ``column``. The ``button_idx`` index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling ``get_buton_count()`` immediately after this method. Optionally, the button can be ``disabled`` and have a ``tooltip``. .. _class_TreeItem_clear_custom_bg_color: @@ -208,9 +207,9 @@ Removes the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_get_button: -- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const +- :ref:`Texture` **get_button** **(** :ref:`int` column, :ref:`int` button_idx **)** const -Returns the :ref:`Texture` of the button at index ``button_idx`` in column ``column``. +Returns the :ref:`Texture` of the button at index ``button_idx`` in column ``column``. .. _class_TreeItem_get_button_count: @@ -220,19 +219,19 @@ Returns the number of buttons in column ``column``. May be used to get the most .. _class_TreeItem_get_cell_mode: -- :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const +- :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const Returns the column's cell mode. See ``CELL_MODE_*`` constants. .. _class_TreeItem_get_children: -- :ref:`TreeItem` **get_children** **(** **)** +- :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. .. _class_TreeItem_get_custom_bg_color: -- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const +- :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const Returns the custom background color of column ``column``. @@ -244,9 +243,9 @@ Returns ``true`` if ``expand_right`` is set. .. _class_TreeItem_get_icon: -- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const +- :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const -Returns the given column's icon :ref:`Texture`. Error if no icon is set. +Returns the given column's icon :ref:`Texture`. Error if no icon is set. .. _class_TreeItem_get_icon_max_width: @@ -256,41 +255,41 @@ Returns the column's icon's maximum width. .. _class_TreeItem_get_icon_region: -- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const +- :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const -Returns the icon :ref:`Texture` region as :ref:`Rect2`. +Returns the icon :ref:`Texture` region as :ref:`Rect2`. .. _class_TreeItem_get_metadata: -- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const +- :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const .. _class_TreeItem_get_next: -- :ref:`TreeItem` **get_next** **(** **)** +- :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. .. _class_TreeItem_get_next_visible: -- :ref:`TreeItem` **get_next_visible** **(** **)** +- :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. .. _class_TreeItem_get_parent: -- :ref:`TreeItem` **get_parent** **(** **)** +- :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. .. _class_TreeItem_get_prev: -- :ref:`TreeItem` **get_prev** **(** **)** +- :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. .. _class_TreeItem_get_prev_visible: -- :ref:`TreeItem` **get_prev_visible** **(** **)** +- :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. @@ -300,23 +299,23 @@ Returns the previous visible TreeItem in the tree. .. _class_TreeItem_get_range_config: -- :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** +- :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** .. _class_TreeItem_get_text: -- :ref:`String` **get_text** **(** :ref:`int` column **)** const +- :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. .. _class_TreeItem_get_text_align: -- :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const +- :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const Returns the given column's text alignment. .. _class_TreeItem_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const +- :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. @@ -358,17 +357,17 @@ Returns ``true`` if column ``column`` is selected. - void **move_to_bottom** **(** **)** -Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. +Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. .. _class_TreeItem_move_to_top: - void **move_to_top** **(** **)** -Moves this TreeItem to the top in the :ref:`Tree` hierarchy. +Moves this TreeItem to the top in the :ref:`Tree` hierarchy. .. _class_TreeItem_remove_child: -- void **remove_child** **(** :ref:`Object` child **)** +- void **remove_child** **(** :ref:`Object` child **)** Removes the given child TreeItem. @@ -380,13 +379,13 @@ Selects the column ``column``. .. _class_TreeItem_set_button: -- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** +- void **set_button** **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** -Sets the given column's button :ref:`Texture` at index ``button_idx`` to ``button``. +Sets the given column's button :ref:`Texture` at index ``button_idx`` to ``button``. .. _class_TreeItem_set_cell_mode: -- void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** +- void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. @@ -402,19 +401,19 @@ If ``true`` the column ``column`` is checked. .. _class_TreeItem_set_custom_bg_color: -- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** +- void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** Sets the given column's custom background color and whether to just use it as an outline. .. _class_TreeItem_set_custom_color: -- void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** +- void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** Sets the given column's custom color. .. _class_TreeItem_set_custom_draw: -- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** +- void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** Sets the given column's custom draw callback to ``callback`` method on ``object``. @@ -432,9 +431,9 @@ If ``true`` column ``column`` is expanded to the right. .. _class_TreeItem_set_icon: -- void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** +- void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** -Sets the given column's icon :ref:`Texture`. +Sets the given column's icon :ref:`Texture`. .. _class_TreeItem_set_icon_max_width: @@ -444,13 +443,13 @@ Sets the given column's icon's maximum width. .. _class_TreeItem_set_icon_region: -- void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** +- void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** Sets the given column's icon's texture region. .. _class_TreeItem_set_metadata: -- void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** +- void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** .. _class_TreeItem_set_range: @@ -468,17 +467,17 @@ If ``true`` the given column is selectable. .. _class_TreeItem_set_text: -- void **set_text** **(** :ref:`int` column, :ref:`String` text **)** +- void **set_text** **(** :ref:`int` column, :ref:`String` text **)** .. _class_TreeItem_set_text_align: -- void **set_text_align** **(** :ref:`int` column, :ref:`TextAlign` text_align **)** +- void **set_text_align** **(** :ref:`int` column, :ref:`TextAlign` text_align **)** Sets the given column's text alignment. See ``ALIGN_*`` constants. .. _class_TreeItem_set_tooltip: -- void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** +- void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** Sets the given column's tooltip text. diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 4c869027e..f3ae1b62d 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -7,8 +7,7 @@ TriangleMesh ============ -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 0acf98c1a..412a92c5e 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -7,8 +7,7 @@ Tween ===== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,35 +15,35 @@ Brief Description Smoothly animates a node's properties over time. -Member Functions ----------------- +Methods +------- +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`follow_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`follow_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_runtime` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +| :ref:`bool` | :ref:`interpolate_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +| :ref:`bool` | :ref:`interpolate_deferred_callback` **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`interpolate_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`interpolate_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`remove` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`reset` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`reset_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`resume` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`resume_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,13 +53,13 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | +| :ref:`bool` | :ref:`stop` **(** :ref:`Object` object, :ref:`String` key="" **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`stop_all` **(** **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`targeting_method` **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +| :ref:`bool` | :ref:`targeting_property` **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tell` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -70,41 +69,25 @@ Signals .. _class_Tween_tween_completed: -- **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** +- **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween ends. .. _class_Tween_tween_started: -- **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** +- **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween starts. .. _class_Tween_tween_step: -- **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** +- **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** Emitted at each step of the animation. -Member Variables ----------------- - - .. _class_Tween_playback_process_mode: - -- :ref:`TweenProcessMode` **playback_process_mode** - The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. - - .. _class_Tween_playback_speed: - -- :ref:`float` **playback_speed** - The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ``2.0`` for two times normal speed, or ``0.5`` for half of the normal speed. A value of ``0`` pauses the animation, but see also :ref:`set_active` or :ref:`stop_all` for this. - - .. _class_Tween_repeat: - -- :ref:`bool` **repeat** - If ``true`` the tween loops. - - -Enums ------ +Enumerations +------------ .. _enum_Tween_TweenProcessMode: @@ -156,26 +139,42 @@ Here is a brief usage example that causes a 2D node to move smoothly between two Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector. -Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an :ref:`EaseType` constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with :ref:`EASE_IN_OUT`, and use the one that looks best. +Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType` constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an :ref:`EaseType` constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType` constants with :ref:`EASE_IN_OUT`, and use the one that looks best. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Tween_playback_process_mode: + +- :ref:`TweenProcessMode` **playback_process_mode** - The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. + + .. _class_Tween_playback_speed: + +- :ref:`float` **playback_speed** - The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ``2.0`` for two times normal speed, or ``0.5`` for half of the normal speed. A value of ``0`` pauses the animation, but see also :ref:`set_active` or :ref:`stop_all` for this. + + .. _class_Tween_repeat: + +- :ref:`bool` **repeat** - If ``true`` the tween loops. + + +Method Descriptions +------------------- .. _class_Tween_follow_method: -- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`String` target_method, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Follows ``method`` of ``object`` and applies the returned value on ``target_method`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` later. Methods are called with consecutive values. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_follow_property: -- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **follow_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Object` target, :ref:`NodePath` target_property, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Follows ``property`` of ``object`` and applies it on ``target_property`` of ``target``, beginning from ``initial_val`` for ``duration`` seconds, ``delay`` seconds later. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_get_runtime: @@ -185,31 +184,31 @@ Returns the total time needed for all tweens to end. If you have two tweens, one .. _class_Tween_interpolate_callback: -- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- :ref:`bool` **interpolate_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_deferred_callback: -- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** +- :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=null, :ref:`Variant` arg2=null, :ref:`Variant` arg3=null, :ref:`Variant` arg4=null, :ref:`Variant` arg5=null **)** Calls ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`Object.call_deferred`). ``arg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_method: -- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are called with consecutive values. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_interpolate_property: -- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **interpolate_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Variant` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Setting the initial value to ``null`` uses the current value of the property. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_is_active: @@ -219,7 +218,7 @@ Returns ``true`` if any tweens are currently running. Note that this method does .. _class_Tween_remove: -- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **remove** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. @@ -231,7 +230,7 @@ Stops animation and removes all tweens. .. _class_Tween_reset: -- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **reset** **(** :ref:`Object` object, :ref:`String` key="" **)** Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless ``key`` is specified. @@ -243,7 +242,7 @@ Resets all tweens to their initial values (the ones given, not those before the .. _class_Tween_resume: -- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **resume** **(** :ref:`Object` object, :ref:`String` key="" **)** Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless ``key`` is specified. @@ -273,7 +272,7 @@ Starts the tween. You can define animations both before and after this. .. _class_Tween_stop: -- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** +- :ref:`bool` **stop** **(** :ref:`Object` object, :ref:`String` key="" **)** Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless ``key`` is specified. @@ -285,19 +284,19 @@ Stops animating all tweens. .. _class_Tween_targeting_method: -- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_method** **(** :ref:`Object` object, :ref:`String` method, :ref:`Object` initial, :ref:`String` initial_method, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``method`` of ``object`` from the value returned by ``initial_method`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. Methods are animated by calling them with consecutive values. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_targeting_property: -- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** +- :ref:`bool` **targeting_property** **(** :ref:`Object` object, :ref:`NodePath` property, :ref:`Object` initial, :ref:`NodePath` initial_val, :ref:`Variant` final_val, :ref:`float` duration, :ref:`TransitionType` trans_type, :ref:`EaseType` ease_type, :ref:`float` delay=0 **)** Animates ``property`` of ``object`` from the current value of the ``initial_val`` property of ``initial`` to ``final_val`` for ``duration`` seconds, ``delay`` seconds later. - Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information + Use :ref:`TransitionType` for ``trans_type`` and :ref:`EaseType` for ``ease_type`` parameters. These values control the timing and direction of the interpolation. See the class description for more information .. _class_Tween_tell: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 1a56ade0f..bb7f2f887 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -7,8 +7,7 @@ UndoRedo ======== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,29 +15,29 @@ Brief Description Helper to manage UndoRedo in the editor or custom tools. -Member Functions ----------------- +Methods +------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`add_do_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`add_do_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | +| void | :ref:`add_do_reference` **(** :ref:`Object` object **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | +| :ref:`Variant` | :ref:`add_undo_method` **(** :ref:`Object` object, :ref:`String` method **)** vararg | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +| void | :ref:`add_undo_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | +| void | :ref:`add_undo_reference` **(** :ref:`Object` object **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_history` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`commit_action` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | +| void | :ref:`create_action` **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +| :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_version` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,8 +46,8 @@ Member Functions | :ref:`bool` | :ref:`undo` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_UndoRedo_MergeMode: @@ -62,44 +61,73 @@ enum **MergeMode** Description ----------- -Helper to manage UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. +Helper to manage UndoRedo in the editor or custom tools. It works by registering methods and property changes inside 'actions'. Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. -Member Function Description ---------------------------- +Here's an example on how to add an action to Godot editor's own 'undoredo': + +:: + + var undoredo = get_undo_redo() # method of EditorPlugin + + func do_something(): + pass # put your code here + + func undo_something(): + pass # put here the code that reverts what's done by "do_something()" + + func _on_MyButton_pressed(): + var node = get_node("MyNode2D") + undoredo.create_action("Move the node") + undoredo.add_do_method(self, "do_something") + undoredo.add_undo_method(self, "undo_something") + undoredo.add_do_property(node, "position", Vector2(100,100)) + undoredo.add_undo_property(node, "position", node.position) + undoredo.commit_action() + +:ref:`create_action`, :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, :ref:`add_undo_property`, and :ref:`commit_action` should be called one after the other, like in the example. Not doing so could lead to crashes. + +If you don't need to register a method you can leave :ref:`add_do_method` and :ref:`add_undo_method` out, and so it goes for properties. You can register more than one method/property. + +Method Descriptions +------------------- .. _class_UndoRedo_add_do_method: -- :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_do_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg + +Register a method that will be called when the action is committed. .. _class_UndoRedo_add_do_property: -- void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** -Set a property with a custom value. +Register a property value change for 'do'. .. _class_UndoRedo_add_do_reference: -- void **add_do_reference** **(** :ref:`Object` object **)** +- void **add_do_reference** **(** :ref:`Object` object **)** -Add a 'do' reference that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. +Register a reference for 'do' that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. .. _class_UndoRedo_add_undo_method: -- :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg +- :ref:`Variant` **add_undo_method** **(** :ref:`Object` object, :ref:`String` method **)** vararg + +Register a method that will be called when the action is undone. .. _class_UndoRedo_add_undo_property: -- void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** +- void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** -Undo setting of a property with a custom value. +Register a property value change for 'undo'. .. _class_UndoRedo_add_undo_reference: -- void **add_undo_reference** **(** :ref:`Object` object **)** +- void **add_undo_reference** **(** :ref:`Object` object **)** -Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). +Register a reference for 'undo' that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). .. _class_UndoRedo_clear_history: @@ -115,13 +143,13 @@ Commit the action. All 'do' methods/properties are called/set when this function .. _class_UndoRedo_create_action: -- void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** +- void **create_action** **(** :ref:`String` name, :ref:`MergeMode` merge_mode=0 **)** -Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. +Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property`, and :ref:`add_undo_property`, then commit the action with :ref:`commit_action`. .. _class_UndoRedo_get_current_action_name: -- :ref:`String` **get_current_action_name** **(** **)** const +- :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. @@ -137,8 +165,12 @@ This is useful mostly to check if something changed from a saved version. - :ref:`bool` **redo** **(** **)** +Redo last action. + .. _class_UndoRedo_undo: - :ref:`bool` **undo** **(** **)** +Undo last action. + diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index b1b800df4..0b6bc3b13 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -7,8 +7,7 @@ UPNP ==== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,65 +15,49 @@ Brief Description UPNP network functions. -Member Functions ----------------- +Methods +------- +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | +| void | :ref:`add_device` **(** :ref:`UPNPDevice` device **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_devices` **(** **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | +| :ref:`int` | :ref:`discover` **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** const | +| :ref:`UPNPDevice` | :ref:`get_device` **(** :ref:`int` index **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_device_count` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** const | +| :ref:`UPNPDevice` | :ref:`get_gateway` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_external_address` **(** **)** const | +| :ref:`String` | :ref:`query_external_address` **(** **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_device` **(** :ref:`int` index **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | +| void | :ref:`set_device` **(** :ref:`int` index, :ref:`UPNPDevice` device **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_UPNP_discover_ipv6: - -- :ref:`bool` **discover_ipv6** - If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. - - .. _class_UPNP_discover_local_port: - -- :ref:`int` **discover_local_port** - If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. - - .. _class_UPNP_discover_multicast_if: - -- :ref:`String` **discover_multicast_if** - Multicast interface to use for discovery. Uses the default multicast interface if empty. - - -Enums ------ +Enumerations +------------ .. _enum_UPNP_UPNPResult: enum **UPNPResult** - **UPNP_RESULT_SUCCESS** = **0** --- UPNP command or discovery was successful. -- **UPNP_RESULT_NOT_AUTHORIZED** = **1** --- Not authorized to use the command on the :ref:`UPNPDevice`. May be returned when the user disabled UPNP on their router. -- **UPNP_RESULT_PORT_MAPPING_NOT_FOUND** = **2** --- No port mapping was found for the given port, protocol combination on the given :ref:`UPNPDevice`. +- **UPNP_RESULT_NOT_AUTHORIZED** = **1** --- Not authorized to use the command on the :ref:`UPNPDevice`. May be returned when the user disabled UPNP on their router. +- **UPNP_RESULT_PORT_MAPPING_NOT_FOUND** = **2** --- No port mapping was found for the given port, protocol combination on the given :ref:`UPNPDevice`. - **UPNP_RESULT_INCONSISTENT_PARAMETERS** = **3** --- Inconsistent parameters. -- **UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY** = **4** --- No such entry in array. May be returned if a given port, protocol combination is not found on an :ref:`UPNPDevice`. +- **UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY** = **4** --- No such entry in array. May be returned if a given port, protocol combination is not found on an :ref:`UPNPDevice`. - **UPNP_RESULT_ACTION_FAILED** = **5** --- The action failed. -- **UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED** = **6** --- The :ref:`UPNPDevice` does not allow wildcard values for the source IP address. -- **UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED** = **7** --- The :ref:`UPNPDevice` does not allow wildcard values for the external port. -- **UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED** = **8** --- The :ref:`UPNPDevice` does not allow wildcard values for the internal port. +- **UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED** = **6** --- The :ref:`UPNPDevice` does not allow wildcard values for the source IP address. +- **UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED** = **7** --- The :ref:`UPNPDevice` does not allow wildcard values for the external port. +- **UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED** = **8** --- The :ref:`UPNPDevice` does not allow wildcard values for the internal port. - **UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD** = **9** --- The remote host value must be a wildcard. - **UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD** = **10** --- The external port value must be a wildcard. - **UPNP_RESULT_NO_PORT_MAPS_AVAILABLE** = **11** --- No port maps are available. May also be returned if port mapping functionality is not available. @@ -93,27 +76,43 @@ enum **UPNPResult** - **UPNP_RESULT_SOCKET_ERROR** = **24** --- Socket error. - **UPNP_RESULT_MEM_ALLOC_ERROR** = **25** --- Error allocating memory. - **UPNP_RESULT_NO_GATEWAY** = **26** --- No gateway available. You may need to call :ref:`discover` first, or discovery didn't detect any valid IGDs (InternetGatewayDevices). -- **UPNP_RESULT_NO_DEVICES** = **27** --- No devices available. You may need to call :ref:`discover` first, or discovery didn't detect any valid :ref:`UPNPDevice`\ s. +- **UPNP_RESULT_NO_DEVICES** = **27** --- No devices available. You may need to call :ref:`discover` first, or discovery didn't detect any valid :ref:`UPNPDevice`\ s. - **UPNP_RESULT_UNKNOWN_ERROR** = **28** --- Unknown error. Description ----------- -Provides UPNP functionality to discover :ref:`UPNPDevice`\ s on the local network and execute commands on them, like managing port mappings (port forwarding) and querying the local and remote network IP address. Note that methods on this class are synchronous and block the calling thread. +Provides UPNP functionality to discover :ref:`UPNPDevice`\ s on the local network and execute commands on them, like managing port mappings (port forwarding) and querying the local and remote network IP address. Note that methods on this class are synchronous and block the calling thread. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_UPNP_discover_ipv6: + +- :ref:`bool` **discover_ipv6** - If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. + + .. _class_UPNP_discover_local_port: + +- :ref:`int` **discover_local_port** - If ``0``, the local port to use for discovery is chosen automatically by the system. If ``1``, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port. + + .. _class_UPNP_discover_multicast_if: + +- :ref:`String` **discover_multicast_if** - Multicast interface to use for discovery. Uses the default multicast interface if empty. + + +Method Descriptions +------------------- .. _class_UPNP_add_device: -- void **add_device** **(** :ref:`UPNPDevice` device **)** +- void **add_device** **(** :ref:`UPNPDevice` device **)** -Adds the given :ref:`UPNPDevice` to the list of discovered devices. +Adds the given :ref:`UPNPDevice` to the list of discovered devices. .. _class_UPNP_add_port_mapping: -- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const Adds a mapping to forward the external ``port`` (between 1 and 65535) on the default gateway (see :ref:`get_gateway`) to the ``internal_port`` on the local machine for the given protocol ``proto`` (either ``TCP`` or ``UDP``, with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with :ref:`get_gateway` and call :ref:`add_port_mapping` on it, if any. @@ -121,7 +120,7 @@ If ``internal_port`` is ``0`` (the default), the same port number is used for bo The description (``desc``) is shown in some router UIs and can be used to point out which application added the mapping, and the lifetime of the mapping can be limited by ``duration``. However, some routers are incompatible with one or both of these, so use with caution and add fallback logic in case of errors to retry without them if in doubt. -See :ref:`UPNPResult` for possible return values. +See :ref:`UPNPResult` for possible return values. .. _class_UPNP_clear_devices: @@ -131,43 +130,43 @@ Clears the list of discovered devices. .. _class_UPNP_delete_port_mapping: -- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const -Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult` for possible return values. +Deletes the port mapping for the given port and protocol combination on the default gateway (see :ref:`get_gateway`) if one exists. ``port`` must be a valid port between 1 and 65535, ``proto`` can be either ``TCP`` or ``UDP``. See :ref:`UPNPResult` for possible return values. .. _class_UPNP_discover: -- :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** +- :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** -Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. +Discovers local :ref:`UPNPDevice`\ s. Clears the list of previously discovered devices. Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. ``timeout`` is the time to wait for responses in miliseconds. ``ttl`` is the time-to-live; only touch this if you know what you're doing. -See :ref:`UPNPResult` for possible return values. +See :ref:`UPNPResult` for possible return values. .. _class_UPNP_get_device: -- :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const +- :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const -Returns the :ref:`UPNPDevice` at the given ``index``. +Returns the :ref:`UPNPDevice` at the given ``index``. .. _class_UPNP_get_device_count: - :ref:`int` **get_device_count** **(** **)** const -Returns the number of discovered :ref:`UPNPDevice`\ s. +Returns the number of discovered :ref:`UPNPDevice`\ s. .. _class_UPNP_get_gateway: -- :ref:`UPNPDevice` **get_gateway** **(** **)** const +- :ref:`UPNPDevice` **get_gateway** **(** **)** const -Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). +Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). .. _class_UPNP_query_external_address: -- :ref:`String` **query_external_address** **(** **)** const +- :ref:`String` **query_external_address** **(** **)** const -Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. +Returns the external :ref:`IP` address of the default gateway (see :ref:`get_gateway`) as string. Returns an empty string on error. .. _class_UPNP_remove_device: @@ -177,7 +176,7 @@ Removes the device at ``index`` from the list of discovered devices. .. _class_UPNP_set_device: -- void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** +- void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** Sets the device at ``index`` from the list of discovered devices to ``device``. diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 437b9f9b9..2af0a6ecb 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -7,8 +7,7 @@ UPNPDevice ========== -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,49 +15,21 @@ Brief Description UPNP device. -Member Functions ----------------- +Methods +------- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | +| :ref:`int` | :ref:`add_port_mapping` **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | +| :ref:`int` | :ref:`delete_port_mapping` **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_gateway` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`query_external_address` **(** **)** const | +| :ref:`String` | :ref:`query_external_address` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_UPNPDevice_description_url: - -- :ref:`String` **description_url** - URL to the device description. - - .. _class_UPNPDevice_igd_control_url: - -- :ref:`String` **igd_control_url** - IDG control URL. - - .. _class_UPNPDevice_igd_our_addr: - -- :ref:`String` **igd_our_addr** - Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. - - .. _class_UPNPDevice_igd_service_type: - -- :ref:`String` **igd_service_type** - IGD service type. - - .. _class_UPNPDevice_igd_status: - -- :ref:`IGDStatus` **igd_status** - IGD status. See :ref:`IGDStatus`. - - .. _class_UPNPDevice_service_type: - -- :ref:`String` **service_type** - Service type. - - -Enums ------ +Enumerations +------------ .. _enum_UPNPDevice_IGDStatus: @@ -79,20 +50,48 @@ enum **IGDStatus** Description ----------- -UPNP device. See :ref:`UPNP` for UPNP discovery and utility functions. Provides low-level access to UPNP control commands. Allows to manage port mappings (port forwarding) and to query network information of the device (like local and external IP address and status). Note that methods on this class are synchronous and block the calling thread. +UPNP device. See :ref:`UPNP` for UPNP discovery and utility functions. Provides low-level access to UPNP control commands. Allows to manage port mappings (port forwarding) and to query network information of the device (like local and external IP address and status). Note that methods on this class are synchronous and block the calling thread. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_UPNPDevice_description_url: + +- :ref:`String` **description_url** - URL to the device description. + + .. _class_UPNPDevice_igd_control_url: + +- :ref:`String` **igd_control_url** - IDG control URL. + + .. _class_UPNPDevice_igd_our_addr: + +- :ref:`String` **igd_our_addr** - Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. + + .. _class_UPNPDevice_igd_service_type: + +- :ref:`String` **igd_service_type** - IGD service type. + + .. _class_UPNPDevice_igd_status: + +- :ref:`IGDStatus` **igd_status** - IGD status. See :ref:`IGDStatus`. + + .. _class_UPNPDevice_service_type: + +- :ref:`String` **service_type** - Service type. + + +Method Descriptions +------------------- .. _class_UPNPDevice_add_port_mapping: -- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const +- :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const -Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. +Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. .. _class_UPNPDevice_delete_port_mapping: -- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const +- :ref:`int` **delete_port_mapping** **(** :ref:`int` port, :ref:`String` proto="UDP" **)** const Deletes the port mapping identified by the given port and protocol combination on this device. See :ref:`UPNP.delete_port_mapping`. @@ -104,8 +103,8 @@ Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentiall .. _class_UPNPDevice_query_external_address: -- :ref:`String` **query_external_address** **(** **)** const +- :ref:`String` **query_external_address** **(** **)** const -Returns the external IP address of this :ref:`UPNPDevice` or an empty string. +Returns the external IP address of this :ref:`UPNPDevice` or an empty string. diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 18f33a482..64149059c 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -7,8 +7,7 @@ VBoxContainer ============= -**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Vertical box container. Description ----------- -Vertical box container. See :ref:`BoxContainer`. +Vertical box container. See :ref:`BoxContainer`. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index f1c24f28e..b66d8d6fb 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -14,39 +14,39 @@ Brief Description Vector used for 2D math. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | +| :ref:`Vector2` | :ref:`Vector2` **(** :ref:`float` x, :ref:`float` y **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`abs` **(** **)** | +| :ref:`Vector2` | :ref:`abs` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angle` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector2` to **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | +| :ref:`float` | :ref:`angle_to_point` **(** :ref:`Vector2` to **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`aspect` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | +| :ref:`Vector2` | :ref:`bounce` **(** :ref:`Vector2` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`ceil` **(** **)** | +| :ref:`Vector2` | :ref:`ceil` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | +| :ref:`Vector2` | :ref:`clamped` **(** :ref:`float` length **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`cross` **(** :ref:`Vector2` with **)** | +| :ref:`float` | :ref:`cross` **(** :ref:`Vector2` with **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | +| :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | +| :ref:`float` | :ref:`dot` **(** :ref:`Vector2` with **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`floor` **(** **)** | +| :ref:`Vector2` | :ref:`floor` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,48 +54,36 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | +| :ref:`Vector2` | :ref:`linear_interpolate` **(** :ref:`Vector2` b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`normalized` **(** **)** | +| :ref:`Vector2` | :ref:`normalized` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** | +| :ref:`Vector2` | :ref:`project` **(** :ref:`Vector2` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | +| :ref:`Vector2` | :ref:`reflect` **(** :ref:`Vector2` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | +| :ref:`Vector2` | :ref:`rotated` **(** :ref:`float` phi **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`round` **(** **)** | +| :ref:`Vector2` | :ref:`round` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slerp` **(** :ref:`Vector2` b, :ref:`float` t **)** | +| :ref:`Vector2` | :ref:`slerp` **(** :ref:`Vector2` b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | +| :ref:`Vector2` | :ref:`slide` **(** :ref:`Vector2` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | +| :ref:`Vector2` | :ref:`snapped` **(** :ref:`Vector2` by **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tangent` **(** **)** | +| :ref:`Vector2` | :ref:`tangent` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- - .. _class_Vector2_x: - -- :ref:`float` **x** - The vector's x component. - - .. _class_Vector2_y: - -- :ref:`float` **y** - The vector's y component. - - -Numeric Constants ------------------ - -- **ZERO** = **Vector2( 0, 0 )** -- **INF** = **Vector2( inf, inf )** -- **LEFT** = **Vector2( -1, 0 )** -- **RIGHT** = **Vector2( 1, 0 )** -- **UP** = **Vector2( 0, -1 )** -- **DOWN** = **Vector2( 0, 1 )** +- **ZERO** = **Vector2( 0, 0 )** --- Null vector. +- **INF** = **Vector2( inf, inf )** --- Infinite vector. +- **LEFT** = **Vector2( -1, 0 )** --- Left unit vector. +- **RIGHT** = **Vector2( 1, 0 )** --- Right unit vector. +- **UP** = **Vector2( 0, -1 )** --- Up unit vector. +- **DOWN** = **Vector2( 0, 1 )** --- Down unit vector. Description ----------- @@ -107,18 +95,30 @@ Tutorials - :doc:`../tutorials/math/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Vector2_x: + +- :ref:`float` **x** - The vector's x component. + + .. _class_Vector2_y: + +- :ref:`float` **y** - The vector's y component. + + +Method Descriptions +------------------- .. _class_Vector2_Vector2: -- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** Constructs a new Vector2 from the given x and y. .. _class_Vector2_abs: -- :ref:`Vector2` **abs** **(** **)** +- :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). @@ -132,13 +132,13 @@ Equivalent to the result of atan2 when called with the vector's x and y as param .. _class_Vector2_angle_to: -- :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** Returns the angle in radians between the two vectors. .. _class_Vector2_angle_to_point: -- :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** +- :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** Returns the angle in radians between the line connecting the two points and the x coordinate. @@ -150,55 +150,55 @@ Returns the ratio of x to y. .. _class_Vector2_bounce: -- :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** Returns the vector "bounced off" from a plane defined by the given normal. .. _class_Vector2_ceil: -- :ref:`Vector2` **ceil** **(** **)** +- :ref:`Vector2` **ceil** **(** **)** Returns the vector with all components rounded up. .. _class_Vector2_clamped: -- :ref:`Vector2` **clamped** **(** :ref:`float` length **)** +- :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. .. _class_Vector2_cross: -- :ref:`float` **cross** **(** :ref:`Vector2` with **)** +- :ref:`float` **cross** **(** :ref:`Vector2` with **)** Returns the 2 dimensional analog of the cross product with the given vector. .. _class_Vector2_cubic_interpolate: -- :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** +- :ref:`Vector2` **cubic_interpolate** **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** -Cubicly interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``t``. ``t`` is in the range of ``0.0 - 1.0``, or a percentage of how far along the interpolation is. +Cubicly interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. .. _class_Vector2_distance_squared_to: -- :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** Returns the squared distance to vector ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. .. _class_Vector2_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** +- :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector ``b``. .. _class_Vector2_dot: -- :ref:`float` **dot** **(** :ref:`Vector2` with **)** +- :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector ``b``. .. _class_Vector2_floor: -- :ref:`Vector2` **floor** **(** **)** +- :ref:`Vector2` **floor** **(** **)** Returns the vector with all components rounded down. @@ -222,63 +222,63 @@ Returns the vector's length squared. Prefer this function over :ref:`length` **linear_interpolate** **(** :ref:`Vector2` b, :ref:`float` t **)** +- :ref:`Vector2` **linear_interpolate** **(** :ref:`Vector2` b, :ref:`float` t **)** -Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, a percentage of how far along the interpolation is. +Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. .. _class_Vector2_normalized: -- :ref:`Vector2` **normalized** **(** **)** +- :ref:`Vector2` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. .. _class_Vector2_project: -- :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** +- :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** Returns the vector projected onto the vector ``b``. .. _class_Vector2_reflect: -- :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Returns the vector reflected from a plane defined by the given normal. .. _class_Vector2_rotated: -- :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** +- :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Returns the vector rotated by ``phi`` radians. .. _class_Vector2_round: -- :ref:`Vector2` **round** **(** **)** +- :ref:`Vector2` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. .. _class_Vector2_slerp: -- :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** +- :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** -Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. +Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. Both vectors need to be normalized. .. _class_Vector2_slide: -- :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** +- :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** Returns the component of the vector along a plane defined by the given normal. .. _class_Vector2_snapped: -- :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** +- :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Returns the vector snapped to a grid with the given size. .. _class_Vector2_tangent: -- :ref:`Vector2` **tangent** **(** **)** +- :ref:`Vector2` **tangent** **(** **)** Returns a perpendicular vector. diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 4e73d222e..f99013830 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -14,33 +14,33 @@ Brief Description Vector class, which performs basic 3D vector math operations. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | +| :ref:`Vector3` | :ref:`Vector3` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`abs` **(** **)** | +| :ref:`Vector3` | :ref:`abs` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | +| :ref:`float` | :ref:`angle_to` **(** :ref:`Vector3` to **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | +| :ref:`Vector3` | :ref:`bounce` **(** :ref:`Vector3` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`ceil` **(** **)** | +| :ref:`Vector3` | :ref:`ceil` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | +| :ref:`Vector3` | :ref:`cross` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | +| :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | +| :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | +| :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | +| :ref:`float` | :ref:`dot` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`floor` **(** **)** | +| :ref:`Vector3` | :ref:`floor` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`inverse` **(** **)** | +| :ref:`Vector3` | :ref:`inverse` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -48,35 +48,60 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | +| :ref:`Vector3` | :ref:`linear_interpolate` **(** :ref:`Vector3` b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`normalized` **(** **)** | +| :ref:`Vector3` | :ref:`normalized` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | +| :ref:`Basis` | :ref:`outer` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** | +| :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` b **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | +| :ref:`Vector3` | :ref:`reflect` **(** :ref:`Vector3` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +| :ref:`Vector3` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`round` **(** **)** | +| :ref:`Vector3` | :ref:`round` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slerp` **(** :ref:`Vector3` b, :ref:`float` t **)** | +| :ref:`Vector3` | :ref:`slerp` **(** :ref:`Vector3` b, :ref:`float` t **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | +| :ref:`Vector3` | :ref:`slide` **(** :ref:`Vector3` n **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` by **)** | +| :ref:`Vector3` | :ref:`snapped` **(** :ref:`Vector3` by **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | +| :ref:`Basis` | :ref:`to_diagonal_matrix` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Constants +--------- + +- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis` and :ref:`min_axis`. +- **AXIS_Y** = **1** --- Enumerated value for the Y axis. +- **AXIS_Z** = **2** --- Enumerated value for the Z axis. +- **ZERO** = **Vector3( 0, 0, 0 )** --- Null vector. +- **INF** = **Vector3( inf, inf, inf )** --- Infinite vector. +- **LEFT** = **Vector3( -1, 0, 0 )** --- Left unit vector. +- **RIGHT** = **Vector3( 1, 0, 0 )** --- Right unit vector. +- **UP** = **Vector3( 0, 1, 0 )** --- Up unit vector. +- **DOWN** = **Vector3( 0, -1, 0 )** --- Down unit vector. +- **FORWARD** = **Vector3( 0, 0, -1 )** --- Forward unit vector. +- **BACK** = **Vector3( 0, 0, 1 )** --- Back unit vector. + +Description +----------- + +Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. + +Tutorials +--------- + +- :doc:`../tutorials/math/index` + +Property Descriptions +--------------------- .. _class_Vector3_x: @@ -91,103 +116,78 @@ Member Variables - :ref:`float` **z** - The vector's z component. -Numeric Constants ------------------ - -- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis` and :ref:`min_axis`. -- **AXIS_Y** = **1** --- Enumerated value for the Y axis. -- **AXIS_Z** = **2** --- Enumerated value for the Z axis. -- **ZERO** = **Vector3( 0, 0, 0 )** -- **INF** = **Vector3( inf, inf, inf )** -- **LEFT** = **Vector3( -1, 0, 0 )** -- **RIGHT** = **Vector3( 1, 0, 0 )** -- **UP** = **Vector3( 0, 1, 0 )** -- **DOWN** = **Vector3( 0, -1, 0 )** -- **FORWARD** = **Vector3( 0, 0, -1 )** -- **BACK** = **Vector3( 0, 0, 1 )** - -Description ------------ - -Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. - -Tutorials ---------- - -- :doc:`../tutorials/math/index` - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_Vector3_Vector3: -- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** +- :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns a Vector3 with the given components. .. _class_Vector3_abs: -- :ref:`Vector3` **abs** **(** **)** +- :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). .. _class_Vector3_angle_to: -- :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** +- :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** Returns the minimum angle to the given vector. .. _class_Vector3_bounce: -- :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** Returns the vector "bounced off" from a plane defined by the given normal. .. _class_Vector3_ceil: -- :ref:`Vector3` **ceil** **(** **)** +- :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. .. _class_Vector3_cross: -- :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** +- :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Returns the cross product with ``b``. .. _class_Vector3_cubic_interpolate: -- :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** +- :ref:`Vector3` **cubic_interpolate** **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** -Performs a cubic interpolation between vectors ``pre_a``, ``a``, ``b``, ``post_b`` (``a`` is current), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is. +Performs a cubic interpolation between vectors ``pre_a``, ``a``, ``b``, ``post_b`` (``a`` is current), by the given amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. .. _class_Vector3_distance_squared_to: -- :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** +- :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** Returns the squared distance to ``b``. Prefer this function over :ref:`distance_to` if you need to sort vectors or need the squared distance for some formula. .. _class_Vector3_distance_to: -- :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** +- :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Returns the distance to ``b``. .. _class_Vector3_dot: -- :ref:`float` **dot** **(** :ref:`Vector3` b **)** +- :ref:`float` **dot** **(** :ref:`Vector3` b **)** Returns the dot product with ``b``. .. _class_Vector3_floor: -- :ref:`Vector3` **floor** **(** **)** +- :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. .. _class_Vector3_inverse: -- :ref:`Vector3` **inverse** **(** **)** +- :ref:`Vector3` **inverse** **(** **)** Returns the inverse of the vector. This is the same as ``Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )``. @@ -211,9 +211,9 @@ Returns the vector's length squared. Prefer this function over :ref:`length` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** +- :ref:`Vector3` **linear_interpolate** **(** :ref:`Vector3` b, :ref:`float` t **)** -Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, a percentage of how far along the interpolation is. +Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation.. .. _class_Vector3_max_axis: @@ -229,63 +229,63 @@ Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. .. _class_Vector3_normalized: -- :ref:`Vector3` **normalized** **(** **)** +- :ref:`Vector3` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. .. _class_Vector3_outer: -- :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** +- :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Returns the outer product with ``b``. .. _class_Vector3_project: -- :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** +- :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** Returns the vector projected onto the vector ``b``. .. _class_Vector3_reflect: -- :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Returns the vector reflected from a plane defined by the given normal. .. _class_Vector3_rotated: -- :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** +- :ref:`Vector3` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** Rotates the vector around a given axis by ``phi`` radians. The axis must be a normalized vector. .. _class_Vector3_round: -- :ref:`Vector3` **round** **(** **)** +- :ref:`Vector3` **round** **(** **)** Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. .. _class_Vector3_slerp: -- :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** +- :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** -Returns the result of SLERP between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is. +Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. Both vectors need to be normalized. .. _class_Vector3_slide: -- :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** +- :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** Returns the component of the vector along a plane defined by the given normal. .. _class_Vector3_snapped: -- :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** +- :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** Returns a copy of the vector, snapped to the lowest neared multiple. .. _class_Vector3_to_diagonal_matrix: -- :ref:`Basis` **to_diagonal_matrix** **(** **)** +- :ref:`Basis` **to_diagonal_matrix** **(** **)** Returns a diagonal matrix with the vector as main diagonal. diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index a068225b6..608091d39 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -7,8 +7,7 @@ VehicleBody =========== -**Inherits:** :ref:`RigidBody` **<** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`RigidBody` **<** :ref:`PhysicsBody` **<** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,15 @@ Brief Description Physics body that simulates the behaviour of a car. -Member Variables ----------------- +Description +----------- + +This nodes implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a :ref:`CollisionShape` for the main body of your vehicle and add :ref:`VehicleWheel` nodes for the wheels. You should also add a :ref:`MeshInstance` to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the :ref:`brake`, :ref:`engine_force`, and :ref:`steering` properties and not change the position or orientation of this node directly. + +Note that the origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the :ref:`CollisionShape` and :ref:`MeshInstance` upwards. + +Property Descriptions +--------------------- .. _class_VehicleBody_brake: @@ -34,10 +40,3 @@ A negative value will result in the vehicle reversing. - :ref:`float` **steering** - The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel.set_use_as_steering` set to true will automatically be rotated. -Description ------------ - -This nodes implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a :ref:`CollisionShape` for the main body of your vehicle and add :ref:`VehicleWheel` nodes for the wheels. You should also add a :ref:`MeshInstance` to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the :ref:`brake`, :ref:`engine_force`, and :ref:`steering` properties and not change the position or orientation of this node directly. - -Note that the origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the :ref:`CollisionShape` and :ref:`MeshInstance` upwards. - diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index c831e11fd..2338e7fee 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -7,8 +7,7 @@ VehicleWheel ============ -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description Physics object that simulates the behaviour of a wheel. -Member Functions ----------------- +Methods +------- +----------------------------+--------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_skidinfo` **(** **)** const | @@ -25,8 +24,13 @@ Member Functions | :ref:`bool` | :ref:`is_in_contact` **(** **)** const | +----------------------------+--------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +This node needs to be used as a child node of :ref:`VehicleBody` and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. + +Property Descriptions +--------------------- .. _class_VehicleWheel_damping_compression: @@ -38,7 +42,7 @@ Member Variables .. _class_VehicleWheel_suspension_max_force: -- :ref:`float` **suspension_max_force** - The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. +- :ref:`float` **suspension_max_force** - The maximum force the spring can resist. This value should be higher than a quarter of the :ref:`RigidBody.mass` of the :ref:`VehicleBody` or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3x to 4x this number. .. _class_VehicleWheel_suspension_stiffness: @@ -75,13 +79,8 @@ It's best to set this to 1.0 when starting out. - :ref:`float` **wheel_roll_influence** - This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll. -Description ------------ - -This node needs to be used as a child node of :ref:`VehicleBody` and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VehicleWheel_get_skidinfo: diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 957684c08..588c5d66b 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -7,8 +7,7 @@ VideoPlayer =========== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description Control for playing video streams. -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_stream_name` **(** **)** const | +| :ref:`String` | :ref:`get_stream_name` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | +| :ref:`Texture` | :ref:`get_video_texture` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------+ @@ -41,8 +40,13 @@ Signals Emitted when playback is finished. -Member Variables ----------------- +Description +----------- + +Control node for playing video streams. Supported formats are WebM and OGV Theora. + +Property Descriptions +--------------------- .. _class_VideoPlayer_audio_track: @@ -58,7 +62,7 @@ Member Variables .. _class_VideoPlayer_bus: -- :ref:`String` **bus** - Audio bus to use for sound playback. +- :ref:`String` **bus** - Audio bus to use for sound playback. .. _class_VideoPlayer_expand: @@ -70,7 +74,7 @@ Member Variables .. _class_VideoPlayer_stream: -- :ref:`VideoStream` **stream** +- :ref:`VideoStream` **stream** .. _class_VideoPlayer_stream_position: @@ -85,25 +89,20 @@ Member Variables - :ref:`float` **volume_db** - Audio volume in dB. -Description ------------ - -Control node for playing video streams. Supported formats are WebM and OGV Theora. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VideoPlayer_get_stream_name: -- :ref:`String` **get_stream_name** **(** **)** const +- :ref:`String` **get_stream_name** **(** **)** const Returns the video stream's name. .. _class_VideoPlayer_get_video_texture: -- :ref:`Texture` **get_video_texture** **(** **)** +- :ref:`Texture` **get_video_texture** **(** **)** -Returns the current frame as a :ref:`Texture`. +Returns the current frame as a :ref:`Texture`. .. _class_VideoPlayer_is_playing: diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index b1f17f988..735fc8039 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -7,14 +7,12 @@ VideoStream =========== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VideoStreamWebm`, :ref:`VideoStreamTheora` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VideoStreamWebm`, :ref:`VideoStreamTheora` **Category:** Core Brief Description ----------------- - +Base resource for video streams. diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index f9be83285..fc522ed76 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -7,8 +7,7 @@ VideoStreamTheora ================= -**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,24 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | +| :ref:`String` | :ref:`get_file` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------+ -| void | :ref:`set_file` **(** :ref:`String` file **)** | +| void | :ref:`set_file` **(** :ref:`String` file **)** | +------------------------------+------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VideoStreamTheora_get_file: -- :ref:`String` **get_file** **(** **)** +- :ref:`String` **get_file** **(** **)** .. _class_VideoStreamTheora_set_file: -- void **set_file** **(** :ref:`String` file **)** +- void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 90ca19868..ce2ed3567 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -7,8 +7,7 @@ VideoStreamWebm =============== -**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VideoStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,24 @@ Brief Description -Member Functions ----------------- +Methods +------- +------------------------------+----------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_file` **(** **)** | +| :ref:`String` | :ref:`get_file` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------+ -| void | :ref:`set_file` **(** :ref:`String` file **)** | +| void | :ref:`set_file` **(** :ref:`String` file **)** | +------------------------------+----------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VideoStreamWebm_get_file: -- :ref:`String` **get_file** **(** **)** +- :ref:`String` **get_file** **(** **)** .. _class_VideoStreamWebm_set_file: -- void **set_file** **(** :ref:`String` file **)** +- void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 9a3e16ced..e10948639 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -7,8 +7,7 @@ Viewport ======== -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,51 +15,53 @@ Brief Description Creates a sub-view into the screen. -Member Functions ----------------- +Methods +------- +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`find_world` **(** **)** const | +| :ref:`World` | :ref:`find_world` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | +| :ref:`World2D` | :ref:`find_world_2d` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Camera` | :ref:`get_camera` **(** **)** const | +| :ref:`Camera` | :ref:`get_camera` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | +| :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | +| :ref:`Vector2` | :ref:`get_size_override` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | +| :ref:`ViewportTexture` | :ref:`get_texture` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | +| :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | +| :ref:`Rect2` | :ref:`get_visible_rect` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +| :ref:`Variant` | :ref:`gui_get_drag_data` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui_has_modal_stack` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | +| :ref:`bool` | :ref:`gui_is_dragging` **(** **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_size_override_enabled` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | +| void | :ref:`set_attach_to_screen_rect` **(** :ref:`Rect2` rect **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | +| void | :ref:`set_size_override` **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_worlds` **(** **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -73,120 +74,8 @@ Signals Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. -Member Variables ----------------- - - .. _class_Viewport_arvr: - -- :ref:`bool` **arvr** - If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. - - .. _class_Viewport_audio_listener_enable_2d: - -- :ref:`bool` **audio_listener_enable_2d** - If ``true`` the viewport will process 2D audio streams. Default value: ``false``. - - .. _class_Viewport_audio_listener_enable_3d: - -- :ref:`bool` **audio_listener_enable_3d** - If ``true`` the viewport will process 3D audio streams. Default value: ``false``. - - .. _class_Viewport_canvas_transform: - -- :ref:`Transform2D` **canvas_transform** - The canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. - - .. _class_Viewport_debug_draw: - -- :ref:`DebugDraw` **debug_draw** - The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. - - .. _class_Viewport_disable_3d: - -- :ref:`bool` **disable_3d** - If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. - - .. _class_Viewport_global_canvas_transform: - -- :ref:`Transform2D` **global_canvas_transform** - The global canvas transform of the viewport. The canvas transform is relative to this. - - .. _class_Viewport_gui_disable_input: - -- :ref:`bool` **gui_disable_input** - If ``true`` the viewport will not receive input event. Default value: ``false``. - - .. _class_Viewport_gui_snap_controls_to_pixels: - -- :ref:`bool` **gui_snap_controls_to_pixels** - If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. - - .. _class_Viewport_hdr: - -- :ref:`bool` **hdr** - If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. - - .. _class_Viewport_keep_3d_linear: - -- :ref:`bool` **keep_3d_linear** - If ``true`` the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. - - .. _class_Viewport_msaa: - -- :ref:`MSAA` **msaa** - The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. - - .. _class_Viewport_own_world: - -- :ref:`bool` **own_world** - If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. - - .. _class_Viewport_physics_object_picking: - -- :ref:`bool` **physics_object_picking** - If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. - - .. _class_Viewport_render_target_clear_mode: - -- :ref:`ClearMode` **render_target_clear_mode** - The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. - - .. _class_Viewport_render_target_update_mode: - -- :ref:`UpdateMode` **render_target_update_mode** - The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. - - .. _class_Viewport_render_target_v_flip: - -- :ref:`bool` **render_target_v_flip** - If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. - - .. _class_Viewport_shadow_atlas_quad_0: - -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** - The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. - - .. _class_Viewport_shadow_atlas_quad_1: - -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** - The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. - - .. _class_Viewport_shadow_atlas_quad_2: - -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** - The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. - - .. _class_Viewport_shadow_atlas_quad_3: - -- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** - The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. - - .. _class_Viewport_shadow_atlas_size: - -- :ref:`int` **shadow_atlas_size** - The resolution of shadow atlas. Both width and height is equal to one value. - - .. _class_Viewport_size: - -- :ref:`Vector2` **size** - The width and height of viewport. - - .. _class_Viewport_transparent_bg: - -- :ref:`bool` **transparent_bg** - If ``true`` the viewport should render its background as transparent. Default value: ``false``. - - .. _class_Viewport_usage: - -- :ref:`Usage` **usage** - The rendering mode of viewport. Default value: ``USAGE_3D``. - - .. _class_Viewport_world: - -- :ref:`World` **world** - The custom :ref:`World` which can be used as 3D environment source. - - .. _class_Viewport_world_2d: - -- :ref:`World2D` **world_2d** - The custom :ref:`World2D` which can be used as 2D environment source. - - -Enums ------ +Enumerations +------------ .. _enum_Viewport_UpdateMode: @@ -266,7 +155,7 @@ A Viewport creates a different view into the screen, or a sub-view inside anothe Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. -If a viewport is a child of a :ref:`ViewportContainer`, it will automatically take up its size, otherwise it must be set manually. +If a viewport is a child of a :ref:`ViewportContainer`, it will automatically take up its size, otherwise it must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. @@ -280,72 +169,184 @@ Tutorials - :doc:`../tutorials/2d/2d_transforms` - :doc:`../tutorials/viewports/index` -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_Viewport_arvr: + +- :ref:`bool` **arvr** - If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. + + .. _class_Viewport_audio_listener_enable_2d: + +- :ref:`bool` **audio_listener_enable_2d** - If ``true`` the viewport will process 2D audio streams. Default value: ``false``. + + .. _class_Viewport_audio_listener_enable_3d: + +- :ref:`bool` **audio_listener_enable_3d** - If ``true`` the viewport will process 3D audio streams. Default value: ``false``. + + .. _class_Viewport_canvas_transform: + +- :ref:`Transform2D` **canvas_transform** - The canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. + + .. _class_Viewport_debug_draw: + +- :ref:`DebugDraw` **debug_draw** - The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. + + .. _class_Viewport_disable_3d: + +- :ref:`bool` **disable_3d** - If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. + + .. _class_Viewport_global_canvas_transform: + +- :ref:`Transform2D` **global_canvas_transform** - The global canvas transform of the viewport. The canvas transform is relative to this. + + .. _class_Viewport_gui_disable_input: + +- :ref:`bool` **gui_disable_input** - If ``true`` the viewport will not receive input event. Default value: ``false``. + + .. _class_Viewport_gui_snap_controls_to_pixels: + +- :ref:`bool` **gui_snap_controls_to_pixels** - If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. + + .. _class_Viewport_hdr: + +- :ref:`bool` **hdr** - If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. + + .. _class_Viewport_keep_3d_linear: + +- :ref:`bool` **keep_3d_linear** - If ``true`` the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. + + .. _class_Viewport_msaa: + +- :ref:`MSAA` **msaa** - The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. + + .. _class_Viewport_own_world: + +- :ref:`bool` **own_world** - If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. + + .. _class_Viewport_physics_object_picking: + +- :ref:`bool` **physics_object_picking** - If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. + + .. _class_Viewport_render_target_clear_mode: + +- :ref:`ClearMode` **render_target_clear_mode** - The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. + + .. _class_Viewport_render_target_update_mode: + +- :ref:`UpdateMode` **render_target_update_mode** - The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. + + .. _class_Viewport_render_target_v_flip: + +- :ref:`bool` **render_target_v_flip** - If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. + + .. _class_Viewport_shadow_atlas_quad_0: + +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** - The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. + + .. _class_Viewport_shadow_atlas_quad_1: + +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** - The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. + + .. _class_Viewport_shadow_atlas_quad_2: + +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** - The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. + + .. _class_Viewport_shadow_atlas_quad_3: + +- :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** - The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. + + .. _class_Viewport_shadow_atlas_size: + +- :ref:`int` **shadow_atlas_size** - The resolution of shadow atlas. Both width and height is equal to one value. + + .. _class_Viewport_size: + +- :ref:`Vector2` **size** - The width and height of viewport. + + .. _class_Viewport_transparent_bg: + +- :ref:`bool` **transparent_bg** - If ``true`` the viewport should render its background as transparent. Default value: ``false``. + + .. _class_Viewport_usage: + +- :ref:`Usage` **usage** - The rendering mode of viewport. Default value: ``USAGE_3D``. + + .. _class_Viewport_world: + +- :ref:`World` **world** - The custom :ref:`World` which can be used as 3D environment source. + + .. _class_Viewport_world_2d: + +- :ref:`World2D` **world_2d** - The custom :ref:`World2D` which can be used as 2D environment source. + + +Method Descriptions +------------------- .. _class_Viewport_find_world: -- :ref:`World` **find_world** **(** **)** const +- :ref:`World` **find_world** **(** **)** const Returns the 3D world of the viewport, or if none the world of the parent viewport. .. _class_Viewport_find_world_2d: -- :ref:`World2D` **find_world_2d** **(** **)** const +- :ref:`World2D` **find_world_2d** **(** **)** const Returns the 2D world of the viewport. .. _class_Viewport_get_camera: -- :ref:`Camera` **get_camera** **(** **)** const +- :ref:`Camera` **get_camera** **(** **)** const Returns the active 3D camera. .. _class_Viewport_get_final_transform: -- :ref:`Transform2D` **get_final_transform** **(** **)** const +- :ref:`Transform2D` **get_final_transform** **(** **)** const Returns the total transform of the viewport. .. _class_Viewport_get_mouse_position: -- :ref:`Vector2` **get_mouse_position** **(** **)** const +- :ref:`Vector2` **get_mouse_position** **(** **)** const Returns the mouse position relative to the viewport. .. _class_Viewport_get_render_info: -- :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** +- :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns information about the viewport from the rendering pipeline. .. _class_Viewport_get_size_override: -- :ref:`Vector2` **get_size_override** **(** **)** const +- :ref:`Vector2` **get_size_override** **(** **)** const Returns the size override set with :ref:`set_size_override`. .. _class_Viewport_get_texture: -- :ref:`ViewportTexture` **get_texture** **(** **)** const +- :ref:`ViewportTexture` **get_texture** **(** **)** const Returns the viewport's texture. .. _class_Viewport_get_viewport_rid: -- :ref:`RID` **get_viewport_rid** **(** **)** const +- :ref:`RID` **get_viewport_rid** **(** **)** const -Returns the viewport's RID from the :ref:`VisualServer`. +Returns the viewport's RID from the :ref:`VisualServer`. .. _class_Viewport_get_visible_rect: -- :ref:`Rect2` **get_visible_rect** **(** **)** const +- :ref:`Rect2` **get_visible_rect** **(** **)** const Returns the visible rectangle in global screen coordinates. .. _class_Viewport_gui_get_drag_data: -- :ref:`Variant` **gui_get_drag_data** **(** **)** const +- :ref:`Variant` **gui_get_drag_data** **(** **)** const Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. @@ -355,9 +356,13 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro Returns ``true`` if there are visible modals on-screen. +.. _class_Viewport_gui_is_dragging: + +- :ref:`bool` **gui_is_dragging** **(** **)** const + .. _class_Viewport_input: -- void **input** **(** :ref:`InputEvent` local_event **)** +- void **input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_is_size_override_enabled: @@ -373,11 +378,11 @@ Returns ``true`` if the size stretch override is enabled. See :ref:`set_size_ove .. _class_Viewport_set_attach_to_screen_rect: -- void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** +- void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** .. _class_Viewport_set_size_override: -- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** +- void **set_size_override** **(** :ref:`bool` enable, :ref:`Vector2` size=Vector2( -1, -1 ), :ref:`Vector2` margin=Vector2( 0, 0 ) **)** Sets the size override of the viewport. If the ``enable`` parameter is ``true`` the override is used, otherwise it uses the default size. If the size parameter is ``(-1, -1)``, it won't update the size. @@ -389,7 +394,7 @@ If ``true`` the size override affects stretch as well. .. _class_Viewport_unhandled_input: -- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** +- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** .. _class_Viewport_update_worlds: @@ -399,7 +404,7 @@ Forces update of the 2D and 3D worlds. .. _class_Viewport_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_position **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** Warps the mouse to a position relative to the viewport. diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index ad3cb57d6..9ca80ce0c 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -7,21 +7,25 @@ ViewportContainer ================= -**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- +Control for holding :ref:`Viewport`\ s. +Description +----------- -Member Variables ----------------- +A :ref:`Container` node that holds a :ref:`Viewport`, automatically setting its size. + +Property Descriptions +--------------------- .. _class_ViewportContainer_stretch: -- :ref:`bool` **stretch** +- :ref:`bool` **stretch** - If ``true`` the viewport will be scaled to the control's size. Default value:``false``. .. _class_ViewportContainer_stretch_shrink: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 42368392c..f0d73e765 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -7,27 +7,26 @@ ViewportTexture =============== -**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Texture which displays the content of a :ref:`Viewport`. - -Member Variables ----------------- - - .. _class_ViewportTexture_viewport_path: - -- :ref:`NodePath` **viewport_path** - The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. - +Texture which displays the content of a :ref:`Viewport`. Description ----------- -Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture`. This can be used to mix controls, 2D, and 3D elements in the same scene. +Displays the content of a :ref:`Viewport` node as a dynamic :ref:`Texture`. This can be used to mix controls, 2D, and 3D elements in the same scene. To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` method on the target viewport. +Property Descriptions +--------------------- + + .. _class_ViewportTexture_viewport_path: + +- :ref:`NodePath` **viewport_path** - The path to the :ref:`Viewport` node to display. This is relative to the scene root, not to the node which uses the texture. + + diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index 961e1a80f..88c97deb5 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -7,8 +7,7 @@ VisibilityEnabler ================= -**Inherits:** :ref:`VisibilityNotifier` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisibilityNotifier` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,25 @@ Brief Description Enable certain nodes only when visible. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_VisibilityEnabler_Enabler: + +enum **Enabler** + +- **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. +- **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody` nodes. +- **ENABLER_MAX** = **2** + + +Description +----------- + +The VisibilityEnabler will disable :ref:`RigidBody` and :ref:`AnimationPlayer` nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. + +Property Descriptions +--------------------- .. _class_VisibilityEnabler_freeze_bodies: @@ -28,20 +44,3 @@ Member Variables - :ref:`bool` **pause_animations** -Enums ------ - - .. _enum_VisibilityEnabler_Enabler: - -enum **Enabler** - -- **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. -- **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody` nodes. -- **ENABLER_MAX** = **2** - - -Description ------------ - -The VisibilityEnabler will disable :ref:`RigidBody` and :ref:`AnimationPlayer` nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. - diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 5cc29e1b3..9396fd69c 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -7,8 +7,7 @@ VisibilityEnabler2D =================== -**Inherits:** :ref:`VisibilityNotifier2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`VisibilityNotifier2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,29 @@ Brief Description Enable certain nodes only when visible. -Member Variables ----------------- +Enumerations +------------ + + .. _enum_VisibilityEnabler2D_Enabler: + +enum **Enabler** + +- **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. +- **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody2D` nodes. +- **ENABLER_PAUSE_PARTICLES** = **2** --- This enabler will stop :ref:`Particles2D` nodes. +- **ENABLER_PARENT_PROCESS** = **3** --- This enabler will stop the parent's _process function. +- **ENABLER_PARENT_PHYSICS_PROCESS** = **4** --- This enabler will stop the parent's _physics_process function. +- **ENABLER_PAUSE_ANIMATED_SPRITES** = **5** +- **ENABLER_MAX** = **6** + + +Description +----------- + +The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref:`AnimationPlayer`, and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. + +Property Descriptions +--------------------- .. _class_VisibilityEnabler2D_freeze_bodies: @@ -44,24 +64,3 @@ Member Variables - :ref:`bool` **process_parent** -Enums ------ - - .. _enum_VisibilityEnabler2D_Enabler: - -enum **Enabler** - -- **ENABLER_PAUSE_ANIMATIONS** = **0** --- This enabler will pause :ref:`AnimationPlayer` nodes. -- **ENABLER_FREEZE_BODIES** = **1** --- This enabler will freeze :ref:`RigidBody2D` nodes. -- **ENABLER_PAUSE_PARTICLES** = **2** --- This enabler will stop :ref:`Particles2D` nodes. -- **ENABLER_PARENT_PROCESS** = **3** --- This enabler will stop the parent's _process function. -- **ENABLER_PARENT_PHYSICS_PROCESS** = **4** --- This enabler will stop the parent's _physics_process function. -- **ENABLER_PAUSE_ANIMATED_SPRITES** = **5** -- **ENABLER_MAX** = **6** - - -Description ------------ - -The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref:`AnimationPlayer`, and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. - diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 190f32543..05a8b0afb 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -7,10 +7,8 @@ VisibilityNotifier ================== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`VisibilityEnabler` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`VisibilityEnabler` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Detects when the node is visible on screen. -Member Functions ----------------- +Methods +------- +--------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_screen` **(** **)** const | @@ -30,15 +28,15 @@ Signals .. _class_VisibilityNotifier_camera_entered: -- **camera_entered** **(** :ref:`Object` camera **)** +- **camera_entered** **(** :ref:`Camera` camera **)** -Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. +Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. .. _class_VisibilityNotifier_camera_exited: -- **camera_exited** **(** :ref:`Object` camera **)** +- **camera_exited** **(** :ref:`Camera` camera **)** -Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. +Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. .. _class_VisibilityNotifier_screen_entered: @@ -53,21 +51,21 @@ Emitted when the VisibilityNotifier enters the screen. Emitted when the VisibilityNotifier exits the screen. -Member Variables ----------------- - - .. _class_VisibilityNotifier_aabb: - -- :ref:`AABB` **aabb** - The VisibilityNotifier's bounding box. - - Description ----------- -The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a :ref:`Camera`'s view. +The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a :ref:`Camera`'s view. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_VisibilityNotifier_aabb: + +- :ref:`AABB` **aabb** - The VisibilityNotifier's bounding box. + + +Method Descriptions +------------------- .. _class_VisibilityNotifier_is_on_screen: diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 2c2ca3a1f..43d1af049 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -7,10 +7,8 @@ VisibilityNotifier2D ==================== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`VisibilityEnabler2D` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`VisibilityEnabler2D` **Category:** Core Brief Description @@ -18,8 +16,8 @@ Brief Description Detects when the node is visible on screen. -Member Functions ----------------- +Methods +------- +--------------------------+--------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_screen` **(** **)** const | @@ -42,23 +40,15 @@ Emitted when the VisibilityNotifier2D exits the screen. .. _class_VisibilityNotifier2D_viewport_entered: -- **viewport_entered** **(** :ref:`Object` viewport **)** +- **viewport_entered** **(** :ref:`Viewport` viewport **)** -Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. +Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. .. _class_VisibilityNotifier2D_viewport_exited: -- **viewport_exited** **(** :ref:`Object` viewport **)** +- **viewport_exited** **(** :ref:`Viewport` viewport **)** -Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. - - -Member Variables ----------------- - - .. _class_VisibilityNotifier2D_rect: - -- :ref:`Rect2` **rect** - The VisibilityNotifier2D's bounding rectangle. +Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. Description @@ -66,8 +56,16 @@ Description The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. -Member Function Description ---------------------------- +Property Descriptions +--------------------- + + .. _class_VisibilityNotifier2D_rect: + +- :ref:`Rect2` **rect** - The VisibilityNotifier2D's bounding rectangle. + + +Method Descriptions +------------------- .. _class_VisibilityNotifier2D_is_on_screen: diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 6352d74ee..e88bdc130 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -7,10 +7,8 @@ VisualInstance ============== -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`RootMotionView`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` - +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`BakedLightmap`, :ref:`Light`, :ref:`RootMotionView`, :ref:`ReflectionProbe`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance` **Category:** Core Brief Description @@ -18,39 +16,39 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | +| :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_base` **(** :ref:`RID` base **)** | +| void | :ref:`set_base` **(** :ref:`RID` base **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_mask_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualInstance_layers: - :ref:`int` **layers** - The render layer(s) this VisualInstance is drawn on. -This object will only be visible for :ref:`Camera`\ s whose cull mask includes the render object this VisualInstance is set to. +This object will only be visible for :ref:`Camera`\ s whose cull mask includes the render object this VisualInstance is set to. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualInstance_get_aabb: -- :ref:`AABB` **get_aabb** **(** **)** const +- :ref:`AABB` **get_aabb** **(** **)** const -Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. +Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. .. _class_VisualInstance_get_layer_mask_bit: @@ -58,15 +56,15 @@ Returns the :ref:`AABB` (also known as the bounding box) for this Vi .. _class_VisualInstance_get_transformed_aabb: -- :ref:`AABB` **get_transformed_aabb** **(** **)** const +- :ref:`AABB` **get_transformed_aabb** **(** **)** const -Returns the transformed :ref:`AABB` (also known as the bounding box) for this VisualInstance. +Returns the transformed :ref:`AABB` (also known as the bounding box) for this VisualInstance. -Transformed in this case means the :ref:`AABB` plus the position, rotation, and scale of the :ref:`Spatial`\ s :ref:`Transform` +Transformed in this case means the :ref:`AABB` plus the position, rotation, and scale of the :ref:`Spatial`\ s :ref:`Transform` .. _class_VisualInstance_set_base: -- void **set_base** **(** :ref:`RID` base **)** +- void **set_base** **(** :ref:`RID` base **)** Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood. diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 180358edf..6f47e7123 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -7,8 +7,7 @@ VisualScript ============ -**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,93 +15,93 @@ Brief Description A script implemented in the Visual Script programming environment. -Member Functions ----------------- +Methods +------- +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | +| void | :ref:`add_custom_signal` **(** :ref:`String` name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_function` **(** :ref:`String` name **)** | +| void | :ref:`add_function` **(** :ref:`String` name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | +| void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** | +| void | :ref:`custom_signal_add_argument` **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`custom_signal_get_argument_count` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | +| :ref:`String` | :ref:`custom_signal_get_argument_name` **(** :ref:`String` name, :ref:`int` argidx **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | +| :ref:`Variant.Type` | :ref:`custom_signal_get_argument_type` **(** :ref:`String` name, :ref:`int` argidx **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | +| void | :ref:`custom_signal_remove_argument` **(** :ref:`String` name, :ref:`int` argidx **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | +| void | :ref:`custom_signal_set_argument_name` **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | +| void | :ref:`custom_signal_set_argument_type` **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | +| void | :ref:`custom_signal_swap_argument` **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +| void | :ref:`data_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +| void | :ref:`data_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | +| :ref:`int` | :ref:`get_function_node_id` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | +| :ref:`Vector2` | :ref:`get_function_scroll` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`get_variable_export` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | +| :ref:`Dictionary` | :ref:`get_variable_info` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_custom_signal` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +| :ref:`bool` | :ref:`has_data_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_function` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`bool` | :ref:`has_node` **(** :ref:`String` func, :ref:`int` id **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | +| :ref:`bool` | :ref:`has_sequence_connection` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_variable` **(** :ref:`String` name **)** const | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | +| void | :ref:`remove_custom_signal` **(** :ref:`String` name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_function` **(** :ref:`String` name **)** | +| void | :ref:`remove_function` **(** :ref:`String` name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | +| void | :ref:`remove_node` **(** :ref:`String` func, :ref:`int` id **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_variable` **(** :ref:`String` name **)** | +| void | :ref:`remove_variable` **(** :ref:`String` name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | +| void | :ref:`rename_custom_signal` **(** :ref:`String` name, :ref:`String` new_name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | +| void | :ref:`rename_function` **(** :ref:`String` name, :ref:`String` new_name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | +| void | :ref:`rename_variable` **(** :ref:`String` name, :ref:`String` new_name **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +| void | :ref:`sequence_connect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +| void | :ref:`sequence_disconnect` **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | +| void | :ref:`set_function_scroll` **(** :ref:`String` name, :ref:`Vector2` ofs **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | +| void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | +| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +| void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | +| void | :ref:`set_variable_export` **(** :ref:`String` name, :ref:`bool` enable **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | +| void | :ref:`set_variable_info` **(** :ref:`String` name, :ref:`Dictionary` value **)** | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -110,7 +109,7 @@ Signals .. _class_VisualScript_node_ports_changed: -- **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** +- **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** Emitted when the ports of a node are changed. @@ -129,216 +128,216 @@ Tutorials - :doc:`../getting_started/scripting/visual_script/index` -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScript_add_custom_signal: -- void **add_custom_signal** **(** :ref:`String` name **)** +- void **add_custom_signal** **(** :ref:`String` name **)** Add a custom signal with the specified name to the VisualScript. .. _class_VisualScript_add_function: -- void **add_function** **(** :ref:`String` name **)** +- void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. .. _class_VisualScript_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** Add a node to a function of the VisualScript. .. _class_VisualScript_add_variable: -- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** +- void **add_variable** **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. .. _class_VisualScript_custom_signal_add_argument: -- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** +- void **custom_signal_add_argument** **(** :ref:`String` name, :ref:`Variant.Type` type, :ref:`String` argname, :ref:`int` index=-1 **)** Add an argument to a custom signal added with :ref:`add_custom_signal`. .. _class_VisualScript_custom_signal_get_argument_count: -- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const +- :ref:`int` **custom_signal_get_argument_count** **(** :ref:`String` name **)** const Get the count of a custom signal's arguments. .. _class_VisualScript_custom_signal_get_argument_name: -- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`String` **custom_signal_get_argument_name** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the name of a custom signal's argument. .. _class_VisualScript_custom_signal_get_argument_type: -- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const +- :ref:`Variant.Type` **custom_signal_get_argument_type** **(** :ref:`String` name, :ref:`int` argidx **)** const Get the type of a custom signal's argument. .. _class_VisualScript_custom_signal_remove_argument: -- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** +- void **custom_signal_remove_argument** **(** :ref:`String` name, :ref:`int` argidx **)** Remove a specific custom signal's argument. .. _class_VisualScript_custom_signal_set_argument_name: -- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** +- void **custom_signal_set_argument_name** **(** :ref:`String` name, :ref:`int` argidx, :ref:`String` argname **)** Rename a custom signal's argument. .. _class_VisualScript_custom_signal_set_argument_type: -- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** +- void **custom_signal_set_argument_type** **(** :ref:`String` name, :ref:`int` argidx, :ref:`Variant.Type` type **)** Change the type of a custom signal's argument. .. _class_VisualScript_custom_signal_swap_argument: -- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** +- void **custom_signal_swap_argument** **(** :ref:`String` name, :ref:`int` argidx, :ref:`int` withidx **)** Swap two of the arguments of a custom signal. .. _class_VisualScript_data_connect: -- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Connect two data ports. The value of ``from_node``'s ``from_port`` would be fed into ``to_node``'s ``to_port``. .. _class_VisualScript_data_disconnect: -- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **data_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** Disconnect two data ports previously connected with :ref:`data_connect`. .. _class_VisualScript_get_function_node_id: -- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const +- :ref:`int` **get_function_node_id** **(** :ref:`String` name **)** const Returns the id of a function's entry point node. .. _class_VisualScript_get_function_scroll: -- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const +- :ref:`Vector2` **get_function_scroll** **(** :ref:`String` name **)** const Returns the position of the center of the screen for a given function. .. _class_VisualScript_get_node: -- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node given its id and its function. .. _class_VisualScript_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const Returns a node's position in pixels. .. _class_VisualScript_get_variable_default_value: -- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const Returns the default (initial) value of a variable. .. _class_VisualScript_get_variable_export: -- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const +- :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const Returns whether a variable is exported. .. _class_VisualScript_get_variable_info: -- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const +- :ref:`Dictionary` **get_variable_info** **(** :ref:`String` name **)** const Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage. .. _class_VisualScript_has_custom_signal: -- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const +- :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const Returns whether a signal exists with the specified name. .. _class_VisualScript_has_data_connection: -- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **has_data_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const Returns whether the specified data ports are connected. .. _class_VisualScript_has_function: -- :ref:`bool` **has_function** **(** :ref:`String` name **)** const +- :ref:`bool` **has_function** **(** :ref:`String` name **)** const Returns whether a function exists with the specified name. .. _class_VisualScript_has_node: -- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`bool` **has_node** **(** :ref:`String` func, :ref:`int` id **)** const Returns whether a node exists with the given id. .. _class_VisualScript_has_sequence_connection: -- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const +- :ref:`bool` **has_sequence_connection** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** const Returns whether the specified sequence ports are connected. .. _class_VisualScript_has_variable: -- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const +- :ref:`bool` **has_variable** **(** :ref:`String` name **)** const Returns whether a variable exists with the specified name. .. _class_VisualScript_remove_custom_signal: -- void **remove_custom_signal** **(** :ref:`String` name **)** +- void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. .. _class_VisualScript_remove_function: -- void **remove_function** **(** :ref:`String` name **)** +- void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. .. _class_VisualScript_remove_node: -- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** +- void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. .. _class_VisualScript_remove_variable: -- void **remove_variable** **(** :ref:`String` name **)** +- void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. .. _class_VisualScript_rename_custom_signal: -- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a custom signal. .. _class_VisualScript_rename_function: -- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. .. _class_VisualScript_rename_variable: -- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** +- void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. .. _class_VisualScript_sequence_connect: -- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Connect two sequence ports. The execution will flow from of ``from_node``'s ``from_output`` into ``to_node``. @@ -346,43 +345,43 @@ Unlike :ref:`data_connect`, there isn't a ``to_ .. _class_VisualScript_sequence_disconnect: -- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** +- void **sequence_disconnect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** Disconnect two sequence ports previously connected with :ref:`sequence_connect`. .. _class_VisualScript_set_function_scroll: -- void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** +- void **set_function_scroll** **(** :ref:`String` name, :ref:`Vector2` ofs **)** Position the center of the screen for a function. .. _class_VisualScript_set_instance_base_type: -- void **set_instance_base_type** **(** :ref:`String` type **)** +- void **set_instance_base_type** **(** :ref:`String` type **)** Set the base type of the script. .. _class_VisualScript_set_node_position: -- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** Position a node on the screen. .. _class_VisualScript_set_variable_default_value: -- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** +- void **set_variable_default_value** **(** :ref:`String` name, :ref:`Variant` value **)** Change the default (initial) value of a variable. .. _class_VisualScript_set_variable_export: -- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** +- void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** Change whether a variable is exported. .. _class_VisualScript_set_variable_info: -- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** +- void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** Set a variable's info, using the same format as :ref:`get_variable_info`. diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index a0c99055c..9f45bdffa 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -7,8 +7,7 @@ VisualScriptBasicTypeConstant ============================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,20 @@ Brief Description A Visual Script node representing a constant from the base types. -Member Variables ----------------- - - .. _class_VisualScriptBasicTypeConstant_basic_type: - -- :ref:`Variant.Type` **basic_type** - The type to get the constant from. - - .. _class_VisualScriptBasicTypeConstant_constant: - -- :ref:`String` **constant** - The name of the constant to return. - - Description ----------- A Visual Script node representing a constant from base types, such as Vector3.AXIS_X. +Property Descriptions +--------------------- + + .. _class_VisualScriptBasicTypeConstant_basic_type: + +- :ref:`Variant.Type` **basic_type** - The type to get the constant from. + + .. _class_VisualScriptBasicTypeConstant_constant: + +- :ref:`String` **constant** - The name of the constant to return. + + diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index fcd3af92a..60a8ae5f3 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -7,8 +7,7 @@ VisualScriptBuiltinFunc ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description A Visual Script node used to call built-in functions. -Member Variables ----------------- - - .. _class_VisualScriptBuiltinFunc_function: - -- :ref:`BuiltinFunc` **function** - The function to be executed. - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptBuiltinFunc_BuiltinFunc: @@ -79,28 +70,36 @@ enum **BuiltinFunc** - **LOGIC_MIN** = **45** --- Return the lesser of the two numbers, also known as their minimum. - **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` - **LOGIC_NEAREST_PO2** = **47** --- Return the nearest power of 2 to the input. -- **OBJ_WEAKREF** = **48** --- Create a :ref:`WeakRef` from the input. -- **FUNC_FUNCREF** = **49** --- Create a :ref:`FuncRef` from the input. +- **OBJ_WEAKREF** = **48** --- Create a :ref:`WeakRef` from the input. +- **FUNC_FUNCREF** = **49** --- Create a :ref:`FuncRef` from the input. - **TYPE_CONVERT** = **50** --- Convert between types. -- **TYPE_OF** = **51** --- Return the type of the input as an integer. Check :ref:`Variant.Type` for the integers that might be returned. -- **TYPE_EXISTS** = **52** --- Checks if a type is registered in the :ref:`ClassDB`. +- **TYPE_OF** = **51** --- Return the type of the input as an integer. Check :ref:`Variant.Type` for the integers that might be returned. +- **TYPE_EXISTS** = **52** --- Checks if a type is registered in the :ref:`ClassDB`. - **TEXT_CHAR** = **53** --- Return a character with the given ascii value. - **TEXT_STR** = **54** --- Convert the input to a string. - **TEXT_PRINT** = **55** --- Print the given string to the output window. - **TEXT_PRINTERR** = **56** --- Print the given string to the standard error output. - **TEXT_PRINTRAW** = **57** --- Print the given string to the standard output, without adding a newline. -- **VAR_TO_STR** = **58** --- Serialize a :ref:`Variant` to a string. -- **STR_TO_VAR** = **59** --- Deserialize a :ref:`Variant` from a string serialized using VAR_TO_STR. -- **VAR_TO_BYTES** = **60** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. -- **BYTES_TO_VAR** = **61** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using VAR_TO_BYTES. -- **COLORN** = **62** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. +- **VAR_TO_STR** = **58** --- Serialize a :ref:`Variant` to a string. +- **STR_TO_VAR** = **59** --- Deserialize a :ref:`Variant` from a string serialized using VAR_TO_STR. +- **VAR_TO_BYTES** = **60** --- Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. +- **BYTES_TO_VAR** = **61** --- Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using VAR_TO_BYTES. +- **COLORN** = **62** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. - **FUNC_MAX** = **63** --- The maximum value the :ref:`function` property can have. Description ----------- -A built-in function used inside a :ref:`VisualScript`. It is usually a math function or an utility function. +A built-in function used inside a :ref:`VisualScript`. It is usually a math function or an utility function. + +See also :ref:`@GDScript`, for the same functions in the GDScript language. + +Property Descriptions +--------------------- + + .. _class_VisualScriptBuiltinFunc_function: + +- :ref:`BuiltinFunc` **function** - The function to be executed. -See also :ref:`@GDScript`, for the same functions in the GDScript language. diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 4e5ac422a..25011b8f8 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -7,8 +7,7 @@ VisualScriptClassConstant ========================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Gets a constant from a given class. -Member Variables ----------------- - - .. _class_VisualScriptClassConstant_base_type: - -- :ref:`String` **base_type** - The constant's parent class. - - .. _class_VisualScriptClassConstant_constant: - -- :ref:`String` **constant** - The constant to return. See the given class for its available constants. - - Description ----------- @@ -41,3 +28,15 @@ none - Data (variant): ``value`` +Property Descriptions +--------------------- + + .. _class_VisualScriptClassConstant_base_type: + +- :ref:`String` **base_type** - The constant's parent class. + + .. _class_VisualScriptClassConstant_constant: + +- :ref:`String` **constant** - The constant to return. See the given class for its available constants. + + diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 038da7676..ba999788b 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -7,8 +7,7 @@ VisualScriptComment =================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,22 +15,6 @@ Brief Description A Visual Script node used to annotate the script. -Member Variables ----------------- - - .. _class_VisualScriptComment_description: - -- :ref:`String` **description** - The text inside the comment node. - - .. _class_VisualScriptComment_size: - -- :ref:`Vector2` **size** - The comment node's size (in pixels). - - .. _class_VisualScriptComment_title: - -- :ref:`String` **title** - The comment node's title. - - Description ----------- @@ -39,3 +22,19 @@ A Visual Script node used to display annotations in the script, so that code may Comment nodes can be resized so they encompass a group of nodes. +Property Descriptions +--------------------- + + .. _class_VisualScriptComment_description: + +- :ref:`String` **description** - The text inside the comment node. + + .. _class_VisualScriptComment_size: + +- :ref:`Vector2` **size** - The comment node's size (in pixels). + + .. _class_VisualScriptComment_title: + +- :ref:`String` **title** - The comment node's title. + + diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index 023c45ada..605878810 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -7,8 +7,7 @@ VisualScriptCondition ===================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 5641e71d7..f3d66ea14 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -7,8 +7,7 @@ VisualScriptConstant ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Gets a contant's value. -Member Variables ----------------- - - .. _class_VisualScriptConstant_type: - -- :ref:`Variant.Type` **type** - The constant's type. - - .. _class_VisualScriptConstant_value: - -- :ref:`Variant` **value** - The constant's value. - - Description ----------- @@ -41,3 +28,15 @@ none - Data (variant): ``get`` +Property Descriptions +--------------------- + + .. _class_VisualScriptConstant_type: + +- :ref:`Variant.Type` **type** - The constant's type. + + .. _class_VisualScriptConstant_value: + +- :ref:`Variant` **value** - The constant's value. + + diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index d69fb419f..5cbd550b1 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -7,8 +7,7 @@ VisualScriptConstructor ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,17 +15,17 @@ Brief Description A Visual Script node which calls a base type constructor. -Member Functions ----------------- +Methods +------- +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | +| :ref:`Dictionary` | :ref:`get_constructor` **(** **)** const | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** const | +| :ref:`Variant.Type` | :ref:`get_constructor_type` **(** **)** const | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | +| void | :ref:`set_constructor` **(** :ref:`Dictionary` constructor **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constructor_type` **(** :ref:`Variant.Type` type **)** | +| void | :ref:`set_constructor_type` **(** :ref:`Variant.Type` type **)** | +------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -34,23 +33,23 @@ Description A Visual Script node which calls a base type constructor. It can be used for type conversion as well. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptConstructor_get_constructor: -- :ref:`Dictionary` **get_constructor** **(** **)** const +- :ref:`Dictionary` **get_constructor** **(** **)** const .. _class_VisualScriptConstructor_get_constructor_type: -- :ref:`Variant.Type` **get_constructor_type** **(** **)** const +- :ref:`Variant.Type` **get_constructor_type** **(** **)** const .. _class_VisualScriptConstructor_set_constructor: -- void **set_constructor** **(** :ref:`Dictionary` constructor **)** +- void **set_constructor** **(** :ref:`Dictionary` constructor **)** .. _class_VisualScriptConstructor_set_constructor_type: -- void **set_constructor_type** **(** :ref:`Variant.Type` type **)** +- void **set_constructor_type** **(** :ref:`Variant.Type` type **)** diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index a7ecc6ad7..1ae5fe3b5 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -7,8 +7,7 @@ VisualScriptCustomNode ====================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,54 +15,41 @@ Brief Description A scripted Visual Script node. -Member Functions ----------------- +Methods +------- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | +| :ref:`String` | :ref:`_get_caption` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_category` **(** **)** virtual | +| :ref:`String` | :ref:`_get_category` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_input_value_port_count` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | +| :ref:`String` | :ref:`_get_input_value_port_name` **(** :ref:`int` idx **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_input_value_port_type` **(** :ref:`int` idx **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_output_sequence_port_count` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | +| :ref:`String` | :ref:`_get_output_sequence_port_text` **(** :ref:`int` idx **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_output_value_port_count` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | +| :ref:`String` | :ref:`_get_output_value_port_name` **(** :ref:`int` idx **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_output_value_port_type` **(** :ref:`int` idx **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_text` **(** **)** virtual | +| :ref:`String` | :ref:`_get_text` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_working_memory_size` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_input_sequence_port` **(** **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual | +| :ref:`Variant` | :ref:`_step` **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Numeric Constants ------------------ - -- **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step` to tell that control should return to it when there is no other node left to execute. - -This is used by :ref:`VisualScriptCondition` to redirect the sequence to the "Done" port after the true/false branch has finished execution. -- **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step` to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. -- **STEP_NO_ADVANCE_BIT** = **67108864** -- **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Hint used by :ref:`_step` to tell that control should stop and exit the function. -- **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step` to tell that the function should be yielded. - -Using this requires you to have at least one working memory slot, which is used for the :ref:`VisualScriptFunctionState`. - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptCustomNode_StartMode: @@ -74,23 +60,36 @@ enum **StartMode** - **START_MODE_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step` is called after resuming from STEP_YIELD_BIT. +Constants +--------- + +- **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step` to tell that control should return to it when there is no other node left to execute. + +This is used by :ref:`VisualScriptCondition` to redirect the sequence to the "Done" port after the true/false branch has finished execution. +- **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step` to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. +- **STEP_NO_ADVANCE_BIT** = **67108864** +- **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Hint used by :ref:`_step` to tell that control should stop and exit the function. +- **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step` to tell that the function should be yielded. + +Using this requires you to have at least one working memory slot, which is used for the :ref:`VisualScriptFunctionState`. + Description ----------- A custom Visual Script node which can be scripted in powerful ways. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptCustomNode__get_caption: -- :ref:`String` **_get_caption** **(** **)** virtual +- :ref:`String` **_get_caption** **(** **)** virtual Return the node's title. .. _class_VisualScriptCustomNode__get_category: -- :ref:`String` **_get_category** **(** **)** virtual +- :ref:`String` **_get_category** **(** **)** virtual Return the node's category. @@ -102,7 +101,7 @@ Return the count of input value ports. .. _class_VisualScriptCustomNode__get_input_value_port_name: -- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified input port's name. @@ -110,7 +109,7 @@ Return the specified input port's name. - :ref:`int` **_get_input_value_port_type** **(** :ref:`int` idx **)** virtual -Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. +Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. .. _class_VisualScriptCustomNode__get_output_sequence_port_count: @@ -120,7 +119,7 @@ Return the amount of output **sequence** ports. .. _class_VisualScriptCustomNode__get_output_sequence_port_text: -- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual Return the specified **sequence** output's name. @@ -132,7 +131,7 @@ Return the amount of output value ports. .. _class_VisualScriptCustomNode__get_output_value_port_name: -- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual +- :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified output's name. @@ -140,11 +139,11 @@ Return the specified output's name. - :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual -Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. +Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. .. _class_VisualScriptCustomNode__get_text: -- :ref:`String` **_get_text** **(** **)** virtual +- :ref:`String` **_get_text** **(** **)** virtual Return the custom node's text, which is shown right next to the input **sequence** port (if there is none, on the place that is usually taken by it). @@ -162,9 +161,9 @@ Return whether the custom node has an input **sequence** port. .. _class_VisualScriptCustomNode__step: -- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual +- :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual -Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String` when there is an error. +Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String` when there is an error. The ``inputs`` array contains the values of the input ports. diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 30b5ea27e..08e41a36b 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -7,8 +7,7 @@ VisualScriptDeconstruct ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description A Visual Script node which deconstructs a base type instance into its parts. -Member Variables ----------------- - - .. _class_VisualScriptDeconstruct_type: - -- :ref:`Variant.Type` **type** - The type to deconstruct. - - Description ----------- A Visual Script node which deconstructs a base type instance into its parts. +Property Descriptions +--------------------- + + .. _class_VisualScriptDeconstruct_type: + +- :ref:`Variant.Type` **type** - The type to deconstruct. + + diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index 4fb228fda..3cd18eb05 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -7,8 +7,7 @@ VisualScriptEditor ================== -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description -Member Functions ----------------- +Methods +------- +-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_custom_node` **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** | +| void | :ref:`add_custom_node` **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** | +-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_custom_node` **(** :ref:`String` name, :ref:`String` category **)** | +| void | :ref:`remove_custom_node` **(** :ref:`String` name, :ref:`String` category **)** | +-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -35,18 +34,18 @@ Signals Emitted when a custom Visual Script node is added or removed. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptEditor_add_custom_node: -- void **add_custom_node** **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** +- void **add_custom_node** **(** :ref:`String` name, :ref:`String` category, :ref:`Script` script **)** Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter. .. _class_VisualScriptEditor_remove_custom_node: -- void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** +- void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 46fc6c829..a7835a9ce 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -7,8 +7,7 @@ VisualScriptEmitSignal ====================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Emits a specified signal. -Member Variables ----------------- - - .. _class_VisualScriptEmitSignal_signal: - -- :ref:`String` **signal** - The signal to emit. - - Description ----------- @@ -37,3 +28,11 @@ Emits a specified signal when it is executed. - Sequence +Property Descriptions +--------------------- + + .. _class_VisualScriptEmitSignal_signal: + +- :ref:`String` **signal** - The signal to emit. + + diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 41f563b41..e02ee50bb 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -7,25 +7,24 @@ VisualScriptEngineSingleton =========================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -A Visual Script node returning a singleton from :ref:`@GlobalScope` - -Member Variables ----------------- - - .. _class_VisualScriptEngineSingleton_constant: - -- :ref:`String` **constant** - The singleton's name. - +A Visual Script node returning a singleton from :ref:`@GlobalScope` Description ----------- -A Visual Script node returning a singleton from :ref:`@GlobalScope` +A Visual Script node returning a singleton from :ref:`@GlobalScope` + +Property Descriptions +--------------------- + + .. _class_VisualScriptEngineSingleton_constant: + +- :ref:`String` **constant** - The singleton's name. + diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst index ade916a95..3c7ab3872 100644 --- a/classes/class_visualscriptexpression.rst +++ b/classes/class_visualscriptexpression.rst @@ -7,8 +7,7 @@ VisualScriptExpression ====================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst index 0c2f54d4c..d45a7b9a8 100644 --- a/classes/class_visualscriptfunction.rst +++ b/classes/class_visualscriptfunction.rst @@ -7,8 +7,7 @@ VisualScriptFunction ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index daff3c812..646aac8eb 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -7,8 +7,7 @@ VisualScriptFunctionCall ======================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,52 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptFunctionCall_base_script: - -- :ref:`String` **base_script** - - .. _class_VisualScriptFunctionCall_base_type: - -- :ref:`String` **base_type** - - .. _class_VisualScriptFunctionCall_basic_type: - -- :ref:`Variant.Type` **basic_type** - - .. _class_VisualScriptFunctionCall_call_mode: - -- :ref:`CallMode` **call_mode** - - .. _class_VisualScriptFunctionCall_function: - -- :ref:`String` **function** - - .. _class_VisualScriptFunctionCall_node_path: - -- :ref:`NodePath` **node_path** - - .. _class_VisualScriptFunctionCall_rpc_call_mode: - -- :ref:`RPCCallMode` **rpc_call_mode** - - .. _class_VisualScriptFunctionCall_singleton: - -- :ref:`String` **singleton** - - .. _class_VisualScriptFunctionCall_use_default_args: - -- :ref:`int` **use_default_args** - - .. _class_VisualScriptFunctionCall_validate: - -- :ref:`bool` **validate** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptFunctionCall_CallMode: @@ -84,3 +39,47 @@ enum **RPCCallMode** - **RPC_UNRELIABLE_TO_ID** = **4** +Property Descriptions +--------------------- + + .. _class_VisualScriptFunctionCall_base_script: + +- :ref:`String` **base_script** + + .. _class_VisualScriptFunctionCall_base_type: + +- :ref:`String` **base_type** + + .. _class_VisualScriptFunctionCall_basic_type: + +- :ref:`Variant.Type` **basic_type** + + .. _class_VisualScriptFunctionCall_call_mode: + +- :ref:`CallMode` **call_mode** + + .. _class_VisualScriptFunctionCall_function: + +- :ref:`String` **function** + + .. _class_VisualScriptFunctionCall_node_path: + +- :ref:`NodePath` **node_path** + + .. _class_VisualScriptFunctionCall_rpc_call_mode: + +- :ref:`RPCCallMode` **rpc_call_mode** + + .. _class_VisualScriptFunctionCall_singleton: + +- :ref:`String` **singleton** + + .. _class_VisualScriptFunctionCall_use_default_args: + +- :ref:`int` **use_default_args** + + .. _class_VisualScriptFunctionCall_validate: + +- :ref:`bool` **validate** + + diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index 23fd87af5..e2ba47e1d 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -7,8 +7,7 @@ VisualScriptFunctionState ========================= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,23 +15,23 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | +| void | :ref:`connect_to_signal` **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | +| :ref:`Variant` | :ref:`resume` **(** :ref:`Array` args=null **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptFunctionState_connect_to_signal: -- void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** +- void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** .. _class_VisualScriptFunctionState_is_valid: @@ -40,6 +39,6 @@ Member Function Description .. _class_VisualScriptFunctionState_resume: -- :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** +- :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 77b119a75..3b3911949 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -7,8 +7,7 @@ VisualScriptGlobalConstant ========================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualScriptGlobalConstant_constant: diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index 24940db02..caf2731c5 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -7,8 +7,7 @@ VisualScriptIndexGet ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 80ffcc12b..6d577a284 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -7,8 +7,7 @@ VisualScriptIndexSet ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 385a25b86..d0eecc73f 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -7,8 +7,7 @@ VisualScriptInputAction ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptInputAction_action: - -- :ref:`String` **action** - - .. _class_VisualScriptInputAction_mode: - -- :ref:`Mode` **mode** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptInputAction_Mode: @@ -41,3 +28,15 @@ enum **Mode** - **MODE_JUST_RELEASED** = **3** +Property Descriptions +--------------------- + + .. _class_VisualScriptInputAction_action: + +- :ref:`String` **action** + + .. _class_VisualScriptInputAction_mode: + +- :ref:`Mode` **mode** + + diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index edab5bdb1..2c479c313 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -7,8 +7,7 @@ VisualScriptIterator ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,7 +18,7 @@ Steps through items in a given input. Description ----------- -This node steps through each item in a given input. Input can be any sequence data type, such as an :ref:`Array` or :ref:`String`. When each item has been processed, execution passed out the ``exit`` Sequence port. +This node steps through each item in a given input. Input can be any sequence data type, such as an :ref:`Array` or :ref:`String`. When each item has been processed, execution passed out the ``exit`` Sequence port. **Input Ports:** diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 75f780739..925383dfd 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -7,8 +7,7 @@ VisualScriptLocalVar ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Gets a local variable's value. -Member Variables ----------------- - - .. _class_VisualScriptLocalVar_type: - -- :ref:`Variant.Type` **type** - The local variable's type. - - .. _class_VisualScriptLocalVar_var_name: - -- :ref:`String` **var_name** - The local variable's name. - - Description ----------- @@ -41,3 +28,15 @@ none - Data (variant): ``get`` +Property Descriptions +--------------------- + + .. _class_VisualScriptLocalVar_type: + +- :ref:`Variant.Type` **type** - The local variable's type. + + .. _class_VisualScriptLocalVar_var_name: + +- :ref:`String` **var_name** - The local variable's name. + + diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 96049192b..5ae83b49f 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -7,8 +7,7 @@ VisualScriptLocalVarSet ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description Changes a local variable's value. -Member Variables ----------------- - - .. _class_VisualScriptLocalVarSet_type: - -- :ref:`Variant.Type` **type** - The local variable's type. - - .. _class_VisualScriptLocalVarSet_var_name: - -- :ref:`String` **var_name** - The local variable's name. - - Description ----------- @@ -45,3 +32,15 @@ Changes a local variable's value to the given input. The new value is also provi - Data (variant): ``get`` +Property Descriptions +--------------------- + + .. _class_VisualScriptLocalVarSet_type: + +- :ref:`Variant.Type` **type** - The local variable's type. + + .. _class_VisualScriptLocalVarSet_var_name: + +- :ref:`String` **var_name** - The local variable's name. + + diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index ef52ded32..aac4a485c 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -7,8 +7,7 @@ VisualScriptMathConstant ======================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description Commonly used mathematical constants. -Member Variables ----------------- - - .. _class_VisualScriptMathConstant_constant: - -- :ref:`MathConstant` **constant** - The math constant. - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptMathConstant_MathConstant: @@ -55,3 +46,11 @@ none - Data (variant): ``get`` +Property Descriptions +--------------------- + + .. _class_VisualScriptMathConstant_constant: + +- :ref:`MathConstant` **constant** - The math constant. + + diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 019fe916e..25ae5fac6 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -7,28 +7,26 @@ VisualScriptNode ================ -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core Brief Description ----------------- -A node which is part of a :ref:`VisualScript`. +A node which is part of a :ref:`VisualScript`. -Member Functions ----------------- +Methods +------- +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | +| :ref:`Variant` | :ref:`get_default_input_value` **(** :ref:`int` port_idx **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | +| :ref:`VisualScript` | :ref:`get_visual_script` **(** **)** const | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ports_changed_notify` **(** **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | +| void | :ref:`set_default_input_value` **(** :ref:`int` port_idx, :ref:`Variant` value **)** | +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -44,32 +42,32 @@ Emitted when the available input/output ports are changed. Description ----------- -A node which is part of a :ref:`VisualScript`. Not to be confused with :ref:`Node`, which is a part of a :ref:`SceneTree`. +A node which is part of a :ref:`VisualScript`. Not to be confused with :ref:`Node`, which is a part of a :ref:`SceneTree`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptNode_get_default_input_value: -- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const +- :ref:`Variant` **get_default_input_value** **(** :ref:`int` port_idx **)** const Returns the default value of a given port. The default value is used when nothing is connected to the port. .. _class_VisualScriptNode_get_visual_script: -- :ref:`VisualScript` **get_visual_script** **(** **)** const +- :ref:`VisualScript` **get_visual_script** **(** **)** const -Returns the :ref:`VisualScript` instance the node is bound to. +Returns the :ref:`VisualScript` instance the node is bound to. .. _class_VisualScriptNode_ports_changed_notify: - void **ports_changed_notify** **(** **)** -Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . +Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . .. _class_VisualScriptNode_set_default_input_value: -- void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** +- void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** Change the default value of a given port. diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 181409e55..aaa745b82 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -7,8 +7,7 @@ VisualScriptOperator ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,6 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptOperator_operator: - -- :ref:`Variant.Operator` **operator** - - .. _class_VisualScriptOperator_type: - -- :ref:`Variant.Type` **type** - - Description ----------- @@ -41,3 +28,15 @@ Description - Data (variant): ``result`` +Property Descriptions +--------------------- + + .. _class_VisualScriptOperator_operator: + +- :ref:`Variant.Operator` **operator** + + .. _class_VisualScriptOperator_type: + +- :ref:`Variant.Type` **type** + + diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index 6bbd06a7a..0b408130a 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -7,27 +7,18 @@ VisualScriptPreload =================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Creates a new :ref:`Resource` or loads one from the filesystem. - -Member Variables ----------------- - - .. _class_VisualScriptPreload_resource: - -- :ref:`Resource` **resource** - The :ref:`Resource` to load. - +Creates a new :ref:`Resource` or loads one from the filesystem. Description ----------- -Creates a new :ref:`Resource` or loads one from the filesystem. +Creates a new :ref:`Resource` or loads one from the filesystem. **Input Ports:** @@ -37,3 +28,11 @@ none - Data (object): ``res`` +Property Descriptions +--------------------- + + .. _class_VisualScriptPreload_resource: + +- :ref:`Resource` **resource** - The :ref:`Resource` to load. + + diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 057a3bffe..94fa5e1a0 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -7,8 +7,7 @@ VisualScriptPropertyGet ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,40 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptPropertyGet_base_script: - -- :ref:`String` **base_script** - - .. _class_VisualScriptPropertyGet_base_type: - -- :ref:`String` **base_type** - - .. _class_VisualScriptPropertyGet_basic_type: - -- :ref:`Variant.Type` **basic_type** - - .. _class_VisualScriptPropertyGet_index: - -- :ref:`String` **index** - - .. _class_VisualScriptPropertyGet_node_path: - -- :ref:`NodePath` **node_path** - - .. _class_VisualScriptPropertyGet_property: - -- :ref:`String` **property** - - .. _class_VisualScriptPropertyGet_set_mode: - -- :ref:`CallMode` **set_mode** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptPropertyGet_CallMode: @@ -60,3 +27,35 @@ enum **CallMode** - **CALL_MODE_INSTANCE** = **2** +Property Descriptions +--------------------- + + .. _class_VisualScriptPropertyGet_base_script: + +- :ref:`String` **base_script** + + .. _class_VisualScriptPropertyGet_base_type: + +- :ref:`String` **base_type** + + .. _class_VisualScriptPropertyGet_basic_type: + +- :ref:`Variant.Type` **basic_type** + + .. _class_VisualScriptPropertyGet_index: + +- :ref:`String` **index** + + .. _class_VisualScriptPropertyGet_node_path: + +- :ref:`NodePath` **node_path** + + .. _class_VisualScriptPropertyGet_property: + +- :ref:`String` **property** + + .. _class_VisualScriptPropertyGet_set_mode: + +- :ref:`CallMode` **set_mode** + + diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 6c0a1329a..835c1961e 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -7,8 +7,7 @@ VisualScriptPropertySet ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,44 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptPropertySet_assign_op: - -- :ref:`AssignOp` **assign_op** - - .. _class_VisualScriptPropertySet_base_script: - -- :ref:`String` **base_script** - - .. _class_VisualScriptPropertySet_base_type: - -- :ref:`String` **base_type** - - .. _class_VisualScriptPropertySet_basic_type: - -- :ref:`Variant.Type` **basic_type** - - .. _class_VisualScriptPropertySet_index: - -- :ref:`String` **index** - - .. _class_VisualScriptPropertySet_node_path: - -- :ref:`NodePath` **node_path** - - .. _class_VisualScriptPropertySet_property: - -- :ref:`String` **property** - - .. _class_VisualScriptPropertySet_set_mode: - -- :ref:`CallMode` **set_mode** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptPropertySet_CallMode: @@ -81,3 +44,39 @@ enum **AssignOp** - **ASSIGN_OP_BIT_XOR** = **10** +Property Descriptions +--------------------- + + .. _class_VisualScriptPropertySet_assign_op: + +- :ref:`AssignOp` **assign_op** + + .. _class_VisualScriptPropertySet_base_script: + +- :ref:`String` **base_script** + + .. _class_VisualScriptPropertySet_base_type: + +- :ref:`String` **base_type** + + .. _class_VisualScriptPropertySet_basic_type: + +- :ref:`Variant.Type` **basic_type** + + .. _class_VisualScriptPropertySet_index: + +- :ref:`String` **index** + + .. _class_VisualScriptPropertySet_node_path: + +- :ref:`NodePath` **node_path** + + .. _class_VisualScriptPropertySet_property: + +- :ref:`String` **property** + + .. _class_VisualScriptPropertySet_set_mode: + +- :ref:`CallMode` **set_mode** + + diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 29adc2cc9..333f02302 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -7,8 +7,7 @@ VisualScriptResourcePath ======================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualScriptResourcePath_path: -- :ref:`String` **path** +- :ref:`String` **path** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 6d6ef25b9..8279f3bc5 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -7,8 +7,7 @@ VisualScriptReturn ================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,22 +15,10 @@ Brief Description Exits a function and returns an optional value. -Member Variables ----------------- - - .. _class_VisualScriptReturn_return_enabled: - -- :ref:`bool` **return_enabled** - If ``true`` the ``return`` input port is available. - - .. _class_VisualScriptReturn_return_type: - -- :ref:`Variant.Type` **return_type** - The return value's data type. - - Description ----------- -Ends the execution of a function and returns control to the calling function. Optionally, it can return a :ref:`Variant` value. +Ends the execution of a function and returns control to the calling function. Optionally, it can return a :ref:`Variant` value. **Input Ports:** @@ -43,3 +30,15 @@ Ends the execution of a function and returns control to the calling function. Op none +Property Descriptions +--------------------- + + .. _class_VisualScriptReturn_return_enabled: + +- :ref:`bool` **return_enabled** - If ``true`` the ``return`` input port is available. + + .. _class_VisualScriptReturn_return_type: + +- :ref:`Variant.Type` **return_type** - The return value's data type. + + diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 32bb6610d..4dae7fedc 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -7,8 +7,7 @@ VisualScriptSceneNode ===================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Node reference. -Member Variables ----------------- - - .. _class_VisualScriptSceneNode_node_path: - -- :ref:`NodePath` **node_path** - The node's path in the scene tree. - - Description ----------- @@ -37,3 +28,11 @@ none - Data: ``node`` (obj) +Property Descriptions +--------------------- + + .. _class_VisualScriptSceneNode_node_path: + +- :ref:`NodePath` **node_path** - The node's path in the scene tree. + + diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 49949944e..9d9acb7a7 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -7,8 +7,7 @@ VisualScriptSceneTree ===================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index bc8c0be27..ce709a31c 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -7,8 +7,7 @@ VisualScriptSelect ================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Chooses between two input values. -Member Variables ----------------- - - .. _class_VisualScriptSelect_type: - -- :ref:`Variant.Type` **type** - The input variables' type. - - Description ----------- @@ -41,3 +32,11 @@ Chooses between two input values based on a Boolean condition. - Data (variant): ``out`` +Property Descriptions +--------------------- + + .. _class_VisualScriptSelect_type: + +- :ref:`Variant.Type` **type** - The input variables' type. + + diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 445c62ce2..0941bdfd9 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -7,8 +7,7 @@ VisualScriptSelf ================ -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 0302a3834..a89d36783 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -7,8 +7,7 @@ VisualScriptSequence ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Executes a series of Sequence ports. -Member Variables ----------------- - - .. _class_VisualScriptSequence_steps: - -- :ref:`int` **steps** - The number of steps in the sequence. - - Description ----------- @@ -41,3 +32,11 @@ Steps through a series of one or more output Sequence ports. The ``current`` dat - Data (int): ``current`` +Property Descriptions +--------------------- + + .. _class_VisualScriptSequence_steps: + +- :ref:`int` **steps** - The number of steps in the sequence. + + diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index 95ef06a27..dc8fb15fc 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -7,8 +7,7 @@ VisualScriptSubCall =================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,18 +15,18 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | +| :ref:`Variant` | :ref:`_subcall` **(** :ref:`Variant` arguments **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualScriptSubCall__subcall: -- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual +- :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index 9b714b774..b452996b8 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -7,8 +7,7 @@ VisualScriptSwitch ================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 61ef94b60..f3a12d9ab 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -7,8 +7,7 @@ VisualScriptTypeCast ==================== -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,15 +15,15 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualScriptTypeCast_base_script: -- :ref:`String` **base_script** +- :ref:`String` **base_script** .. _class_VisualScriptTypeCast_base_type: -- :ref:`String` **base_type** +- :ref:`String` **base_type** diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 6b79cbab2..3ac6d35a1 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -7,8 +7,7 @@ VisualScriptVariableGet ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Gets a variable's value. -Member Variables ----------------- - - .. _class_VisualScriptVariableGet_var_name: - -- :ref:`String` **var_name** - The variable's name. - - Description ----------- @@ -37,3 +28,11 @@ none - Data (variant): ``value`` +Property Descriptions +--------------------- + + .. _class_VisualScriptVariableGet_var_name: + +- :ref:`String` **var_name** - The variable's name. + + diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 96b97e7da..acc628782 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -7,8 +7,7 @@ VisualScriptVariableSet ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,14 +15,6 @@ Brief Description Changes a variable's value. -Member Variables ----------------- - - .. _class_VisualScriptVariableSet_var_name: - -- :ref:`String` **var_name** - The variable's name. - - Description ----------- @@ -39,3 +30,11 @@ Changes a variable's value to the given input. - Sequence +Property Descriptions +--------------------- + + .. _class_VisualScriptVariableSet_var_name: + +- :ref:`String` **var_name** - The variable's name. + + diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index 150730c37..3ae666e42 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -7,8 +7,7 @@ VisualScriptWhile ================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index bcc11425f..455af530d 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -7,8 +7,7 @@ VisualScriptYield ================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptYield_mode: - -- :ref:`YieldMode` **mode** - - .. _class_VisualScriptYield_wait_time: - -- :ref:`float` **wait_time** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptYield_YieldMode: @@ -40,3 +27,15 @@ enum **YieldMode** - **YIELD_WAIT** = **3** +Property Descriptions +--------------------- + + .. _class_VisualScriptYield_mode: + +- :ref:`YieldMode` **mode** + + .. _class_VisualScriptYield_wait_time: + +- :ref:`float` **wait_time** + + diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index b677dbd0b..0449d3244 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -7,8 +7,7 @@ VisualScriptYieldSignal ======================= -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,28 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualScriptYieldSignal_base_type: - -- :ref:`String` **base_type** - - .. _class_VisualScriptYieldSignal_call_mode: - -- :ref:`CallMode` **call_mode** - - .. _class_VisualScriptYieldSignal_node_path: - -- :ref:`NodePath` **node_path** - - .. _class_VisualScriptYieldSignal_signal: - -- :ref:`String` **signal** - - -Enums ------ +Enumerations +------------ .. _enum_VisualScriptYieldSignal_CallMode: @@ -48,3 +27,23 @@ enum **CallMode** - **CALL_MODE_INSTANCE** = **2** +Property Descriptions +--------------------- + + .. _class_VisualScriptYieldSignal_base_type: + +- :ref:`String` **base_type** + + .. _class_VisualScriptYieldSignal_call_mode: + +- :ref:`CallMode` **call_mode** + + .. _class_VisualScriptYieldSignal_node_path: + +- :ref:`NodePath` **node_path** + + .. _class_VisualScriptYieldSignal_signal: + +- :ref:`String` **signal** + + diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 825300660..a8df598f7 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -7,8 +7,7 @@ VisualServer ============ -**Inherits:** :ref:`Object` - +**Inherits:** :ref:`Object` **Category:** Core Brief Description @@ -16,203 +15,203 @@ Brief Description Server for anything visible. -Member Functions ----------------- +Methods +------- +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | +| void | :ref:`black_bars_set_images` **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`black_bars_set_margins` **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | +| :ref:`RID` | :ref:`camera_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | +| :ref:`RID` | :ref:`canvas_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | +| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | +| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | +| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | +| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | +| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | +| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | +| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | +| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | +| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | +| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | +| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | +| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | +| void | :ref:`canvas_light_set_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | +| void | :ref:`canvas_light_set_shadow_buffer_size` **(** :ref:`RID` light, :ref:`int` size **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | +| void | :ref:`canvas_light_set_shadow_gradient_length` **(** :ref:`RID` light, :ref:`float` length **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | +| void | :ref:`canvas_occluder_polygon_set_shape_as_lines` **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`directional_light_create` **(** **)** | +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`environment_create` **(** **)** | +| :ref:`RID` | :ref:`environment_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | +| void | :ref:`environment_set_dof_blur_far` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | +| void | :ref:`environment_set_dof_blur_near` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | +| void | :ref:`environment_set_fog_depth` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | +| void | :ref:`environment_set_fog_height` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`finish` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -220,513 +219,513 @@ Member Functions +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_sync` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | +| :ref:`int` | :ref:`get_render_info` **(** :ref:`RenderInfo` info **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | +| :ref:`RID` | :ref:`gi_probe_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_bias` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | +| :ref:`AABB` | :ref:`gi_probe_get_bounds` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_cell_size` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** const | +| :ref:`PoolIntArray` | :ref:`gi_probe_get_dynamic_data` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** const | +| :ref:`int` | :ref:`gi_probe_get_dynamic_range` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_energy` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_normal_bias` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** const | +| :ref:`float` | :ref:`gi_probe_get_propagation` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** const | +| :ref:`Transform` | :ref:`gi_probe_get_to_cell_xform` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** const | +| :ref:`bool` | :ref:`gi_probe_is_compressed` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** const | +| :ref:`bool` | :ref:`gi_probe_is_interior` **(** :ref:`RID` probe **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | +| void | :ref:`gi_probe_set_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | +| void | :ref:`gi_probe_set_bounds` **(** :ref:`RID` probe, :ref:`AABB` bounds **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | +| void | :ref:`gi_probe_set_cell_size` **(** :ref:`RID` probe, :ref:`float` range **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +| void | :ref:`gi_probe_set_compress` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | +| void | :ref:`gi_probe_set_dynamic_data` **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | +| void | :ref:`gi_probe_set_dynamic_range` **(** :ref:`RID` probe, :ref:`int` range **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | +| void | :ref:`gi_probe_set_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +| void | :ref:`gi_probe_set_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | +| void | :ref:`gi_probe_set_normal_bias` **(** :ref:`RID` probe, :ref:`float` bias **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | +| void | :ref:`gi_probe_set_propagation` **(** :ref:`RID` probe, :ref:`float` propagation **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | +| void | :ref:`gi_probe_set_to_cell_xform` **(** :ref:`RID` probe, :ref:`Transform` xform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_changed` **(** **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | +| void | :ref:`immediate_begin` **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | +| void | :ref:`immediate_clear` **(** :ref:`RID` immediate **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | +| void | :ref:`immediate_color` **(** :ref:`RID` immediate, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_create` **(** **)** | +| :ref:`RID` | :ref:`immediate_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | +| void | :ref:`immediate_end` **(** :ref:`RID` immediate **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | +| :ref:`RID` | :ref:`immediate_get_material` **(** :ref:`RID` immediate **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | +| void | :ref:`immediate_normal` **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | +| void | :ref:`immediate_set_material` **(** :ref:`RID` immediate, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | +| void | :ref:`immediate_tangent` **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | +| void | :ref:`immediate_uv` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | +| void | :ref:`immediate_uv2` **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | +| void | :ref:`immediate_vertex` **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | +| void | :ref:`immediate_vertex_2d` **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`init` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | +| :ref:`RID` | :ref:`instance_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | +| void | :ref:`instance_geometry_set_as_instance_lod` **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | +| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | +| void | :ref:`instance_geometry_set_draw_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | +| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | +| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | +| void | :ref:`instance_set_exterior` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | +| void | :ref:`instance_set_surface_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | +| void | :ref:`instance_set_use_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | +| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | +| :ref:`Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | +| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | +| void | :ref:`light_directional_set_shadow_depth_range_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | +| void | :ref:`light_omni_set_shadow_detail` **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +| void | :ref:`light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | +| :ref:`RID` | :ref:`lightmap_capture_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | +| :ref:`AABB` | :ref:`lightmap_capture_get_bounds` **(** :ref:`RID` capture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | +| :ref:`float` | :ref:`lightmap_capture_get_energy` **(** :ref:`RID` capture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | +| :ref:`PoolByteArray` | :ref:`lightmap_capture_get_octree` **(** :ref:`RID` capture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | +| :ref:`int` | :ref:`lightmap_capture_get_octree_cell_subdiv` **(** :ref:`RID` capture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | +| :ref:`Transform` | :ref:`lightmap_capture_get_octree_cell_transform` **(** :ref:`RID` capture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | +| void | :ref:`lightmap_capture_set_bounds` **(** :ref:`RID` capture, :ref:`AABB` bounds **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | +| void | :ref:`lightmap_capture_set_energy` **(** :ref:`RID` capture, :ref:`float` energy **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | +| void | :ref:`lightmap_capture_set_octree` **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | +| void | :ref:`lightmap_capture_set_octree_cell_subdiv` **(** :ref:`RID` capture, :ref:`int` subdiv **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | +| void | :ref:`lightmap_capture_set_octree_cell_transform` **(** :ref:`RID` capture, :ref:`Transform` xform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | +| :ref:`RID` | :ref:`material_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`String` parameter **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | +| :ref:`RID` | :ref:`material_get_shader` **(** :ref:`RID` shader_material **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | +| void | :ref:`material_set_line_width` **(** :ref:`RID` material, :ref:`float` width **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | +| :ref:`RID` | :ref:`mesh_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | +| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | +| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | +| void | :ref:`mesh_remove_surface` **(** :ref:`RID` mesh, :ref:`int` index **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | +| void | :ref:`mesh_set_blend_shape_count` **(** :ref:`RID` mesh, :ref:`int` amount **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`AABB` | :ref:`mesh_surface_get_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_array_index_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_array_len` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`int` | :ref:`mesh_surface_get_format` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_stride` **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`PoolByteArray` | :ref:`mesh_surface_get_index_array` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`PrimitiveType` | :ref:`mesh_surface_get_primitive_type` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +| :ref:`Array` | :ref:`mesh_surface_get_skeleton_aabb` **(** :ref:`RID` mesh, :ref:`int` surface **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | +| void | :ref:`mesh_surface_update_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | +| void | :ref:`multimesh_allocate` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Transform` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | +| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | +| void | :ref:`multimesh_set_as_bulk_array` **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`omni_light_create` **(** **)** | +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | +| :ref:`RID` | :ref:`particles_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | +| void | :ref:`reflection_probe_set_interior_ambient` **(** :ref:`RID` probe, :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | +| void | :ref:`reflection_probe_set_interior_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | +| void | :ref:`reflection_probe_set_interior_ambient_probe_contribution` **(** :ref:`RID` probe, :ref:`float` contrib **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | +| :ref:`RID` | :ref:`scenario_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | +| void | :ref:`scenario_set_debug` **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | +| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | +| :ref:`RID` | :ref:`shader_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | +| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | +| :ref:`Array` | :ref:`shader_get_param_list` **(** :ref:`RID` shader **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | +| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | +| void | :ref:`skeleton_allocate` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +| :ref:`Transform` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | +| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | +| :ref:`RID` | :ref:`sky_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | +| void | :ref:`sky_set_texture` **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`spot_light_create` **(** **)** | +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sync` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | +| void | :ref:`texture_allocate` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | +| :ref:`RID` | :ref:`texture_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | +| :ref:`Array` | :ref:`texture_debug_usage` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | +| :ref:`Image` | :ref:`texture_get_data` **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_depth` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | +| :ref:`Format` | :ref:`texture_get_format` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | +| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_texid` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** const | +| :ref:`TextureType` | :ref:`texture_get_type` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` texture **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | +| void | :ref:`texture_set_data` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | +| void | :ref:`texture_set_data_partial` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | +| void | :ref:`texture_set_flags` **(** :ref:`RID` texture, :ref:`int` flags **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | +| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | +| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`textures_keep_original` **(** :ref:`bool` enable **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | +| :ref:`RID` | :ref:`viewport_create` **(** **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | +| void | :ref:`viewport_detach` **(** :ref:`RID` viewport **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** const | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | +| void | :ref:`viewport_set_canvas_layer` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | +| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +| void | :ref:`viewport_set_hdr` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | +| void | :ref:`viewport_set_hide_canvas` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | +| void | :ref:`viewport_set_hide_scenario` **(** :ref:`RID` viewport, :ref:`bool` hidden **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | +| void | :ref:`viewport_set_msaa` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | +| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | +| void | :ref:`viewport_set_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | +| void | :ref:`viewport_set_usage` **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | +| void | :ref:`viewport_set_use_arvr` **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +| void | :ref:`viewport_set_vflip` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -741,20 +740,8 @@ Signals - **frame_pre_draw** **(** **)** -Numeric Constants ------------------ - -- **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty. -- **ARRAY_WEIGHTS_SIZE** = **4** -- **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items. -- **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items. -- **MAX_GLOW_LEVELS** = **7** -- **MAX_CURSORS** = **8** -- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials. -- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials. - -Enums ------ +Enumerations +------------ .. _enum_VisualServer_ViewportRenderInfo: @@ -1161,6 +1148,18 @@ enum **EnvironmentToneMapper** - **ENV_TONE_MAPPER_ACES** = **3** +Constants +--------- + +- **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty. +- **ARRAY_WEIGHTS_SIZE** = **4** +- **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items. +- **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items. +- **MAX_GLOW_LEVELS** = **7** +- **MAX_CURSORS** = **8** +- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials. +- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials. + Description ----------- @@ -1168,12 +1167,12 @@ Server for anything visible. The visual server is the API backend for everything The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualServer_black_bars_set_images: -- void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** +- void **black_bars_set_images** **(** :ref:`RID` left, :ref:`RID` top, :ref:`RID` right, :ref:`RID` bottom **)** Sets images to be rendered in the window margin. @@ -1185,435 +1184,435 @@ Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` **camera_create** **(** **)** +- :ref:`RID` **camera_create** **(** **)** .. _class_VisualServer_camera_set_cull_mask: -- void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** +- void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** .. _class_VisualServer_camera_set_environment: -- void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** +- void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** .. _class_VisualServer_camera_set_orthogonal: -- void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** +- void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** .. _class_VisualServer_camera_set_perspective: -- void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** +- void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** .. _class_VisualServer_camera_set_transform: -- void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** +- void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** .. _class_VisualServer_camera_set_use_vertical_aspect: -- void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** +- void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** .. _class_VisualServer_canvas_create: -- :ref:`RID` **canvas_create** **(** **)** +- :ref:`RID` **canvas_create** **(** **)** -Creates a canvas and returns the assigned :ref:`RID`. +Creates a canvas and returns the assigned :ref:`RID`. .. _class_VisualServer_canvas_item_add_circle: -- void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +- void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** -Adds a circle command to the :ref:`CanvasItem`'s draw commands. +Adds a circle command to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_clip_ignore: -- void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** +- void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** If ignore is ``true``, the VisualServer does not perform clipping. .. _class_VisualServer_canvas_item_add_line: -- void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** -Adds a line command to the :ref:`CanvasItem`'s draw commands. +Adds a line command to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_mesh: -- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** +- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** -Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. +Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. .. _class_VisualServer_canvas_item_add_multimesh: -- void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** +- void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** -Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. +Adds a :ref:`MultiMesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. .. _class_VisualServer_canvas_item_add_nine_patch: -- void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** +- void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`RID` normal_map **)** -Adds a nine patch image to the :ref:`CanvasItem`'s draw commands. +Adds a nine patch image to the :ref:`CanvasItem`'s draw commands. -See :ref:`NinePatchRect` for more explanation. +See :ref:`NinePatchRect` for more explanation. .. _class_VisualServer_canvas_item_add_particles: -- void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** +- void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture, :ref:`RID` normal_map, :ref:`int` h_frames, :ref:`int` v_frames **)** -Adds a particles system to the :ref:`CanvasItem`'s draw commands. +Adds a particles system to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_polygon: -- void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`RID` texture, :ref:`RID` normal_map, :ref:`bool` antialiased=false **)** -Adds a polygon to the :ref:`CanvasItem`'s draw commands. +Adds a polygon to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_polyline: -- void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +- void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** -Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem`'s draw commands. +Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_primitive: -- void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** +- void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0, :ref:`RID` normal_map **)** -Adds a primitive to the :ref:`CanvasItem`'s draw commands. +Adds a primitive to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_rect: -- void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** +- void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** -Adds a rectangle to the :ref:`CanvasItem`'s draw commands. +Adds a rectangle to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_set_transform: -- void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +- void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** -Adds a :ref:`Transform2D` command to the :ref:`CanvasItem`'s draw commands. +Adds a :ref:`Transform2D` command to the :ref:`CanvasItem`'s draw commands. This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item. .. _class_VisualServer_canvas_item_add_texture_rect: -- void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** +- void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map **)** -Adds a textured rect to the :ref:`CanvasItem`'s draw commands. +Adds a textured rect to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_texture_rect_region: -- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** +- void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`RID` normal_map, :ref:`bool` clip_uv=true **)** -Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. +Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_canvas_item_add_triangle_array: -- void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** +- void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PoolIntArray` indices, :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`PoolIntArray` bones=PoolIntArray( ), :ref:`PoolRealArray` weights=PoolRealArray( ), :ref:`RID` texture, :ref:`int` count=-1, :ref:`RID` normal_map **)** .. _class_VisualServer_canvas_item_clear: -- void **canvas_item_clear** **(** :ref:`RID` item **)** +- void **canvas_item_clear** **(** :ref:`RID` item **)** -Clears the :ref:`CanvasItem` and removes all commands in it. +Clears the :ref:`CanvasItem` and removes all commands in it. .. _class_VisualServer_canvas_item_create: -- :ref:`RID` **canvas_item_create** **(** **)** +- :ref:`RID` **canvas_item_create** **(** **)** -Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. +Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. .. _class_VisualServer_canvas_item_set_clip: -- void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** +- void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** -Sets clipping for the :ref:`CanvasItem`. +Sets clipping for the :ref:`CanvasItem`. .. _class_VisualServer_canvas_item_set_copy_to_backbuffer: -- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** +- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** -Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. +Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. .. _class_VisualServer_canvas_item_set_custom_rect: -- void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** +- void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ) **)** -Defines a custom drawing rectangle for the :ref:`CanvasItem`. +Defines a custom drawing rectangle for the :ref:`CanvasItem`. .. _class_VisualServer_canvas_item_set_distance_field_mode: -- void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. _class_VisualServer_canvas_item_set_draw_behind_parent: -- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** -Sets :ref:`CanvasItem` to be drawn behind its parent. +Sets :ref:`CanvasItem` to be drawn behind its parent. .. _class_VisualServer_canvas_item_set_draw_index: -- void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** +- void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** -Sets the index for the :ref:`CanvasItem`. +Sets the index for the :ref:`CanvasItem`. .. _class_VisualServer_canvas_item_set_light_mask: -- void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** +- void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** -The light mask. See :ref:`LightOccluder2D` for more information on light masks. +The light mask. See :ref:`LightOccluder2D` for more information on light masks. .. _class_VisualServer_canvas_item_set_material: -- void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** +- void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** -Sets a new material to the :ref:`CanvasItem`. +Sets a new material to the :ref:`CanvasItem`. .. _class_VisualServer_canvas_item_set_modulate: -- void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +- void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** -Sets the color that modulates the :ref:`CanvasItem` and its children. +Sets the color that modulates the :ref:`CanvasItem` and its children. .. _class_VisualServer_canvas_item_set_parent: -- void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** +- void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** -Sets the parent for the :ref:`CanvasItem`. +Sets the parent for the :ref:`CanvasItem`. .. _class_VisualServer_canvas_item_set_self_modulate: -- void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +- void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** -Sets the color that modulates the :ref:`CanvasItem` without children. +Sets the color that modulates the :ref:`CanvasItem` without children. .. _class_VisualServer_canvas_item_set_sort_children_by_y: -- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** -Sets if :ref:`CanvasItem`'s children should be sorted by y-position. +Sets if :ref:`CanvasItem`'s children should be sorted by y-position. .. _class_VisualServer_canvas_item_set_transform: -- void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +- void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** -Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. +Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. .. _class_VisualServer_canvas_item_set_use_parent_material: -- void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** -Sets if the :ref:`CanvasItem` uses its parent's material. +Sets if the :ref:`CanvasItem` uses its parent's material. .. _class_VisualServer_canvas_item_set_visible: -- void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** +- void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** Sets if the canvas item (including its children) is visible. .. _class_VisualServer_canvas_item_set_z_as_relative_to_parent: -- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** If this is enabled, the z-index of the parent will be added to the children's z-index. .. _class_VisualServer_canvas_item_set_z_index: -- void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** +- void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** -Sets the :ref:`CanvasItem`'s z-index, i.e. its draw order (lower indexes are drawn first). +Sets the :ref:`CanvasItem`'s z-index, i.e. its draw order (lower indexes are drawn first). .. _class_VisualServer_canvas_light_attach_to_canvas: -- void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** +- void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** Attaches the canvas light to the canvas. Removes it from its previous canvas. .. _class_VisualServer_canvas_light_create: -- :ref:`RID` **canvas_light_create** **(** **)** +- :ref:`RID` **canvas_light_create** **(** **)** Creates a canvas light. .. _class_VisualServer_canvas_light_occluder_attach_to_canvas: -- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** +- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** Attaches a light occluder to the canvas. Removes it from its previous canvas. .. _class_VisualServer_canvas_light_occluder_create: -- :ref:`RID` **canvas_light_occluder_create** **(** **)** +- :ref:`RID` **canvas_light_occluder_create** **(** **)** Creates a light occluder. .. _class_VisualServer_canvas_light_occluder_set_enabled: -- void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** +- void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** Enables or disables light occluder. .. _class_VisualServer_canvas_light_occluder_set_light_mask: -- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** +- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** -The light mask. See :ref:`LightOccluder2D` for more information on light masks +The light mask. See :ref:`LightOccluder2D` for more information on light masks .. _class_VisualServer_canvas_light_occluder_set_polygon: -- void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** +- void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** Sets a light occluder's polygon. .. _class_VisualServer_canvas_light_occluder_set_transform: -- void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** +- void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** -Sets a light occluder's :ref:`Transform2D`. +Sets a light occluder's :ref:`Transform2D`. .. _class_VisualServer_canvas_light_set_color: -- void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color for a light. .. _class_VisualServer_canvas_light_set_enabled: -- void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables a canvas light. .. _class_VisualServer_canvas_light_set_energy: -- void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** +- void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** Sets a canvas light's energy. .. _class_VisualServer_canvas_light_set_height: -- void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** +- void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** Sets a canvas light's height. .. _class_VisualServer_canvas_light_set_item_cull_mask: -- void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +- void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** -The light mask. See :ref:`LightOccluder2D` for more information on light masks +The light mask. See :ref:`LightOccluder2D` for more information on light masks .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask: -- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** -The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See :ref:`LightOccluder2D` for more information on light masks. +The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See :ref:`LightOccluder2D` for more information on light masks. .. _class_VisualServer_canvas_light_set_layer_range: -- void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** +- void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** The layer range that gets rendered with this light. .. _class_VisualServer_canvas_light_set_mode: -- void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** +- void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** The mode of the light, see CANVAS_LIGHT_MODE\_\* constants. .. _class_VisualServer_canvas_light_set_scale: -- void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** +- void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** .. _class_VisualServer_canvas_light_set_shadow_buffer_size: -- void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** +- void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID` light, :ref:`int` size **)** Sets the width of the shadow buffer, size gets scaled to the next power of two for this. .. _class_VisualServer_canvas_light_set_shadow_color: -- void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color of the canvas light's shadow. .. _class_VisualServer_canvas_light_set_shadow_enabled: -- void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables the canvas light's shadow. .. _class_VisualServer_canvas_light_set_shadow_filter: -- void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** +- void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants. .. _class_VisualServer_canvas_light_set_shadow_gradient_length: -- void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** +- void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID` light, :ref:`float` length **)** Sets the length of the shadow's gradient. .. _class_VisualServer_canvas_light_set_shadow_smooth: -- void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** +- void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** Smoothens the shadow. The lower, the more smooth. .. _class_VisualServer_canvas_light_set_texture: -- void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** +- void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** .. _class_VisualServer_canvas_light_set_texture_offset: -- void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** +- void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** .. _class_VisualServer_canvas_light_set_transform: -- void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** +- void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** -Sets the canvas light's :ref:`Transform2D`. +Sets the canvas light's :ref:`Transform2D`. .. _class_VisualServer_canvas_light_set_z_range: -- void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** +- void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** .. _class_VisualServer_canvas_occluder_polygon_create: -- :ref:`RID` **canvas_occluder_polygon_create** **(** **)** +- :ref:`RID` **canvas_occluder_polygon_create** **(** **)** Creates a new light occluder polygon. .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode: -- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** +- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants. .. _class_VisualServer_canvas_occluder_polygon_set_shape: -- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** +- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape, :ref:`bool` closed **)** Sets the shape of the occluder polygon. .. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines: -- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** +- void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID` occluder_polygon, :ref:`PoolVector2Array` shape **)** Sets the shape of the occluder polygon as lines. .. _class_VisualServer_canvas_set_item_mirroring: -- void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** +- void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** -A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. +A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. .. _class_VisualServer_canvas_set_modulate: -- void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** +- void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** Modulates all colors in the given canvas. .. _class_VisualServer_directional_light_create: -- :ref:`RID` **directional_light_create** **(** **)** +- :ref:`RID` **directional_light_create** **(** **)** .. _class_VisualServer_draw: @@ -1621,75 +1620,75 @@ Modulates all colors in the given canvas. .. _class_VisualServer_environment_create: -- :ref:`RID` **environment_create** **(** **)** +- :ref:`RID` **environment_create** **(** **)** .. _class_VisualServer_environment_set_adjustment: -- void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** +- void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`RID` ramp **)** .. _class_VisualServer_environment_set_ambient_light: -- void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** +- void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0 **)** .. _class_VisualServer_environment_set_background: -- void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** +- void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** .. _class_VisualServer_environment_set_bg_color: -- void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** +- void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** .. _class_VisualServer_environment_set_bg_energy: -- void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** +- void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** .. _class_VisualServer_environment_set_canvas_max_layer: -- void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** +- void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** .. _class_VisualServer_environment_set_dof_blur_far: -- void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** +- void **environment_set_dof_blur_far** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** .. _class_VisualServer_environment_set_dof_blur_near: -- void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** +- void **environment_set_dof_blur_near** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` distance, :ref:`float` transition, :ref:`float` far_amount, :ref:`EnvironmentDOFBlurQuality` quality **)** .. _class_VisualServer_environment_set_fog: -- void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** +- void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` color, :ref:`Color` sun_color, :ref:`float` sun_amount **)** .. _class_VisualServer_environment_set_fog_depth: -- void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** +- void **environment_set_fog_depth** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` depth_begin, :ref:`float` depth_curve, :ref:`bool` transmit, :ref:`float` transmit_curve **)** .. _class_VisualServer_environment_set_fog_height: -- void **environment_set_fog_height** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** +- void **environment_set_fog_height** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` min_height, :ref:`float` max_height, :ref:`float` height_curve **)** .. _class_VisualServer_environment_set_glow: -- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** +- void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` level_flags, :ref:`float` intensity, :ref:`float` strength, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`bool` bicubic_upscale **)** .. _class_VisualServer_environment_set_sky: -- void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** +- void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** .. _class_VisualServer_environment_set_sky_custom_fov: -- void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** +- void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** .. _class_VisualServer_environment_set_ssao: -- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** +- void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** .. _class_VisualServer_environment_set_ssr: -- void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** +- void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** .. _class_VisualServer_environment_set_tonemap: -- void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** +- void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** .. _class_VisualServer_finish: @@ -1709,125 +1708,125 @@ Synchronizes threads. .. _class_VisualServer_free_rid: -- void **free_rid** **(** :ref:`RID` rid **)** +- void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the VisualServer. .. _class_VisualServer_get_render_info: -- :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** +- :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns a certain information, see RENDER_INFO\_\* for options. .. _class_VisualServer_get_test_cube: -- :ref:`RID` **get_test_cube** **(** **)** +- :ref:`RID` **get_test_cube** **(** **)** Returns the id of the test cube. Creates one if none exists. .. _class_VisualServer_get_test_texture: -- :ref:`RID` **get_test_texture** **(** **)** +- :ref:`RID` **get_test_texture** **(** **)** Returns the id of the test texture. Creates one if none exists. .. _class_VisualServer_get_white_texture: -- :ref:`RID` **get_white_texture** **(** **)** +- :ref:`RID` **get_white_texture** **(** **)** Returns the id of a white texture. Creates one if none exists. .. _class_VisualServer_gi_probe_create: -- :ref:`RID` **gi_probe_create** **(** **)** +- :ref:`RID` **gi_probe_create** **(** **)** .. _class_VisualServer_gi_probe_get_bias: -- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_bounds: -- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const +- :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_cell_size: -- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_dynamic_data: -- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const +- :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_dynamic_range: -- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const +- :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_energy: -- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_normal_bias: -- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_propagation: -- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const +- :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_get_to_cell_xform: -- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const +- :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_is_compressed: -- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const +- :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_is_interior: -- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const +- :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const .. _class_VisualServer_gi_probe_set_bias: -- void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** +- void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** .. _class_VisualServer_gi_probe_set_bounds: -- void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** +- void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** .. _class_VisualServer_gi_probe_set_cell_size: -- void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** +- void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** .. _class_VisualServer_gi_probe_set_compress: -- void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** +- void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_gi_probe_set_dynamic_data: -- void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** +- void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** .. _class_VisualServer_gi_probe_set_dynamic_range: -- void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** +- void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** .. _class_VisualServer_gi_probe_set_energy: -- void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +- void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** .. _class_VisualServer_gi_probe_set_interior: -- void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** +- void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_gi_probe_set_normal_bias: -- void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** +- void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** .. _class_VisualServer_gi_probe_set_propagation: -- void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** +- void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** .. _class_VisualServer_gi_probe_set_to_cell_xform: -- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** +- void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** .. _class_VisualServer_has_changed: @@ -1837,65 +1836,65 @@ Returns ``true`` if changes have been made to the VisualServer's data. :ref:`dra .. _class_VisualServer_has_feature: -- :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const +- :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const .. _class_VisualServer_has_os_feature: -- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const +- :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** const -Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, +Returns ``true`` if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, .. _class_VisualServer_immediate_begin: -- void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** +- void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** .. _class_VisualServer_immediate_clear: -- void **immediate_clear** **(** :ref:`RID` immediate **)** +- void **immediate_clear** **(** :ref:`RID` immediate **)** .. _class_VisualServer_immediate_color: -- void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** +- void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** .. _class_VisualServer_immediate_create: -- :ref:`RID` **immediate_create** **(** **)** +- :ref:`RID` **immediate_create** **(** **)** .. _class_VisualServer_immediate_end: -- void **immediate_end** **(** :ref:`RID` immediate **)** +- void **immediate_end** **(** :ref:`RID` immediate **)** .. _class_VisualServer_immediate_get_material: -- :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const +- :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const .. _class_VisualServer_immediate_normal: -- void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** +- void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** .. _class_VisualServer_immediate_set_material: -- void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** +- void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** .. _class_VisualServer_immediate_tangent: -- void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** +- void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** .. _class_VisualServer_immediate_uv: -- void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** +- void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** .. _class_VisualServer_immediate_uv2: -- void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** +- void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** .. _class_VisualServer_immediate_vertex: -- void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** +- void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** .. _class_VisualServer_immediate_vertex_2d: -- void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** +- void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** .. _class_VisualServer_init: @@ -1905,351 +1904,351 @@ Initializes the visual server. .. _class_VisualServer_instance_attach_object_instance_id: -- void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** +- void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** .. _class_VisualServer_instance_attach_skeleton: -- void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** +- void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** .. _class_VisualServer_instance_create: -- :ref:`RID` **instance_create** **(** **)** +- :ref:`RID` **instance_create** **(** **)** .. _class_VisualServer_instance_create2: -- :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** +- :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** .. _class_VisualServer_instance_geometry_set_as_instance_lod: -- void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** +- void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** .. _class_VisualServer_instance_geometry_set_cast_shadows_setting: -- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** +- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** .. _class_VisualServer_instance_geometry_set_draw_range: -- void **instance_geometry_set_draw_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** +- void **instance_geometry_set_draw_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin **)** .. _class_VisualServer_instance_geometry_set_flag: -- void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** +- void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** .. _class_VisualServer_instance_geometry_set_material_override: -- void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** +- void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** .. _class_VisualServer_instance_set_base: -- void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** +- void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** .. _class_VisualServer_instance_set_blend_shape_weight: -- void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** +- void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** .. _class_VisualServer_instance_set_custom_aabb: -- void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** +- void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** .. _class_VisualServer_instance_set_exterior: -- void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** +- void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** .. _class_VisualServer_instance_set_extra_visibility_margin: -- void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** +- void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** .. _class_VisualServer_instance_set_layer_mask: -- void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** +- void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** .. _class_VisualServer_instance_set_scenario: -- void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** +- void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** .. _class_VisualServer_instance_set_surface_material: -- void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** +- void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** .. _class_VisualServer_instance_set_transform: -- void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** +- void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** .. _class_VisualServer_instance_set_use_lightmap: -- void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** +- void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** .. _class_VisualServer_instance_set_visible: -- void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** +- void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** .. _class_VisualServer_instances_cull_aabb: -- :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const .. _class_VisualServer_instances_cull_convex: -- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const .. _class_VisualServer_instances_cull_ray: -- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const +- :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const .. _class_VisualServer_light_directional_set_blend_splits: -- void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** +- void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** .. _class_VisualServer_light_directional_set_shadow_depth_range_mode: -- void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** +- void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** .. _class_VisualServer_light_directional_set_shadow_mode: -- void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** +- void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** .. _class_VisualServer_light_omni_set_shadow_detail: -- void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** +- void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** .. _class_VisualServer_light_omni_set_shadow_mode: -- void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** +- void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** .. _class_VisualServer_light_set_color: -- void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** .. _class_VisualServer_light_set_cull_mask: -- void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** +- void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** .. _class_VisualServer_light_set_negative: -- void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** +- void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** .. _class_VisualServer_light_set_param: -- void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** +- void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** .. _class_VisualServer_light_set_projector: -- void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** +- void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** .. _class_VisualServer_light_set_reverse_cull_face_mode: -- void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** .. _class_VisualServer_light_set_shadow: -- void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** +- void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** .. _class_VisualServer_light_set_shadow_color: -- void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** +- void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** .. _class_VisualServer_lightmap_capture_create: -- :ref:`RID` **lightmap_capture_create** **(** **)** +- :ref:`RID` **lightmap_capture_create** **(** **)** .. _class_VisualServer_lightmap_capture_get_bounds: -- :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const +- :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const .. _class_VisualServer_lightmap_capture_get_energy: -- :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const +- :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const .. _class_VisualServer_lightmap_capture_get_octree: -- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const +- :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const .. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: -- :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const +- :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const .. _class_VisualServer_lightmap_capture_get_octree_cell_transform: -- :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const +- :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const .. _class_VisualServer_lightmap_capture_set_bounds: -- void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** +- void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** .. _class_VisualServer_lightmap_capture_set_energy: -- void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** +- void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** .. _class_VisualServer_lightmap_capture_set_octree: -- void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** +- void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** .. _class_VisualServer_lightmap_capture_set_octree_cell_subdiv: -- void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** +- void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** .. _class_VisualServer_lightmap_capture_set_octree_cell_transform: -- void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** +- void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** .. _class_VisualServer_make_sphere_mesh: -- :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** +- :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. .. _class_VisualServer_material_create: -- :ref:`RID` **material_create** **(** **)** +- :ref:`RID` **material_create** **(** **)** Returns an empty material. .. _class_VisualServer_material_get_param: -- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const +- :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`String` parameter **)** const Returns the value of a certain material's parameter. .. _class_VisualServer_material_get_shader: -- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const +- :ref:`RID` **material_get_shader** **(** :ref:`RID` shader_material **)** const Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. .. _class_VisualServer_material_set_line_width: -- void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** +- void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** Sets a materials line width. .. _class_VisualServer_material_set_next_pass: -- void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** +- void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** Sets an objects next material. .. _class_VisualServer_material_set_param: -- void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** +- void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** Sets a materials parameter. .. _class_VisualServer_material_set_render_priority: -- void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** +- void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** Sets a material's render priority. .. _class_VisualServer_material_set_shader: -- void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** +- void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** Sets a shader material's shader. .. _class_VisualServer_mesh_add_surface_from_arrays: -- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** +- void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primtive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[ ], :ref:`int` compress_format=97280 **)** Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. .. _class_VisualServer_mesh_clear: -- void **mesh_clear** **(** :ref:`RID` mesh **)** +- void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. .. _class_VisualServer_mesh_create: -- :ref:`RID` **mesh_create** **(** **)** +- :ref:`RID` **mesh_create** **(** **)** Creates a new mesh. .. _class_VisualServer_mesh_get_blend_shape_count: -- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape count. .. _class_VisualServer_mesh_get_blend_shape_mode: -- :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const +- :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape mode. .. _class_VisualServer_mesh_get_custom_aabb: -- :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const +- :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const Returns a mesh's custom aabb. .. _class_VisualServer_mesh_get_surface_count: -- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const +- :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const Returns a mesh's number of surfaces. .. _class_VisualServer_mesh_remove_surface: -- void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** +- void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** Removes a mesh's surface. .. _class_VisualServer_mesh_set_blend_shape_count: -- void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** +- void **mesh_set_blend_shape_count** **(** :ref:`RID` mesh, :ref:`int` amount **)** Sets a mesh's blend shape count. .. _class_VisualServer_mesh_set_blend_shape_mode: -- void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** +- void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** Sets a mesh's blend shape mode. .. _class_VisualServer_mesh_set_custom_aabb: -- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** +- void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** Sets a mesh's custom aabb. .. _class_VisualServer_mesh_surface_get_aabb: -- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`AABB` **mesh_surface_get_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's aabb. .. _class_VisualServer_mesh_surface_get_array: -- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's vertex buffer. .. _class_VisualServer_mesh_surface_get_array_index_len: -- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_index_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of indices. .. _class_VisualServer_mesh_surface_get_array_len: -- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_array_len** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's amount of vertices. .. _class_VisualServer_mesh_surface_get_arrays: -- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's buffer arrays. .. _class_VisualServer_mesh_surface_get_blend_shape_arrays: -- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's arrays for blend shapes .. _class_VisualServer_mesh_surface_get_format: -- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the format of a mesh's surface. @@ -2263,245 +2262,245 @@ Returns the format of a mesh's surface. .. _class_VisualServer_mesh_surface_get_index_array: -- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PoolByteArray` **mesh_surface_get_index_array** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's index buffer. .. _class_VisualServer_mesh_surface_get_material: -- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns a mesh's surface's material. .. _class_VisualServer_mesh_surface_get_primitive_type: -- :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`PrimitiveType` **mesh_surface_get_primitive_type** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the primitive type of a mesh's surface. .. _class_VisualServer_mesh_surface_get_skeleton_aabb: -- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const +- :ref:`Array` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the aabb of a mesh's surface's skeleton. .. _class_VisualServer_mesh_surface_set_material: -- void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** +- void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** Sets a mesh's surface's material. .. _class_VisualServer_mesh_surface_update_region: -- void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** +- void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** .. _class_VisualServer_multimesh_allocate: -- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** +- void **multimesh_allocate** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`MultimeshColorFormat` color_format, :ref:`MultimeshCustomDataFormat` custom_data_format=0 **)** .. _class_VisualServer_multimesh_get_aabb: -- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const +- :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const .. _class_VisualServer_multimesh_get_instance_count: -- :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const +- :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const .. _class_VisualServer_multimesh_get_mesh: -- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const +- :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const .. _class_VisualServer_multimesh_get_visible_instances: -- :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const +- :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const .. _class_VisualServer_multimesh_instance_get_color: -- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const .. _class_VisualServer_multimesh_instance_get_custom_data: -- :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const .. _class_VisualServer_multimesh_instance_get_transform: -- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const .. _class_VisualServer_multimesh_instance_get_transform_2d: -- :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const +- :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const .. _class_VisualServer_multimesh_instance_set_color: -- void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** +- void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** .. _class_VisualServer_multimesh_instance_set_custom_data: -- void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** +- void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** .. _class_VisualServer_multimesh_instance_set_transform: -- void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** +- void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** .. _class_VisualServer_multimesh_instance_set_transform_2d: -- void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** +- void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** .. _class_VisualServer_multimesh_set_as_bulk_array: -- void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** +- void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** .. _class_VisualServer_multimesh_set_mesh: -- void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** +- void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** .. _class_VisualServer_multimesh_set_visible_instances: -- void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** +- void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** .. _class_VisualServer_omni_light_create: -- :ref:`RID` **omni_light_create** **(** **)** +- :ref:`RID` **omni_light_create** **(** **)** .. _class_VisualServer_particles_create: -- :ref:`RID` **particles_create** **(** **)** +- :ref:`RID` **particles_create** **(** **)** .. _class_VisualServer_particles_get_current_aabb: -- :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** +- :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** .. _class_VisualServer_particles_get_emitting: -- :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** +- :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** .. _class_VisualServer_particles_restart: -- void **particles_restart** **(** :ref:`RID` particles **)** +- void **particles_restart** **(** :ref:`RID` particles **)** .. _class_VisualServer_particles_set_amount: -- void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** +- void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** .. _class_VisualServer_particles_set_custom_aabb: -- void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** +- void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** .. _class_VisualServer_particles_set_draw_order: -- void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** +- void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** .. _class_VisualServer_particles_set_draw_pass_mesh: -- void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** +- void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** .. _class_VisualServer_particles_set_draw_passes: -- void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** +- void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** .. _class_VisualServer_particles_set_emission_transform: -- void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** +- void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** .. _class_VisualServer_particles_set_emitting: -- void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** +- void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** .. _class_VisualServer_particles_set_explosiveness_ratio: -- void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +- void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** .. _class_VisualServer_particles_set_fixed_fps: -- void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** +- void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** .. _class_VisualServer_particles_set_fractional_delta: -- void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** +- void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** .. _class_VisualServer_particles_set_lifetime: -- void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** +- void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** .. _class_VisualServer_particles_set_one_shot: -- void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** +- void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** .. _class_VisualServer_particles_set_pre_process_time: -- void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** +- void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** .. _class_VisualServer_particles_set_process_material: -- void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** +- void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** .. _class_VisualServer_particles_set_randomness_ratio: -- void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** +- void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** .. _class_VisualServer_particles_set_speed_scale: -- void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** +- void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** .. _class_VisualServer_particles_set_use_local_coordinates: -- void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** +- void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** .. _class_VisualServer_reflection_probe_create: -- :ref:`RID` **reflection_probe_create** **(** **)** +- :ref:`RID` **reflection_probe_create** **(** **)** .. _class_VisualServer_reflection_probe_set_as_interior: -- void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** +- void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_reflection_probe_set_cull_mask: -- void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** +- void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** .. _class_VisualServer_reflection_probe_set_enable_box_projection: -- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** +- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_reflection_probe_set_enable_shadows: -- void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** +- void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** .. _class_VisualServer_reflection_probe_set_extents: -- void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** +- void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** .. _class_VisualServer_reflection_probe_set_intensity: -- void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** +- void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** .. _class_VisualServer_reflection_probe_set_interior_ambient: -- void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** +- void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** .. _class_VisualServer_reflection_probe_set_interior_ambient_energy: -- void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +- void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** .. _class_VisualServer_reflection_probe_set_interior_ambient_probe_contribution: -- void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** +- void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** .. _class_VisualServer_reflection_probe_set_max_distance: -- void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** +- void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** .. _class_VisualServer_reflection_probe_set_origin_offset: -- void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** +- void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** .. _class_VisualServer_reflection_probe_set_update_mode: -- void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** +- void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** .. _class_VisualServer_request_frame_drawn_callback: -- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** +- void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn. @@ -2509,29 +2508,29 @@ The callback method must use only 1 argument which will be called with 'userdata .. _class_VisualServer_scenario_create: -- :ref:`RID` **scenario_create** **(** **)** +- :ref:`RID` **scenario_create** **(** **)** .. _class_VisualServer_scenario_set_debug: -- void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** +- void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** .. _class_VisualServer_scenario_set_environment: -- void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +- void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** .. _class_VisualServer_scenario_set_fallback_environment: -- void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** +- void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** .. _class_VisualServer_scenario_set_reflection_atlas_size: -- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** +- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** .. _class_VisualServer_set_boot_image: -- void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** +- void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** -Sets a boot image. The color defines the background color and if scale is ``true``, the image will be scaled to fit the screen size. +Sets a boot image. The color defines the background color and if scale is ``true`` the image will be scaled to fit the screen size. .. _class_VisualServer_set_debug_generate_wireframes: @@ -2539,87 +2538,87 @@ Sets a boot image. The color defines the background color and if scale is ``true .. _class_VisualServer_set_default_clear_color: -- void **set_default_clear_color** **(** :ref:`Color` color **)** +- void **set_default_clear_color** **(** :ref:`Color` color **)** .. _class_VisualServer_shader_create: -- :ref:`RID` **shader_create** **(** **)** +- :ref:`RID` **shader_create** **(** **)** Creates an empty shader. .. _class_VisualServer_shader_get_code: -- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const +- :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const Returns a shader's code. .. _class_VisualServer_shader_get_default_texture_param: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const +- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name **)** const Returns a default texture from a shader searched by name. .. _class_VisualServer_shader_get_param_list: -- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const +- :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const Returns the parameters of a shader. .. _class_VisualServer_shader_set_code: -- void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** +- void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** Sets a shader's code. .. _class_VisualServer_shader_set_default_texture_param: -- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** +- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`String` name, :ref:`RID` texture **)** Sets a shader's default texture. Overwrites the texture given by name. .. _class_VisualServer_skeleton_allocate: -- void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** +- void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** .. _class_VisualServer_skeleton_bone_get_transform: -- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +- :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const .. _class_VisualServer_skeleton_bone_get_transform_2d: -- :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const +- :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const .. _class_VisualServer_skeleton_bone_set_transform: -- void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** +- void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** .. _class_VisualServer_skeleton_bone_set_transform_2d: -- void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** +- void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** .. _class_VisualServer_skeleton_create: -- :ref:`RID` **skeleton_create** **(** **)** +- :ref:`RID` **skeleton_create** **(** **)** .. _class_VisualServer_skeleton_get_bone_count: -- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const +- :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const .. _class_VisualServer_sky_create: -- :ref:`RID` **sky_create** **(** **)** +- :ref:`RID` **sky_create** **(** **)** Creates an empty sky. .. _class_VisualServer_sky_set_texture: -- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** +- void **sky_set_texture** **(** :ref:`RID` sky, :ref:`RID` cube_map, :ref:`int` radiance_size **)** Sets a sky's texture. .. _class_VisualServer_spot_light_create: -- :ref:`RID` **spot_light_create** **(** **)** +- :ref:`RID` **spot_light_create** **(** **)** .. _class_VisualServer_sync: @@ -2627,95 +2626,95 @@ Sets a sky's texture. .. _class_VisualServer_texture_allocate: -- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** +- void **texture_allocate** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth_3d, :ref:`Format` format, :ref:`TextureType` type, :ref:`int` flags=7 **)** .. _class_VisualServer_texture_create: -- :ref:`RID` **texture_create** **(** **)** +- :ref:`RID` **texture_create** **(** **)** Creates an empty texture. .. _class_VisualServer_texture_create_from_image: -- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** +- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` image, :ref:`int` flags=7 **)** Creates a texture, allocates the space for an image, and fills in the image. .. _class_VisualServer_texture_debug_usage: -- :ref:`Array` **texture_debug_usage** **(** **)** +- :ref:`Array` **texture_debug_usage** **(** **)** Returns a list of all the textures and their information. .. _class_VisualServer_texture_get_data: -- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const +- :ref:`Image` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` cube_side=0 **)** const -Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. +Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID` of the image at one of the cubes sides. .. _class_VisualServer_texture_get_depth: -- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_flags: -- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const Returns the flags of a texture. .. _class_VisualServer_texture_get_format: -- :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const +- :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const Returns the format of the texture's image. .. _class_VisualServer_texture_get_height: -- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const Returns the texture's height. .. _class_VisualServer_texture_get_path: -- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const +- :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const Returns the texture's path. .. _class_VisualServer_texture_get_texid: -- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const Returns the opengl id of the texture's image. .. _class_VisualServer_texture_get_type: -- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const +- :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const .. _class_VisualServer_texture_get_width: -- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const +- :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const Returns the texture's width. .. _class_VisualServer_texture_set_data: -- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** +- void **texture_set_data** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer=0 **)** Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. .. _class_VisualServer_texture_set_data_partial: -- void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** +- void **texture_set_data_partial** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` src_x, :ref:`int` src_y, :ref:`int` src_w, :ref:`int` src_h, :ref:`int` dst_x, :ref:`int` dst_y, :ref:`int` dst_mip, :ref:`int` layer=0 **)** .. _class_VisualServer_texture_set_flags: -- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** +- void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** -Sets the texture's flags. See :ref:`TextureFlags` for options +Sets the texture's flags. See :ref:`TextureFlags` for options .. _class_VisualServer_texture_set_path: -- void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** +- void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** Sets the texture's path. @@ -2723,196 +2722,196 @@ Sets the texture's path. - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** -If ``true``, sets internal processes to shrink all image data to half the size. +If ``true`` sets internal processes to shrink all image data to half the size. .. _class_VisualServer_texture_set_size_override: -- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** +- void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** .. _class_VisualServer_textures_keep_original: - void **textures_keep_original** **(** :ref:`bool` enable **)** -If ``true``, the image will be stored in the texture's images array if overwritten. +If ``true`` the image will be stored in the texture's images array if overwritten. .. _class_VisualServer_viewport_attach_camera: -- void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** +- void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** Sets a viewport's camera. .. _class_VisualServer_viewport_attach_canvas: -- void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +- void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Sets a viewport's canvas. .. _class_VisualServer_viewport_attach_to_screen: -- void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** +- void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2( 0, 0, 0, 0 ), :ref:`int` screen=0 **)** Attaches a viewport to a screen. .. _class_VisualServer_viewport_create: -- :ref:`RID` **viewport_create** **(** **)** +- :ref:`RID` **viewport_create** **(** **)** Creates an empty viewport. .. _class_VisualServer_viewport_detach: -- void **viewport_detach** **(** :ref:`RID` viewport **)** +- void **viewport_detach** **(** :ref:`RID` viewport **)** Detaches the viewport from the screen. .. _class_VisualServer_viewport_get_render_info: -- :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** +- :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfo` info **)** Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants. .. _class_VisualServer_viewport_get_texture: -- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const +- :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const Returns the viewport's last rendered frame. .. _class_VisualServer_viewport_remove_canvas: -- void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** +- void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Detaches a viewport from a canvas and vice versa. .. _class_VisualServer_viewport_set_active: -- void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** +- void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** -If ``true``, sets the viewport active, else sets it inactive. +If ``true`` sets the viewport active, else sets it inactive. .. _class_VisualServer_viewport_set_canvas_layer: -- void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** +- void **viewport_set_canvas_layer** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer **)** Sets the renderlayer for a viewport's canvas. .. _class_VisualServer_viewport_set_canvas_transform: -- void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** +- void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** Sets the transformation of a viewport's canvas. .. _class_VisualServer_viewport_set_clear_mode: -- void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** +- void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE\_\* constants for options. .. _class_VisualServer_viewport_set_debug_draw: -- void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** +- void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants for options. .. _class_VisualServer_viewport_set_disable_3d: -- void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +- void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** -If ``true`` a viewport's 3D rendering should be disabled. +If ``true`` a viewport's 3D rendering is disabled. .. _class_VisualServer_viewport_set_disable_environment: -- void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** +- void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** -If ``true`` rendering of a viewport's environment should be disabled. +If ``true`` rendering of a viewport's environment is disabled. .. _class_VisualServer_viewport_set_global_canvas_transform: -- void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** +- void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** Sets the viewport's global transformation matrix. .. _class_VisualServer_viewport_set_hdr: -- void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport should render to hdr. +If ``true`` the viewport renders to hdr. .. _class_VisualServer_viewport_set_hide_canvas: -- void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +- void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** -If ``true`` the viewport's canvas should not be rendered. +If ``true`` the viewport's canvas is not rendered. .. _class_VisualServer_viewport_set_hide_scenario: -- void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** +- void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** .. _class_VisualServer_viewport_set_msaa: -- void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** +- void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** -Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. +Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. .. _class_VisualServer_viewport_set_parent_viewport: -- void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** +- void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** Sets the viewport's parent to another viewport. .. _class_VisualServer_viewport_set_scenario: -- void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** +- void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** Sets a viewport's scenario. -The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. +The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: -- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** +- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** Sets the shadow atlas quadrant's subdivision. .. _class_VisualServer_viewport_set_shadow_atlas_size: -- void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** +- void **viewport_set_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size **)** Sets the size of the shadow atlas's images. .. _class_VisualServer_viewport_set_size: -- void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** +- void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** Sets the viewport's width and height. .. _class_VisualServer_viewport_set_transparent_background: -- void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport should render its background as transparent. +If ``true`` the viewport renders its background as transparent. .. _class_VisualServer_viewport_set_update_mode: -- void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** +- void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** -Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE\_\* constants for options. +Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. .. _class_VisualServer_viewport_set_usage: -- void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** +- void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** -Sets what should be rendered in the viewport. See VIEWPORT_USAGE\_\* constants for options. +Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. .. _class_VisualServer_viewport_set_use_arvr: -- void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** +- void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** -If ``true`` the viewport should use augmented or virtual reality technologies. See :ref:`ARVRInterface`. +If ``true`` the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. .. _class_VisualServer_viewport_set_vflip: -- void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +- void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport's rendering should be flipped vertically. +If ``true`` the viewport's rendering is flipped vertically. diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index cb8c5c8c4..f7665d443 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -7,8 +7,7 @@ VisualShader ============ -**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Shader` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,53 +15,39 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | +| void | :ref:`add_node` **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +| :ref:`bool` | :ref:`can_connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +| :ref:`Error` | :ref:`connect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +| void | :ref:`disconnect_nodes` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** const | +| :ref:`VisualShaderNode` | :ref:`get_node` **(** :ref:`Type` type, :ref:`int` id **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** const | +| :ref:`Array` | :ref:`get_node_connections` **(** :ref:`Type` type **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | +| :ref:`PoolIntArray` | :ref:`get_node_list` **(** :ref:`Type` type **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`Type` type, :ref:`int` id **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** const | +| :ref:`int` | :ref:`get_valid_node_id` **(** :ref:`Type` type **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +| :ref:`bool` | :ref:`is_node_connection` **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | +| void | :ref:`remove_node` **(** :ref:`Type` type, :ref:`int` id **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | +| void | :ref:`set_mode` **(** :ref:`Mode` mode **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | +| void | :ref:`set_node_position` **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Member Variables ----------------- - - .. _class_VisualShader_graph_offset: - -- :ref:`Vector2` **graph_offset** - - -Numeric Constants ------------------ - -- **NODE_ID_INVALID** = **-1** -- **NODE_ID_OUTPUT** = **0** - -Enums ------ +Enumerations +------------ .. _enum_VisualShader_Type: @@ -74,59 +59,73 @@ enum **Type** - **TYPE_MAX** = **3** -Member Function Description ---------------------------- +Constants +--------- + +- **NODE_ID_INVALID** = **-1** +- **NODE_ID_OUTPUT** = **0** + +Property Descriptions +--------------------- + + .. _class_VisualShader_graph_offset: + +- :ref:`Vector2` **graph_offset** + + +Method Descriptions +------------------- .. _class_VisualShader_add_node: -- void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** +- void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** .. _class_VisualShader_can_connect_nodes: -- :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **can_connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const .. _class_VisualShader_connect_nodes: -- :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- :ref:`Error` **connect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. _class_VisualShader_disconnect_nodes: -- void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** +- void **disconnect_nodes** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** .. _class_VisualShader_get_node: -- :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const +- :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const .. _class_VisualShader_get_node_connections: -- :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const +- :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const .. _class_VisualShader_get_node_list: -- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const +- :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const .. _class_VisualShader_get_node_position: -- :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const .. _class_VisualShader_get_valid_node_id: -- :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const +- :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const .. _class_VisualShader_is_node_connection: -- :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const +- :ref:`bool` **is_node_connection** **(** :ref:`Type` type, :ref:`int` from_node, :ref:`int` from_port, :ref:`int` to_node, :ref:`int` to_port **)** const .. _class_VisualShader_remove_node: -- void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** +- void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** .. _class_VisualShader_set_mode: -- void **set_mode** **(** :ref:`Mode` mode **)** +- void **set_mode** **(** :ref:`Mode` mode **)** .. _class_VisualShader_set_node_position: -- void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** +- void **set_node_position** **(** :ref:`Type` type, :ref:`int` id, :ref:`Vector2` position **)** diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 35fa45d37..846f29f6f 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -7,10 +7,8 @@ VisualShaderNode ================ -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` **Category:** Core Brief Description @@ -18,13 +16,13 @@ Brief Description -Member Functions ----------------- +Methods +------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | +| :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value **)** | +| void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -35,27 +33,27 @@ Signals - **editor_refresh_request** **(** **)** -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNode_default_input_values: -- :ref:`Array` **default_input_values** +- :ref:`Array` **default_input_values** .. _class_VisualShaderNode_output_port_for_preview: - :ref:`int` **output_port_for_preview** -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_VisualShaderNode_get_input_port_default_value: -- :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const +- :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const .. _class_VisualShaderNode_set_input_port_default_value: -- void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value **)** +- void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value **)** diff --git a/classes/class_visualshadernodecolorconstant.rst b/classes/class_visualshadernodecolorconstant.rst index 00e511934..76bda407f 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -7,8 +7,7 @@ VisualShaderNodeColorConstant ============================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeColorConstant_constant: -- :ref:`Color` **constant** +- :ref:`Color` **constant** diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index cb25f0f76..7dcabd09e 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -7,8 +7,7 @@ VisualShaderNodeColorOp ======================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeColorOp_operator: - -- :ref:`Operator` **operator** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeColorOp_Operator: @@ -42,3 +33,11 @@ enum **Operator** - **OP_HARD_LIGHT** = **8** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeColorOp_operator: + +- :ref:`Operator` **operator** + + diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecoloruniform.rst index 3413c334d..c5a363479 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecoloruniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeColorUniform ============================ -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 2ef34bce7..8943cde74 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -7,8 +7,7 @@ VisualShaderNodeCubeMap ======================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeCubeMap_cube_map: - -- :ref:`CubeMap` **cube_map** - - .. _class_VisualShaderNodeCubeMap_texture_type: - -- :ref:`TextureType` **texture_type** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeCubeMap_TextureType: @@ -40,3 +27,15 @@ enum **TextureType** - **TYPE_NORMALMAP** = **2** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeCubeMap_cube_map: + +- :ref:`CubeMap` **cube_map** + + .. _class_VisualShaderNodeCubeMap_texture_type: + +- :ref:`TextureType` **texture_type** + + diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapuniform.rst index 5945d233a..e653ee1d8 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapuniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeCubeMapUniform ============================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodedotproduct.rst b/classes/class_visualshadernodedotproduct.rst index 8aaf5930e..b709b79e5 100644 --- a/classes/class_visualshadernodedotproduct.rst +++ b/classes/class_visualshadernodedotproduct.rst @@ -7,8 +7,7 @@ VisualShaderNodeDotProduct ========================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 86d7f61c6..0b553a3bf 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -7,8 +7,7 @@ VisualShaderNodeInput ===================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -24,11 +23,11 @@ Signals - **input_type_changed** **(** **)** -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeInput_input_name: -- :ref:`String` **input_name** +- :ref:`String` **input_name** diff --git a/classes/class_visualshadernodeoutput.rst b/classes/class_visualshadernodeoutput.rst index 6e06fe0ce..a1e4bd30b 100644 --- a/classes/class_visualshadernodeoutput.rst +++ b/classes/class_visualshadernodeoutput.rst @@ -7,8 +7,7 @@ VisualShaderNodeOutput ====================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index b64561d1a..e7dc745df 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -7,8 +7,7 @@ VisualShaderNodeScalarConstant ============================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,8 +15,8 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeScalarConstant_constant: diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index 99c435b0b..ecc43dbda 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -7,8 +7,7 @@ VisualShaderNodeScalarFunc ========================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeScalarFunc_function: - -- :ref:`Function` **function** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeScalarFunc_Function: @@ -53,3 +44,11 @@ enum **Function** - **FUNC_NEGATE** = **19** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeScalarFunc_function: + +- :ref:`Function` **function** + + diff --git a/classes/class_visualshadernodescalarinterp.rst b/classes/class_visualshadernodescalarinterp.rst index 4c8e912dd..ae2f82c88 100644 --- a/classes/class_visualshadernodescalarinterp.rst +++ b/classes/class_visualshadernodescalarinterp.rst @@ -7,8 +7,7 @@ VisualShaderNodeScalarInterp ============================ -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index bd40f4a0f..0c7fefcfa 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -7,8 +7,7 @@ VisualShaderNodeScalarOp ======================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeScalarOp_operator: - -- :ref:`Operator` **operator** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeScalarOp_Operator: @@ -42,3 +33,11 @@ enum **Operator** - **OP_ATAN2** = **8** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeScalarOp_operator: + +- :ref:`Operator` **operator** + + diff --git a/classes/class_visualshadernodescalaruniform.rst b/classes/class_visualshadernodescalaruniform.rst index 990978bbd..a16fbfb6e 100644 --- a/classes/class_visualshadernodescalaruniform.rst +++ b/classes/class_visualshadernodescalaruniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeScalarUniform ============================= -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index 95597c437..66a026c5c 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -7,8 +7,7 @@ VisualShaderNodeTexture ======================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,24 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeTexture_source: - -- :ref:`Source` **source** - - .. _class_VisualShaderNodeTexture_texture: - -- :ref:`Texture` **texture** - - .. _class_VisualShaderNodeTexture_texture_type: - -- :ref:`TextureType` **texture_type** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeTexture_Source: @@ -53,3 +36,19 @@ enum **TextureType** - **TYPE_NORMALMAP** = **2** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeTexture_source: + +- :ref:`Source` **source** + + .. _class_VisualShaderNodeTexture_texture: + +- :ref:`Texture` **texture** + + .. _class_VisualShaderNodeTexture_texture_type: + +- :ref:`TextureType` **texture_type** + + diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index 6da480507..4a4a4680b 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeTextureUniform ============================== -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeTextureUniform_color_default: - -- :ref:`ColorDefault` **color_default** - - .. _class_VisualShaderNodeTextureUniform_texture_type: - -- :ref:`TextureType` **texture_type** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeTextureUniform_TextureType: @@ -48,3 +35,15 @@ enum **ColorDefault** - **COLOR_DEFAULT_BLACK** = **1** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeTextureUniform_color_default: + +- :ref:`ColorDefault` **color_default** + + .. _class_VisualShaderNodeTextureUniform_texture_type: + +- :ref:`TextureType` **texture_type** + + diff --git a/classes/class_visualshadernodetransformcompose.rst b/classes/class_visualshadernodetransformcompose.rst index 006ec5007..3e10cf524 100644 --- a/classes/class_visualshadernodetransformcompose.rst +++ b/classes/class_visualshadernodetransformcompose.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformCompose ================================ -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index 1ea37f21f..c82b0153d 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformConstant ================================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeTransformConstant_constant: -- :ref:`Transform` **constant** +- :ref:`Transform` **constant** diff --git a/classes/class_visualshadernodetransformdecompose.rst b/classes/class_visualshadernodetransformdecompose.rst index 8365b69c2..4dbd0710e 100644 --- a/classes/class_visualshadernodetransformdecompose.rst +++ b/classes/class_visualshadernodetransformdecompose.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformDecompose ================================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 81c1876c7..6966f8232 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformMult ============================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeTransformMult_operator: - -- :ref:`Operator` **operator** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeTransformMult_Operator: @@ -35,3 +26,11 @@ enum **Operator** - **OP_BxA** = **1** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeTransformMult_operator: + +- :ref:`Operator` **operator** + + diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformuniform.rst index bd4e4bbd2..d3edc5dc7 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformuniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformUniform ================================ -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 2dec4b9a1..6ccffd042 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -7,8 +7,7 @@ VisualShaderNodeTransformVecMult ================================ -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeTransformVecMult_operator: - -- :ref:`Operator` **operator** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeTransformVecMult_Operator: @@ -37,3 +28,11 @@ enum **Operator** - **OP_3x3_BxA** = **3** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeTransformVecMult_operator: + +- :ref:`Operator` **operator** + + diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 44911bc63..c2479f05e 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -7,10 +7,8 @@ VisualShaderNodeUniform ======================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeColorUniform` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeColorUniform` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeUniform_uniform_name: -- :ref:`String` **uniform_name** +- :ref:`String` **uniform_name** diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 7d79e3268..a29a3206a 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -7,8 +7,7 @@ VisualShaderNodeVec3Constant ============================ -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description -Member Variables ----------------- +Property Descriptions +--------------------- .. _class_VisualShaderNodeVec3Constant_constant: -- :ref:`Vector3` **constant** +- :ref:`Vector3` **constant** diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3uniform.rst index 9c1484007..30f39567d 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3uniform.rst @@ -7,8 +7,7 @@ VisualShaderNodeVec3Uniform =========================== -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorcompose.rst b/classes/class_visualshadernodevectorcompose.rst index b72cee4dd..9c253ea9b 100644 --- a/classes/class_visualshadernodevectorcompose.rst +++ b/classes/class_visualshadernodevectorcompose.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorCompose ============================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectordecompose.rst b/classes/class_visualshadernodevectordecompose.rst index 869eb96de..0425b0c5e 100644 --- a/classes/class_visualshadernodevectordecompose.rst +++ b/classes/class_visualshadernodevectordecompose.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorDecompose =============================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 56dd5bd5d..beb9bb60c 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorFunc ========================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeVectorFunc_function: - -- :ref:`Function` **function** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeVectorFunc_Function: @@ -39,3 +30,11 @@ enum **Function** - **FUNC_HSV2RGB** = **5** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeVectorFunc_function: + +- :ref:`Function` **function** + + diff --git a/classes/class_visualshadernodevectorinterp.rst b/classes/class_visualshadernodevectorinterp.rst index 16b6b3e2f..15bb727d8 100644 --- a/classes/class_visualshadernodevectorinterp.rst +++ b/classes/class_visualshadernodevectorinterp.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorInterp ============================ -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorlen.rst b/classes/class_visualshadernodevectorlen.rst index c25291bf6..003b1e060 100644 --- a/classes/class_visualshadernodevectorlen.rst +++ b/classes/class_visualshadernodevectorlen.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorLen ========================= -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 6ddebf4b9..e2fb29226 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -7,8 +7,7 @@ VisualShaderNodeVectorOp ======================== -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,8 @@ Brief Description -Member Variables ----------------- - - .. _class_VisualShaderNodeVectorOp_operator: - -- :ref:`Operator` **operator** - - -Enums ------ +Enumerations +------------ .. _enum_VisualShaderNodeVectorOp_Operator: @@ -42,3 +33,11 @@ enum **Operator** - **OP_CROSS** = **8** +Property Descriptions +--------------------- + + .. _class_VisualShaderNodeVectorOp_operator: + +- :ref:`Operator` **operator** + + diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index ed01f6914..97789ebf6 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -7,12 +7,11 @@ VScrollBar ========== -**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`ScrollBar` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Vertical version of :ref:`ScrollBar`, which goes from left (min) to right (max). +Vertical version of :ref:`ScrollBar`, which goes from left (min) to right (max). diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index cdaa6a9a2..164153e0a 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -7,17 +7,16 @@ VSeparator ========== -**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Separator` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Vertical version of :ref:`Separator`. +Vertical version of :ref:`Separator`. Description ----------- -Vertical version of :ref:`Separator`. It is used to separate objects horizontally, though (but it looks vertical!). +Vertical version of :ref:`Separator`. It is used to separate objects horizontally, though (but it looks vertical!). diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 8d043cd11..b36108f7c 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -7,8 +7,7 @@ VSlider ======= -**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Slider` **<** :ref:`Range` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Vertical slider. Description ----------- -Vertical slider. See :ref:`Slider`. This one goes from left (min) to right (max). +Vertical slider. See :ref:`Slider`. This one goes from left (min) to right (max). diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 899e253d2..687e4d0fb 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -7,8 +7,7 @@ VSplitContainer =============== -**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`SplitContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -19,5 +18,5 @@ Vertical split container. Description ----------- -Vertical split container. See :ref:`SplitContainer`. This goes from left to right. +Vertical split container. See :ref:`SplitContainer`. This goes from left to right. diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 09a8f04c2..f60a2bd55 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -7,34 +7,33 @@ WeakRef ======= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- -Holds an :ref:`Object`, but does not contribute to the reference count if the object is a reference. +Holds an :ref:`Object`, but does not contribute to the reference count if the object is a reference. -Member Functions ----------------- +Methods +------- +--------------------------------+---------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_ref` **(** **)** const | +| :ref:`Variant` | :ref:`get_ref` **(** **)** const | +--------------------------------+---------------------------------------------------------+ Description ----------- -A weakref can hold a :ref:`Reference`, without contributing to the reference counter. A weakref can be created from an :ref:`Object` using :ref:`@GDScript.weakref`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. +A weakref can hold a :ref:`Reference`, without contributing to the reference counter. A weakref can be created from an :ref:`Object` using :ref:`@GDScript.weakref`. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WeakRef_get_ref: -- :ref:`Variant` **get_ref** **(** **)** const +- :ref:`Variant` **get_ref** **(** **)** const -Returns the :ref:`Object` this weakref is referring to. +Returns the :ref:`Object` this weakref is referring to. diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 894ab12c4..6cb7ff7d2 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -7,8 +7,7 @@ WebSocketClient =============== -**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,11 +15,11 @@ Brief Description A WebSocket client implementation -Member Functions ----------------- +Methods +------- +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | +| :ref:`Error` | :ref:`connect_to_url` **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_host` **(** **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,7 +41,7 @@ Emitted when the connection to the server fails. .. _class_WebSocketClient_connection_established: -- **connection_established** **(** :ref:`String` protocol **)** +- **connection_established** **(** :ref:`String` protocol **)** Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server. @@ -53,35 +52,35 @@ Emitted when a connection with the server is established, ``protocol`` will cont Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer. -Member Variables ----------------- +Description +----------- + +This class implements a WebSocket client compatible with any RFC 6455 complaint WebSocket server. + +This client can be optionally used as a network peer for the :ref:`MultiplayerAPI`. + +After starting the client (:ref:`connect_to_url`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). + +You will received appropriate signals when connecting, disconnecting, or when new data is available. + +Property Descriptions +--------------------- .. _class_WebSocketClient_verify_ssl: - :ref:`bool` **verify_ssl** - Enable or disable SSL certificate verification. Note: You must specify the certificates to be used in the project settings for it to work when exported. -Description ------------ - -This class implements a WebSocket client compatible with any RFC 6455 complaint WebSocket server. - -This client can be optionally used as a network peer for the :ref:`MultiplayerAPI`. - -After starting the client (:ref:`connect_to_url`), you will need to :ref:`NetworkedMultiplayerPeer.poll` it at regular intervals (e.g. inside :ref:`Node._process`). - -You will received appropriate signals when connecting, disconnecting, or when new data is available. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WebSocketClient_connect_to_url: -- :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** +- :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** Connect to the given URL requesting one of the given ``protocols`` as sub-protocol. -If ``true`` is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connnections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. +If ``true`` is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connnections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. .. _class_WebSocketClient_disconnect_from_host: diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index b4035d435..6e3890696 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -7,10 +7,8 @@ WebSocketMultiplayerPeer ======================== -**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - -**Inherited By:** :ref:`WebSocketClient`, :ref:`WebSocketServer` - +**Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`WebSocketClient`, :ref:`WebSocketServer` **Category:** Core Brief Description @@ -18,11 +16,11 @@ Brief Description Base class for WebSocket server and client. -Member Functions ----------------- +Methods +------- +--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | +| :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** const | +--------------------------------------------+----------------------------------------------------------------------------------------------------------+ Signals @@ -38,15 +36,15 @@ Emitted when a packet is received from a peer. Note: this signal is only emitted Description ----------- -Base class for WebSocket server and client, allowing them to be used as network peer for the :ref:`MultiplayerAPI`. +Base class for WebSocket server and client, allowing them to be used as network peer for the :ref:`MultiplayerAPI`. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WebSocketMultiplayerPeer_get_peer: -- :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const +- :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const -Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. +Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index 49863b2b0..e989194e1 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -7,8 +7,7 @@ WebSocketPeer ============= -**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,27 +15,27 @@ Brief Description A class representing a specific WebSocket connection. -Member Functions ----------------- +Methods +------- +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +| :ref:`String` | :ref:`get_connected_host` **(** **)** const | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connected_port` **(** **)** const | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** const | +| :ref:`WriteMode` | :ref:`get_write_mode` **(** **)** const | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_write_mode` **(** :ref:`WriteMode` mode **)** | +| void | :ref:`set_write_mode` **(** :ref:`WriteMode` mode **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`was_string_packet` **(** **)** const | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_WebSocketPeer_WriteMode: @@ -53,8 +52,8 @@ This class represent a specific WebSocket connection, you can do lower level ope You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WebSocketPeer_close: @@ -64,7 +63,7 @@ Close this WebSocket connection, actively disconnecting the peer. .. _class_WebSocketPeer_get_connected_host: -- :ref:`String` **get_connected_host** **(** **)** const +- :ref:`String` **get_connected_host** **(** **)** const Returns the IP Address of the connected peer. (Not available in HTML5 export) @@ -76,9 +75,9 @@ Returns the remote port of the connected peer. (Not available in HTML5 export) .. _class_WebSocketPeer_get_write_mode: -- :ref:`WriteMode` **get_write_mode** **(** **)** const +- :ref:`WriteMode` **get_write_mode** **(** **)** const -Get the current selected write mode. See :ref:`WriteMode`. +Get the current selected write mode. See :ref:`WriteMode`. .. _class_WebSocketPeer_is_connected_to_host: @@ -88,14 +87,14 @@ Returns ``true`` if this peer is currently connected. .. _class_WebSocketPeer_set_write_mode: -- void **set_write_mode** **(** :ref:`WriteMode` mode **)** +- void **set_write_mode** **(** :ref:`WriteMode` mode **)** -Sets the socket to use the given :ref:`WriteMode`. +Sets the socket to use the given :ref:`WriteMode`. .. _class_WebSocketPeer_was_string_packet: - :ref:`bool` **was_string_packet** **(** **)** const -Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode` +Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode` diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index 9dab36aa6..19408e999 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -7,8 +7,7 @@ WebSocketServer =============== -**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`WebSocketMultiplayerPeer` **<** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,13 +15,13 @@ Brief Description A WebSocket server implementation -Member Functions ----------------- +Methods +------- +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` id **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +| :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,7 +29,7 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_listening` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | +| :ref:`Error` | :ref:`listen` **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,7 +39,7 @@ Signals .. _class_WebSocketServer_client_connected: -- **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** +- **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client. @@ -66,8 +65,8 @@ After starting the server (:ref:`listen`), you wil Note: This class will not work in HTML5 exports due to browser restrictions. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WebSocketServer_disconnect_peer: @@ -77,7 +76,7 @@ Disconnects the given peer. .. _class_WebSocketServer_get_peer_address: -- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const +- :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. @@ -101,13 +100,13 @@ Returns ``true`` if the server is actively listening on a port. .. _class_WebSocketServer_listen: -- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** +- :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** Start listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), "binary" will be used. -You can use this server as a network peer for :ref:`MultiplayerAPI` by passing true as "gd_mp_api". Note: :ref:`data_received` will not be fired and clients other than Godot will not work in this case. +You can use this server as a network peer for :ref:`MultiplayerAPI` by passing true as "gd_mp_api". Note: :ref:`data_received` will not be fired and clients other than Godot will not work in this case. .. _class_WebSocketServer_stop: diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 5d463d5b0..c8b1bf802 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -7,10 +7,8 @@ WindowDialog ============ -**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`AcceptDialog` - +**Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`AcceptDialog` **Category:** Core Brief Description @@ -18,15 +16,20 @@ Brief Description Base class for window dialogs. -Member Functions ----------------- +Methods +------- +--------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | +| :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------+ -Member Variables ----------------- +Description +----------- + +Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel :ref:`Control` that draws a window decoration and allows motion and resizing. + +Property Descriptions +--------------------- .. _class_WindowDialog_resizable: @@ -34,21 +37,16 @@ Member Variables .. _class_WindowDialog_window_title: -- :ref:`String` **window_title** - The text displayed in the window's title bar. Default value: "Save a File". +- :ref:`String` **window_title** - The text displayed in the window's title bar. -Description ------------ - -Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel :ref:`Control` that draws a window decoration and allows motion and resizing. - -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_WindowDialog_get_close_button: -- :ref:`TextureButton` **get_close_button** **(** **)** +- :ref:`TextureButton` **get_close_button** **(** **)** -Return the close :ref:`TextureButton`. +Return the close :ref:`TextureButton`. diff --git a/classes/class_world.rst b/classes/class_world.rst index aeed6c422..0a9069aa6 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -7,8 +7,7 @@ World ===== -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,30 +15,6 @@ Brief Description Class that has everything pertaining to a world. -Member Variables ----------------- - - .. _class_World_direct_space_state: - -- :ref:`PhysicsDirectSpaceState` **direct_space_state** - The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. - - .. _class_World_environment: - -- :ref:`Environment` **environment** - The World's :ref:`Environment`. - - .. _class_World_fallback_environment: - -- :ref:`Environment` **fallback_environment** - The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. - - .. _class_World_scenario: - -- :ref:`RID` **scenario** - The World's visual scenario. - - .. _class_World_space: - -- :ref:`RID` **space** - The World's physics space. - - Description ----------- @@ -50,3 +25,27 @@ Tutorials - :doc:`../tutorials/physics/ray-casting` +Property Descriptions +--------------------- + + .. _class_World_direct_space_state: + +- :ref:`PhysicsDirectSpaceState` **direct_space_state** - The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. + + .. _class_World_environment: + +- :ref:`Environment` **environment** - The World's :ref:`Environment`. + + .. _class_World_fallback_environment: + +- :ref:`Environment` **fallback_environment** - The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. + + .. _class_World_scenario: + +- :ref:`RID` **scenario** - The World's visual scenario. + + .. _class_World_space: + +- :ref:`RID` **space** - The World's physics space. + + diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 16eeea929..e9bef234b 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -7,8 +7,7 @@ World2D ======= -**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,22 +15,6 @@ Brief Description Class that has everything pertaining to a 2D world. -Member Variables ----------------- - - .. _class_World2D_canvas: - -- :ref:`RID` **canvas** - The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. - - .. _class_World2D_direct_space_state: - -- :ref:`Physics2DDirectSpaceState` **direct_space_state** - The state of this world's physics space. This allows arbitrary querying for collision. - - .. _class_World2D_space: - -- :ref:`RID` **space** - The :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. - - Description ----------- @@ -42,3 +25,19 @@ Tutorials - :doc:`../tutorials/physics/ray-casting` +Property Descriptions +--------------------- + + .. _class_World2D_canvas: + +- :ref:`RID` **canvas** - The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. + + .. _class_World2D_direct_space_state: + +- :ref:`Physics2DDirectSpaceState` **direct_space_state** - The state of this world's physics space. This allows arbitrary querying for collision. + + .. _class_World2D_space: + +- :ref:`RID` **space** - The :ref:`RID` of this world's physics space resource. Used by the :ref:`Physics2DServer` for 2D physics, treating it as both a space and an area. + + diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 2a7308f9b..8ddc24c5b 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -7,8 +7,7 @@ WorldEnvironment ================ -**Inherits:** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,20 +15,12 @@ Brief Description Default environment properties for the entire scene (post-processing effects, lightning and background settings). -Member Variables ----------------- - - .. _class_WorldEnvironment_environment: - -- :ref:`Environment` **environment** - The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. - - Description ----------- -The ``WorldEnvironment`` node is used to configure the default :ref:`Environment` for the scene. +The ``WorldEnvironment`` node is used to configure the default :ref:`Environment` for the scene. -The parameters defined in the ``WorldEnvironment`` can be overridden by an :ref:`Environment` node set on the current :ref:`Camera`. Additionally, only one ``WorldEnvironment`` may be instanced in a given scene at a time. +The parameters defined in the ``WorldEnvironment`` can be overridden by an :ref:`Environment` node set on the current :ref:`Camera`. Additionally, only one ``WorldEnvironment`` may be instanced in a given scene at a time. The ``WorldEnvironment`` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene. @@ -38,3 +29,11 @@ Tutorials - :doc:`../tutorials/3d/environment_and_post_processing` +Property Descriptions +--------------------- + + .. _class_WorldEnvironment_environment: + +- :ref:`Environment` **environment** - The :ref:`Environment` resource used by this ``WorldEnvironment``, defining the default properties. + + diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index 32701867a..fe6c3355a 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -7,8 +7,7 @@ XMLParser ========= -**Inherits:** :ref:`Reference` **<** :ref:`Object` - +**Inherits:** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,47 +15,47 @@ Brief Description Low-level class for creating parsers for XML files. -Member Functions ----------------- +Methods +------- +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_attribute_count` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_attribute_name` **(** :ref:`int` idx **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** const | +| :ref:`String` | :ref:`get_attribute_value` **(** :ref:`int` idx **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_line` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** const | +| :ref:`String` | :ref:`get_named_attribute_value` **(** :ref:`String` name **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** const | +| :ref:`String` | :ref:`get_named_attribute_value_safe` **(** :ref:`String` name **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_data` **(** **)** const | +| :ref:`String` | :ref:`get_node_data` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_node_name` **(** **)** const | +| :ref:`String` | :ref:`get_node_name` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_offset` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodeType` | :ref:`get_node_type` **(** **)** | +| :ref:`NodeType` | :ref:`get_node_type` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** const | +| :ref:`bool` | :ref:`has_attribute` **(** :ref:`String` name **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_empty` **(** **)** const | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` file **)** | +| :ref:`Error` | :ref:`open` **(** :ref:`String` file **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | +| :ref:`Error` | :ref:`open_buffer` **(** :ref:`PoolByteArray` buffer **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`read` **(** **)** | +| :ref:`Error` | :ref:`read` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`seek` **(** :ref:`int` position **)** | +| :ref:`Error` | :ref:`seek` **(** :ref:`int` position **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skip_section` **(** **)** | +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -Enums ------ +Enumerations +------------ .. _enum_XMLParser_NodeType: @@ -76,8 +75,8 @@ Description This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. -Member Function Description ---------------------------- +Method Descriptions +------------------- .. _class_XMLParser_get_attribute_count: @@ -87,13 +86,13 @@ Get the amount of attributes in the current element. .. _class_XMLParser_get_attribute_name: -- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_name** **(** :ref:`int` idx **)** const Get the name of the attribute specified by the index in ``idx`` argument. .. _class_XMLParser_get_attribute_value: -- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const +- :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const Get the value of the attribute specified by the index in ``idx`` argument. @@ -105,25 +104,25 @@ Get the current line in the parsed file (currently not implemented). .. _class_XMLParser_get_named_attribute_value: -- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value** **(** :ref:`String` name **)** const Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. .. _class_XMLParser_get_named_attribute_value_safe: -- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const +- :ref:`String` **get_named_attribute_value_safe** **(** :ref:`String` name **)** const -Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String` if the attribute is not found. +Get the value of a certain attribute of the current element by name. This will return an empty :ref:`String` if the attribute is not found. .. _class_XMLParser_get_node_data: -- :ref:`String` **get_node_data** **(** **)** const +- :ref:`String` **get_node_data** **(** **)** const Get the contents of a text node. This will raise an error in any other type of node. .. _class_XMLParser_get_node_name: -- :ref:`String` **get_node_name** **(** **)** const +- :ref:`String` **get_node_name** **(** **)** const Get the name of the current element node. This will raise an error if the current node type is not ``NODE_ELEMENT`` nor ``NODE_ELEMENT_END`` @@ -135,13 +134,13 @@ Get the byte offset of the current node since the beginning of the file or buffe .. _class_XMLParser_get_node_type: -- :ref:`NodeType` **get_node_type** **(** **)** +- :ref:`NodeType` **get_node_type** **(** **)** Get the type of the current node. Compare with ``NODE_*`` constants. .. _class_XMLParser_has_attribute: -- :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const +- :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const Check whether or not the current element has a certain attribute. @@ -153,25 +152,25 @@ Check whether the current element is empty (this only works for completely empty .. _class_XMLParser_open: -- :ref:`Error` **open** **(** :ref:`String` file **)** +- :ref:`Error` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. .. _class_XMLParser_open_buffer: -- :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** +- :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. .. _class_XMLParser_read: -- :ref:`Error` **read** **(** **)** +- :ref:`Error` **read** **(** **)** Read the next node of the file. This returns an error code. .. _class_XMLParser_seek: -- :ref:`Error` **seek** **(** :ref:`int` position **)** +- :ref:`Error` **seek** **(** :ref:`int` position **)** Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index f9b1444ef..ff09d21ab 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -7,8 +7,7 @@ YSort ===== -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description @@ -16,16 +15,16 @@ Brief Description Sort all child nodes based on their Y positions. -Member Variables ----------------- +Description +----------- + +Sort all child nodes based on their Y positions. The child node must inherit from :ref:`CanvasItem` for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. + +Property Descriptions +--------------------- .. _class_YSort_sort_enabled: - :ref:`bool` **sort_enabled** -Description ------------ - -Sort all child nodes based on their Y positions. The child node must inherit from :ref:`CanvasItem` for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. -