diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 2e09e9326..5ef29f57d 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -32,7 +32,7 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`atan` **(** :ref:`float` s **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`atan2` **(** :ref:`float` x, :ref:`float` y **)** | +| :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -194,6 +194,7 @@ Constants - **NAN** = **nan** --- Macro constant that expands to an expression of type float that represents a NaN. The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. + Description ----------- @@ -202,7 +203,7 @@ List of core built-in GDScript functions. Math functions and other utilities. Ev Method Descriptions ------------------- - .. _class_@GDScript_Color8: +.. _class_@GDScript_Color8: - :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** @@ -220,7 +221,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha red = Color8(255, 0, 0) - .. _class_@GDScript_ColorN: +.. _class_@GDScript_ColorN: - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha=1.0 **)** @@ -234,7 +235,7 @@ Supported color names: "aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black", "blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse", "chocolate", "coral", "cornflower", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan", "darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen", "darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue", "darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray", "dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite", "gold", "goldenrod", "gray", "webgray", "green", "webgreen", "greenyellow", "honeydew", "hotpink", "indianred", "indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon", "lightblue", "lightcoral", "lightcyan", "lightgoldenrod", "lightgray", "lightgreen", "lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray", "lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon", "webmaroon", "mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen", "mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue", "mintcream", "mistyrose", "moccasin", "navajowhite", "navyblue", "oldlace", "olive", "olivedrab", "orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise", "palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple", "webpurple", "rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown", "seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow", "springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "turquoise", "violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen". - .. _class_@GDScript_abs: +.. _class_@GDScript_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** @@ -245,7 +246,7 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for i # a is 1 a = abs(-1) - .. _class_@GDScript_acos: +.. _class_@GDScript_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** @@ -256,7 +257,7 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s`` # c is 0.523599 or 30 degrees if converted with rad2deg(s) c = acos(0.866025) - .. _class_@GDScript_asin: +.. _class_@GDScript_asin: - :ref:`float` **asin** **(** :ref:`float` s **)** @@ -267,7 +268,7 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. # s is 0.523599 or 30 degrees if converted with rad2deg(s) s = asin(0.5) - .. _class_@GDScript_assert: +.. _class_@GDScript_assert: - void **assert** **(** :ref:`bool` condition **)** @@ -281,7 +282,7 @@ Assert that the ``condition`` is true. If the ``condition`` is false a fatal err assert(speed >= 0) # Is false and program stops assert(speed >= 0 && speed < 20) # Or combined - .. _class_@GDScript_atan: +.. _class_@GDScript_atan: - :ref:`float` **atan** **(** :ref:`float` s **)** @@ -293,9 +294,9 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2< a = atan(0.5) # a is 0.463648 - .. _class_@GDScript_atan2: +.. _class_@GDScript_atan2: -- :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** +- :ref:`float` **atan2** **(** :ref:`float` y, :ref:`float` x **)** Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. @@ -303,19 +304,19 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` a = atan(0,-1) # a is 3.141593 - .. _class_@GDScript_bytes2var: +.. _class_@GDScript_bytes2var: - :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** Decodes a byte array back to a value. - .. _class_@GDScript_cartesian2polar: +.. _class_@GDScript_cartesian2polar: - :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). - .. _class_@GDScript_ceil: +.. _class_@GDScript_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** @@ -326,7 +327,7 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than i = ceil(1.45) # i is 2 i = ceil(1.001) # i is 2 - .. _class_@GDScript_char: +.. _class_@GDScript_char: - :ref:`String` **char** **(** :ref:`int` ascii **)** @@ -339,7 +340,7 @@ Returns a character as a String of the given ASCII code. # a is 'a' a = char(65+32) - .. _class_@GDScript_clamp: +.. _class_@GDScript_clamp: - :ref:`float` **clamp** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -355,7 +356,7 @@ Clamps ``value`` and returns a value not less than ``min`` and not more than ``m # a is 1 a = clamp(speed, 1, 20) - .. _class_@GDScript_convert: +.. _class_@GDScript_convert: - :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** @@ -371,7 +372,7 @@ Converts from a type to another in the best way possible. The ``type`` parameter # (1, 0) is 6 characters print(a.length()) - .. _class_@GDScript_cos: +.. _class_@GDScript_cos: - :ref:`float` **cos** **(** :ref:`float` s **)** @@ -383,7 +384,7 @@ Returns the cosine of angle ``s`` in radians. print(cos(PI*2)) print(cos(PI)) - .. _class_@GDScript_cosh: +.. _class_@GDScript_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** @@ -394,13 +395,13 @@ Returns the hyperbolic cosine of ``s`` in radians. # prints 1.543081 print(cosh(1)) - .. _class_@GDScript_db2linear: +.. _class_@GDScript_db2linear: - :ref:`float` **db2linear** **(** :ref:`float` db **)** Converts from decibels to linear energy (audio). - .. _class_@GDScript_decimals: +.. _class_@GDScript_decimals: - :ref:`float` **decimals** **(** :ref:`float` step **)** @@ -411,7 +412,7 @@ Returns the position of the first non-zero digit, after the decimal point. # n is 2 n = decimals(0.035) - .. _class_@GDScript_dectime: +.. _class_@GDScript_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** @@ -422,7 +423,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``. # a = 59 a = dectime(60, 10, 0.1)) - .. _class_@GDScript_deg2rad: +.. _class_@GDScript_deg2rad: - :ref:`float` **deg2rad** **(** :ref:`float` deg **)** @@ -433,19 +434,19 @@ Returns degrees converted to radians. # r is 3.141593 r = deg2rad(180) - .. _class_@GDScript_dict2inst: +.. _class_@GDScript_dict2inst: - :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. - .. _class_@GDScript_ease: +.. _class_@GDScript_ease: - :ref:`float` **ease** **(** :ref:`float` s, :ref:`float` curve **)** Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - .. _class_@GDScript_exp: +.. _class_@GDScript_exp: - :ref:`float` **exp** **(** :ref:`float` s **)** @@ -457,7 +458,7 @@ The natural exponential function. It raises the mathematical constant **e** to t a = exp(2) # approximately 7.39 - .. _class_@GDScript_floor: +.. _class_@GDScript_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** @@ -470,7 +471,7 @@ Rounds ``s`` to the closest smaller integer and returns it. # a is -3 a = floor(-2.99) - .. _class_@GDScript_fmod: +.. _class_@GDScript_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -481,7 +482,7 @@ Returns the floating-point remainder of ``x/y``. # remainder is 1.5 var remainder = fmod(7, 5.5) - .. _class_@GDScript_fposmod: +.. _class_@GDScript_fposmod: - :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** @@ -509,7 +510,7 @@ Produces: -2 8 -1 9 - .. _class_@GDScript_funcref: +.. _class_@GDScript_funcref: - :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** @@ -523,11 +524,11 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n a = funcref(self, "foo") print(a.call_func()) # prints bar - .. _class_@GDScript_get_stack: +.. _class_@GDScript_get_stack: - :ref:`Array` **get_stack** **(** **)** - .. _class_@GDScript_hash: +.. _class_@GDScript_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** @@ -537,7 +538,7 @@ Returns the integer hash of the variable passed. print(hash("a")) # prints 177670 - .. _class_@GDScript_inst2dict: +.. _class_@GDScript_inst2dict: - :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** @@ -558,7 +559,7 @@ Prints out: [@subpath, @path, foo] [, res://test.gd, bar] - .. _class_@GDScript_instance_from_id: +.. _class_@GDScript_instance_from_id: - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** @@ -572,7 +573,7 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu var inst = instance_from_id(id) print(inst.foo) # prints bar - .. _class_@GDScript_inverse_lerp: +.. _class_@GDScript_inverse_lerp: - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -582,23 +583,23 @@ Returns a normalized value considering the given range. inverse_lerp(3, 5, 4) # returns 0.5 - .. _class_@GDScript_is_inf: +.. _class_@GDScript_is_inf: - :ref:`bool` **is_inf** **(** :ref:`float` s **)** Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity). - .. _class_@GDScript_is_instance_valid: +.. _class_@GDScript_is_instance_valid: - :ref:`bool` **is_instance_valid** **(** :ref:`Object` instance **)** - .. _class_@GDScript_is_nan: +.. _class_@GDScript_is_nan: - :ref:`bool` **is_nan** **(** :ref:`float` s **)** Returns True/False whether ``s`` is a NaN (Not-A-Number) value. - .. _class_@GDScript_len: +.. _class_@GDScript_len: - :ref:`int` **len** **(** :ref:`Variant` var **)** @@ -611,7 +612,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem a = [1, 2, 3, 4] len(a) # returns 4 - .. _class_@GDScript_lerp: +.. _class_@GDScript_lerp: - :ref:`float` **lerp** **(** :ref:`Variant` from, :ref:`Variant` to, :ref:`float` weight **)** @@ -621,13 +622,13 @@ Linearly interpolates between two values by a normalized value. lerp(1, 3, 0.5) # returns 2 - .. _class_@GDScript_linear2db: +.. _class_@GDScript_linear2db: - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** Converts from linear energy to decibels (audio). - .. _class_@GDScript_load: +.. _class_@GDScript_load: - :ref:`Resource` **load** **(** :ref:`String` path **)** @@ -640,7 +641,7 @@ Loads a resource from the filesystem located at ``path``. # load a scene called main located in the root of the project directory var main = load("res://main.tscn") - .. _class_@GDScript_log: +.. _class_@GDScript_log: - :ref:`float` **log** **(** :ref:`float` s **)** @@ -652,7 +653,7 @@ Natural logarithm. The amount of time needed to reach a certain level of continu log(10) # returns 2.302585 - .. _class_@GDScript_max: +.. _class_@GDScript_max: - :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** @@ -663,7 +664,7 @@ Returns the maximum of two values. max(1,2) # returns 2 max(-3.99, -4) # returns -3.99 - .. _class_@GDScript_min: +.. _class_@GDScript_min: - :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** @@ -674,7 +675,7 @@ Returns the minimum of two values. min(1,2) # returns 1 min(-3.99, -4) # returns -4 - .. _class_@GDScript_nearest_po2: +.. _class_@GDScript_nearest_po2: - :ref:`int` **nearest_po2** **(** :ref:`int` value **)** @@ -686,7 +687,7 @@ Returns the nearest larger power of 2 for integer ``value``. nearest_po2(4) # returns 4 nearest_po2(5) # returns 8 - .. _class_@GDScript_parse_json: +.. _class_@GDScript_parse_json: - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** @@ -704,13 +705,13 @@ Note that JSON objects do not preserve key order like Godot dictionaries, thus y else: print("unexpected results") - .. _class_@GDScript_polar2cartesian: +.. _class_@GDScript_polar2cartesian: - :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). - .. _class_@GDScript_pow: +.. _class_@GDScript_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** @@ -720,7 +721,7 @@ Returns the result of ``x`` raised to the power of ``y``. pow(2,5) # returns 32 - .. _class_@GDScript_preload: +.. _class_@GDScript_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** @@ -733,7 +734,7 @@ Returns a resource from the filesystem that is loaded during script parsing. # load a scene called main located in the root of the project directory var main = preload("res://main.tscn") - .. _class_@GDScript_print: +.. _class_@GDScript_print: - void **print** **(** **)** vararg @@ -744,11 +745,11 @@ Converts one or more arguments to strings in the best way possible and prints th a = [1,2,3] print("a","b",a) # prints ab[1, 2, 3] - .. _class_@GDScript_print_debug: +.. _class_@GDScript_print_debug: - void **print_debug** **(** **)** vararg - .. _class_@GDScript_print_stack: +.. _class_@GDScript_print_stack: - void **print_stack** **(** **)** @@ -760,7 +761,7 @@ Output in the console would look something like this: Frame 0 - res://test.gd:16 in function '_process' - .. _class_@GDScript_printerr: +.. _class_@GDScript_printerr: - void **printerr** **(** **)** vararg @@ -770,7 +771,7 @@ Prints one or more arguments to strings in the best way possible to standard err printerr("prints to stderr") - .. _class_@GDScript_printraw: +.. _class_@GDScript_printraw: - void **printraw** **(** **)** vararg @@ -782,7 +783,7 @@ Prints one or more arguments to strings in the best way possible to console. No printraw("B") # prints AB - .. _class_@GDScript_prints: +.. _class_@GDScript_prints: - void **prints** **(** **)** vararg @@ -792,7 +793,7 @@ Prints one or more arguments to the console with a space between each argument. prints("A", "B", "C") # prints A B C - .. _class_@GDScript_printt: +.. _class_@GDScript_printt: - void **printt** **(** **)** vararg @@ -802,7 +803,7 @@ Prints one or more arguments to the console with a tab between each argument. printt("A", "B", "C") # prints A B C - .. _class_@GDScript_rad2deg: +.. _class_@GDScript_rad2deg: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** @@ -812,7 +813,7 @@ Converts from radians to degrees. rad2deg(0.523599) # returns 30 - .. _class_@GDScript_rand_range: +.. _class_@GDScript_rand_range: - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** @@ -822,13 +823,13 @@ Random range, any floating point value between ``from`` and ``to``. prints(rand_range(0, 1), rand_range(0, 1)) # prints 0.135591 0.405263 - .. _class_@GDScript_rand_seed: +.. _class_@GDScript_rand_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. - .. _class_@GDScript_randf: +.. _class_@GDScript_randf: - :ref:`float` **randf** **(** **)** @@ -838,7 +839,7 @@ Returns a random floating point value between 0 and 1. randf() # returns 0.375671 - .. _class_@GDScript_randi: +.. _class_@GDScript_randi: - :ref:`int` **randi** **(** **)** @@ -850,7 +851,7 @@ Returns a random 32 bit integer. Use remainder to obtain a random value between randi() % 100 # returns random number between 0 and 99 randi() % 100 + 1 # returns random number between 1 and 100 - .. _class_@GDScript_randomize: +.. _class_@GDScript_randomize: - void **randomize** **(** **)** @@ -861,7 +862,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr func _ready(): randomize() - .. _class_@GDScript_range: +.. _class_@GDScript_range: - :ref:`Array` **range** **(** **)** vararg @@ -893,7 +894,7 @@ Output: 2 4 - .. _class_@GDScript_range_lerp: +.. _class_@GDScript_range_lerp: - :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** @@ -903,7 +904,7 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. range_lerp(75, 0, 100, -1, 1) # returns 0.5 - .. _class_@GDScript_round: +.. _class_@GDScript_round: - :ref:`float` **round** **(** :ref:`float` s **)** @@ -913,7 +914,7 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded round(2.6) # returns 3 - .. _class_@GDScript_seed: +.. _class_@GDScript_seed: - void **seed** **(** :ref:`int` seed **)** @@ -924,7 +925,7 @@ Sets seed for the random number generator. my_seed = "Godot Rocks" seed(my_seed.hash()) - .. _class_@GDScript_sign: +.. _class_@GDScript_sign: - :ref:`float` **sign** **(** :ref:`float` s **)** @@ -936,7 +937,7 @@ Returns the sign of ``s``: -1 or 1. Returns 0 if ``s`` is 0. sign(0) # returns 0 sign(6) # returns 1 - .. _class_@GDScript_sin: +.. _class_@GDScript_sin: - :ref:`float` **sin** **(** :ref:`float` s **)** @@ -946,7 +947,7 @@ Returns the sine of angle ``s`` in radians. sin(0.523599) # returns 0.5 - .. _class_@GDScript_sinh: +.. _class_@GDScript_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** @@ -957,7 +958,7 @@ Returns the hyperbolic sine of ``s``. a = log(2.0) # returns 0.693147 sinh(a) # returns 0.75 - .. _class_@GDScript_sqrt: +.. _class_@GDScript_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** @@ -967,13 +968,13 @@ Returns the square root of ``s``. sqrt(9) # returns 3 - .. _class_@GDScript_stepify: +.. _class_@GDScript_stepify: - :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** Snaps float value ``s`` to a given ``step``. - .. _class_@GDScript_str: +.. _class_@GDScript_str: - :ref:`String` **str** **(** **)** vararg @@ -986,7 +987,7 @@ Converts one or more arguments to string in the best way possible. len(a) # returns 3 len(b) # returns 12 - .. _class_@GDScript_str2var: +.. _class_@GDScript_str2var: - :ref:`Variant` **str2var** **(** :ref:`String` string **)** @@ -998,7 +999,7 @@ Converts a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** @@ -1008,7 +1009,7 @@ Returns the tangent of angle ``s`` in radians. tan( deg2rad(45) ) # returns 1 - .. _class_@GDScript_tanh: +.. _class_@GDScript_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** @@ -1019,7 +1020,7 @@ Returns the hyperbolic tangent of ``s``. a = log(2.0) # returns 0.693147 tanh(a) # returns 0.6 - .. _class_@GDScript_to_json: +.. _class_@GDScript_to_json: - :ref:`String` **to_json** **(** :ref:`Variant` var **)** @@ -1031,7 +1032,7 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial b = to_json(a) print(b) # {"a":1, "b":2} - .. _class_@GDScript_type_exists: +.. _class_@GDScript_type_exists: - :ref:`bool` **type_exists** **(** :ref:`String` type **)** @@ -1042,7 +1043,7 @@ Returns whether the given class exists in :ref:`ClassDB`. type_exists("Sprite") # returns true type_exists("Variant") # returns false - .. _class_@GDScript_typeof: +.. _class_@GDScript_typeof: - :ref:`int` **typeof** **(** :ref:`Variant` what **)** @@ -1056,7 +1057,7 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i else: print("unexpected results") - .. _class_@GDScript_validate_json: +.. _class_@GDScript_validate_json: - :ref:`String` **validate_json** **(** :ref:`String` json **)** @@ -1071,13 +1072,13 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns else: prints("invalid", v) - .. _class_@GDScript_var2bytes: +.. _class_@GDScript_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** Encodes a variable value to a byte array. - .. _class_@GDScript_var2str: +.. _class_@GDScript_var2str: - :ref:`String` **var2str** **(** :ref:`Variant` var **)** @@ -1097,7 +1098,7 @@ prints "b": 2 } - .. _class_@GDScript_weakref: +.. _class_@GDScript_weakref: - :ref:`WeakRef` **weakref** **(** :ref:`Object` obj **)** @@ -1105,7 +1106,7 @@ Returns a weak reference to an object. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. - .. _class_@GDScript_wrapf: +.. _class_@GDScript_wrapf: - :ref:`float` **wrapf** **(** :ref:`float` value, :ref:`float` min, :ref:`float` max **)** @@ -1128,7 +1129,7 @@ Usable for creating loop-alike behavior or infinite surfaces. # infinite loop between 0.0 and 0.99 f = wrapf(f + 0.1, 0.0, 1.0) - .. _class_@GDScript_wrapi: +.. _class_@GDScript_wrapi: - :ref:`int` **wrapi** **(** :ref:`int` value, :ref:`int` min, :ref:`int` max **)** @@ -1151,7 +1152,7 @@ Usable for creating loop-alike behavior or infinite surfaces. # infinite loop between 0 and 9 frame = wrapi(frame + 1, 0, 10) - .. _class_@GDScript_yield: +.. _class_@GDScript_yield: - :ref:`GDScriptFunctionState` **yield** **(** :ref:`Object` object=null, :ref:`String` signal="" **)** diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 8190d85ce..e6dbb04d5 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -66,7 +66,7 @@ Properties Enumerations ------------ - .. _enum_@GlobalScope_Variant.Operator: +.. _enum_@GlobalScope_Variant.Operator: enum **Variant.Operator**: @@ -97,7 +97,7 @@ enum **Variant.Operator**: - **OP_IN** = **24** - **OP_MAX** = **25** - .. _enum_@GlobalScope_MethodFlags: +.. _enum_@GlobalScope_MethodFlags: enum **MethodFlags**: @@ -110,14 +110,14 @@ enum **MethodFlags**: - **METHOD_FLAG_FROM_SCRIPT** = **64** --- Flag for method from script - **METHOD_FLAGS_DEFAULT** = **1** --- Default method flags - .. _enum_@GlobalScope_Orientation: +.. _enum_@GlobalScope_Orientation: 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. - .. _enum_@GlobalScope_PropertyUsageFlags: +.. _enum_@GlobalScope_PropertyUsageFlags: enum **PropertyUsageFlags**: @@ -139,7 +139,7 @@ enum **PropertyUsageFlags**: - **PROPERTY_USAGE_DEFAULT_INTL** = **71** - **PROPERTY_USAGE_NOEDITOR** = **5** - .. _enum_@GlobalScope_JoystickList: +.. _enum_@GlobalScope_JoystickList: enum **JoystickList**: @@ -202,7 +202,7 @@ enum **JoystickList**: - **JOY_ANALOG_L2** = **6** --- Joypad Left Analog Trigger - **JOY_ANALOG_R2** = **7** --- Joypad Right Analog Trigger - .. _enum_@GlobalScope_MidiMessageList: +.. _enum_@GlobalScope_MidiMessageList: enum **MidiMessageList**: @@ -214,7 +214,7 @@ enum **MidiMessageList**: - **MIDI_MESSAGE_CHANNEL_PRESSURE** = **13** - **MIDI_MESSAGE_PITCH_BEND** = **14** - .. _enum_@GlobalScope_KeyModifierMask: +.. _enum_@GlobalScope_KeyModifierMask: enum **KeyModifierMask**: @@ -228,7 +228,7 @@ enum **KeyModifierMask**: - **KEY_MASK_KPAD** = **536870912** --- Keypad Key Mask - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch Key Mask - .. _enum_@GlobalScope_HAlign: +.. _enum_@GlobalScope_HAlign: enum **HAlign**: @@ -236,7 +236,7 @@ enum **HAlign**: - **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes. - **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes. - .. _enum_@GlobalScope_Error: +.. _enum_@GlobalScope_Error: enum **Error**: @@ -282,7 +282,7 @@ enum **Error**: - **ERR_HELP** = **46** --- Help error - **ERR_BUG** = **47** --- Bug error - .. _enum_@GlobalScope_VAlign: +.. _enum_@GlobalScope_VAlign: enum **VAlign**: @@ -290,7 +290,7 @@ enum **VAlign**: - **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes. - **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes. - .. _enum_@GlobalScope_PropertyHint: +.. _enum_@GlobalScope_PropertyHint: enum **PropertyHint**: @@ -317,7 +317,7 @@ enum **PropertyHint**: - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **21** --- Hints that the image is compressed using lossy compression. - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **22** --- Hints that the image is compressed using lossless compression. - .. _enum_@GlobalScope_Corner: +.. _enum_@GlobalScope_Corner: enum **Corner**: @@ -326,7 +326,7 @@ enum **Corner**: - **CORNER_BOTTOM_RIGHT** = **2** - **CORNER_BOTTOM_LEFT** = **3** - .. _enum_@GlobalScope_KeyList: +.. _enum_@GlobalScope_KeyList: enum **KeyList**: @@ -573,7 +573,7 @@ enum **KeyList**: - **KEY_DIVISION** = **247** --- ÷ key - **KEY_YDIAERESIS** = **255** --- ÿ key - .. _enum_@GlobalScope_Variant.Type: +.. _enum_@GlobalScope_Variant.Type: enum **Variant.Type**: @@ -606,7 +606,7 @@ enum **Variant.Type**: - **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray`. - **TYPE_MAX** = **27** --- Marker for end of type constants. - .. _enum_@GlobalScope_Margin: +.. _enum_@GlobalScope_Margin: enum **Margin**: @@ -615,7 +615,7 @@ enum **Margin**: - **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: +.. _enum_@GlobalScope_ButtonList: enum **ButtonList**: @@ -638,6 +638,7 @@ Constants --------- - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. + Description ----------- @@ -648,131 +649,131 @@ Singletons are also documented here, since they can be accessed from anywhere. Property Descriptions --------------------- - .. _class_@GlobalScope_ARVRServer: +.. _class_@GlobalScope_ARVRServer: - :ref:`ARVRServer` **ARVRServer** :ref:`ARVRServer` singleton - .. _class_@GlobalScope_AudioServer: +.. _class_@GlobalScope_AudioServer: - :ref:`AudioServer` **AudioServer** :ref:`AudioServer` singleton - .. _class_@GlobalScope_ClassDB: +.. _class_@GlobalScope_ClassDB: - :ref:`ClassDB` **ClassDB** :ref:`ClassDB` singleton - .. _class_@GlobalScope_Engine: +.. _class_@GlobalScope_Engine: - :ref:`Engine` **Engine** :ref:`Engine` singleton - .. _class_@GlobalScope_Geometry: +.. _class_@GlobalScope_Geometry: - :ref:`Geometry` **Geometry** :ref:`Geometry` singleton - .. _class_@GlobalScope_GodotSharp: +.. _class_@GlobalScope_GodotSharp: - :ref:`GodotSharp` **GodotSharp** - .. _class_@GlobalScope_IP: +.. _class_@GlobalScope_IP: - :ref:`IP` **IP** :ref:`IP` singleton - .. _class_@GlobalScope_Input: +.. _class_@GlobalScope_Input: - :ref:`Input` **Input** :ref:`Input` singleton - .. _class_@GlobalScope_InputMap: +.. _class_@GlobalScope_InputMap: - :ref:`InputMap` **InputMap** :ref:`InputMap` singleton - .. _class_@GlobalScope_JSON: +.. _class_@GlobalScope_JSON: - :ref:`JSON` **JSON** :ref:`JSON` singleton - .. _class_@GlobalScope_JavaScript: +.. _class_@GlobalScope_JavaScript: - :ref:`JavaScript` **JavaScript** :ref:`JavaScript` singleton - .. _class_@GlobalScope_Marshalls: +.. _class_@GlobalScope_Marshalls: - :ref:`Reference` **Marshalls** :ref:`Marshalls` singleton - .. _class_@GlobalScope_OS: +.. _class_@GlobalScope_OS: - :ref:`OS` **OS** :ref:`OS` singleton - .. _class_@GlobalScope_Performance: +.. _class_@GlobalScope_Performance: - :ref:`Performance` **Performance** :ref:`Performance` singleton - .. _class_@GlobalScope_Physics2DServer: +.. _class_@GlobalScope_Physics2DServer: - :ref:`Physics2DServer` **Physics2DServer** :ref:`Physics2DServer` singleton - .. _class_@GlobalScope_PhysicsServer: +.. _class_@GlobalScope_PhysicsServer: - :ref:`PhysicsServer` **PhysicsServer** :ref:`PhysicsServer` singleton - .. _class_@GlobalScope_ProjectSettings: +.. _class_@GlobalScope_ProjectSettings: - :ref:`ProjectSettings` **ProjectSettings** :ref:`ProjectSettings` singleton - .. _class_@GlobalScope_ResourceLoader: +.. _class_@GlobalScope_ResourceLoader: - :ref:`ResourceLoader` **ResourceLoader** :ref:`ResourceLoader` singleton - .. _class_@GlobalScope_ResourceSaver: +.. _class_@GlobalScope_ResourceSaver: - :ref:`ResourceSaver` **ResourceSaver** :ref:`ResourceSaver` singleton - .. _class_@GlobalScope_TranslationServer: +.. _class_@GlobalScope_TranslationServer: - :ref:`TranslationServer` **TranslationServer** :ref:`TranslationServer` singleton - .. _class_@GlobalScope_VisualScriptEditor: +.. _class_@GlobalScope_VisualScriptEditor: - :ref:`VisualScriptEditor` **VisualScriptEditor** :ref:`VisualScriptEditor` singleton - .. _class_@GlobalScope_VisualServer: +.. _class_@GlobalScope_VisualServer: - :ref:`VisualServer` **VisualServer** diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 336da5282..62f9724a9 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -81,22 +81,23 @@ Tutorials --------- - :doc:`../tutorials/math/index` + Property Descriptions --------------------- - .. _class_AABB_end: +.. _class_AABB_end: - :ref:`Vector3` **end** Ending corner. - .. _class_AABB_position: +.. _class_AABB_position: - :ref:`Vector3` **position** Beginning corner. - .. _class_AABB_size: +.. _class_AABB_size: - :ref:`Vector3` **size** @@ -105,127 +106,127 @@ Size from position to end. Method Descriptions ------------------- - .. _class_AABB_AABB: +.. _class_AABB_AABB: - :ref:`AABB` **AABB** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. - .. _class_AABB_encloses: +.. _class_AABB_encloses: - :ref:`bool` **encloses** **(** :ref:`AABB` with **)** Returns ``true`` if this ``AABB`` completely encloses another one. - .. _class_AABB_expand: +.. _class_AABB_expand: - :ref:`AABB` **expand** **(** :ref:`Vector3` to_point **)** Returns this ``AABB`` expanded to include a given point. - .. _class_AABB_get_area: +.. _class_AABB_get_area: - :ref:`float` **get_area** **(** **)** Gets the area of the ``AABB``. - .. _class_AABB_get_endpoint: +.. _class_AABB_get_endpoint: - :ref:`Vector3` **get_endpoint** **(** :ref:`int` idx **)** Gets the position of the 8 endpoints of the ``AABB`` in space. - .. _class_AABB_get_longest_axis: +.. _class_AABB_get_longest_axis: - :ref:`Vector3` **get_longest_axis** **(** **)** Returns the normalized longest axis of the ``AABB``. - .. _class_AABB_get_longest_axis_index: +.. _class_AABB_get_longest_axis_index: - :ref:`int` **get_longest_axis_index** **(** **)** Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). - .. _class_AABB_get_longest_axis_size: +.. _class_AABB_get_longest_axis_size: - :ref:`float` **get_longest_axis_size** **(** **)** Returns the scalar length of the longest axis of the ``AABB``. - .. _class_AABB_get_shortest_axis: +.. _class_AABB_get_shortest_axis: - :ref:`Vector3` **get_shortest_axis** **(** **)** Returns the normalized shortest axis of the ``AABB``. - .. _class_AABB_get_shortest_axis_index: +.. _class_AABB_get_shortest_axis_index: - :ref:`int` **get_shortest_axis_index** **(** **)** Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3`::AXIS\* enum). - .. _class_AABB_get_shortest_axis_size: +.. _class_AABB_get_shortest_axis_size: - :ref:`float` **get_shortest_axis_size** **(** **)** Returns the scalar length of the shortest axis of the ``AABB``. - .. _class_AABB_get_support: +.. _class_AABB_get_support: - :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: +.. _class_AABB_grow: - :ref:`AABB` **grow** **(** :ref:`float` by **)** Returns a copy of the ``AABB`` grown a given amount of units towards all the sides. - .. _class_AABB_has_no_area: +.. _class_AABB_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``AABB`` is flat or empty. - .. _class_AABB_has_no_surface: +.. _class_AABB_has_no_surface: - :ref:`bool` **has_no_surface** **(** **)** Returns ``true`` if the ``AABB`` is empty. - .. _class_AABB_has_point: +.. _class_AABB_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** Returns ``true`` if the ``AABB`` contains a point. - .. _class_AABB_intersection: +.. _class_AABB_intersection: - :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: +.. _class_AABB_intersects: - :ref:`bool` **intersects** **(** :ref:`AABB` with **)** Returns ``true`` if the ``AABB`` overlaps with another. - .. _class_AABB_intersects_plane: +.. _class_AABB_intersects_plane: - :ref:`bool` **intersects_plane** **(** :ref:`Plane` plane **)** Returns ``true`` if the ``AABB`` is on both sides of a plane. - .. _class_AABB_intersects_segment: +.. _class_AABB_intersects_segment: - :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: +.. _class_AABB_merge: - :ref:`AABB` **merge** **(** :ref:`AABB` with **)** diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 994b9d703..0bfc6ce1f 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -45,13 +45,13 @@ Methods Signals ------- - .. _class_AcceptDialog_confirmed: +.. _class_AcceptDialog_confirmed: - **confirmed** **(** **)** Emitted when the dialog is accepted, i.e. the OK button is pressed. - .. _class_AcceptDialog_custom_action: +.. _class_AcceptDialog_custom_action: - **custom_action** **(** :ref:`String` action **)** @@ -65,7 +65,7 @@ This dialog is useful for small notifications to the user about an event. It can Property Descriptions --------------------- - .. _class_AcceptDialog_dialog_hide_on_ok: +.. _class_AcceptDialog_dialog_hide_on_ok: - :ref:`bool` **dialog_hide_on_ok** @@ -79,7 +79,7 @@ If ``true`` the dialog is hidden when the OK button is pressed. You can set it t 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: +.. _class_AcceptDialog_dialog_text: - :ref:`String` **dialog_text** @@ -94,7 +94,7 @@ The text displayed by this dialog. Method Descriptions ------------------- - .. _class_AcceptDialog_add_button: +.. _class_AcceptDialog_add_button: - :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** @@ -102,25 +102,25 @@ Adds a button with label *text* and a custom *action* to the dialog and returns If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. - .. _class_AcceptDialog_add_cancel: +.. _class_AcceptDialog_add_cancel: - :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: +.. _class_AcceptDialog_get_label: - :ref:`Label` **get_label** **(** **)** Return the label used for built-in text. - .. _class_AcceptDialog_get_ok: +.. _class_AcceptDialog_get_ok: - :ref:`Button` **get_ok** **(** **)** Return the OK Button. - .. _class_AcceptDialog_register_text_enter: +.. _class_AcceptDialog_register_text_enter: - void **register_text_enter** **(** :ref:`Node` line_edit **)** diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 7cd94addd..bb33ae210 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -53,13 +53,13 @@ Methods Signals ------- - .. _class_AnimatedSprite_animation_finished: +.. _class_AnimatedSprite_animation_finished: - **animation_finished** **(** **)** Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn. - .. _class_AnimatedSprite_frame_changed: +.. _class_AnimatedSprite_frame_changed: - **frame_changed** **(** **)** @@ -73,7 +73,7 @@ Animations are created using a :ref:`SpriteFrames` resource, Property Descriptions --------------------- - .. _class_AnimatedSprite_animation: +.. _class_AnimatedSprite_animation: - :ref:`String` **animation** @@ -85,7 +85,7 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. - .. _class_AnimatedSprite_centered: +.. _class_AnimatedSprite_centered: - :ref:`bool` **centered** @@ -97,7 +97,7 @@ The current animation from the ``frames`` resource. If this value changes, the ` If ``true`` texture will be centered. Default value: ``true``. - .. _class_AnimatedSprite_flip_h: +.. _class_AnimatedSprite_flip_h: - :ref:`bool` **flip_h** @@ -109,7 +109,7 @@ If ``true`` texture will be centered. Default value: ``true``. If ``true`` texture is flipped horizontally. Default value: ``false``. - .. _class_AnimatedSprite_flip_v: +.. _class_AnimatedSprite_flip_v: - :ref:`bool` **flip_v** @@ -121,7 +121,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. If ``true`` texture is flipped vertically. Default value: ``false``. - .. _class_AnimatedSprite_frame: +.. _class_AnimatedSprite_frame: - :ref:`int` **frame** @@ -133,7 +133,7 @@ If ``true`` texture is flipped vertically. Default value: ``false``. The displayed animation frame's index. - .. _class_AnimatedSprite_frames: +.. _class_AnimatedSprite_frames: - :ref:`SpriteFrames` **frames** @@ -145,7 +145,7 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). - .. _class_AnimatedSprite_offset: +.. _class_AnimatedSprite_offset: - :ref:`Vector2` **offset** @@ -157,13 +157,13 @@ The :ref:`SpriteFrames` resource containing the animation(s) The texture's drawing offset. - .. _class_AnimatedSprite_playing: +.. _class_AnimatedSprite_playing: - :ref:`bool` **playing** If ``true`` the :ref:`animation` is currently playing. - .. _class_AnimatedSprite_speed_scale: +.. _class_AnimatedSprite_speed_scale: - :ref:`float` **speed_scale** @@ -176,19 +176,19 @@ If ``true`` the :ref:`animation` is currently pl Method Descriptions ------------------- - .. _class_AnimatedSprite_is_playing: +.. _class_AnimatedSprite_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. - .. _class_AnimatedSprite_play: +.. _class_AnimatedSprite_play: - void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. - .. _class_AnimatedSprite_stop: +.. _class_AnimatedSprite_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index ca152aff6..551d75a45 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -43,7 +43,7 @@ Methods Signals ------- - .. _class_AnimatedSprite3D_frame_changed: +.. _class_AnimatedSprite3D_frame_changed: - **frame_changed** **(** **)** @@ -57,7 +57,7 @@ Animations are created using a :ref:`SpriteFrames` resource, Property Descriptions --------------------- - .. _class_AnimatedSprite3D_animation: +.. _class_AnimatedSprite3D_animation: - :ref:`String` **animation** @@ -69,7 +69,7 @@ Property Descriptions The current animation from the ``frames`` resource. If this value changes, the ``frame`` counter is reset. - .. _class_AnimatedSprite3D_frame: +.. _class_AnimatedSprite3D_frame: - :ref:`int` **frame** @@ -81,7 +81,7 @@ The current animation from the ``frames`` resource. If this value changes, the ` The displayed animation frame's index. - .. _class_AnimatedSprite3D_frames: +.. _class_AnimatedSprite3D_frames: - :ref:`SpriteFrames` **frames** @@ -93,7 +93,7 @@ The displayed animation frame's index. The :ref:`SpriteFrames` resource containing the animation(s). - .. _class_AnimatedSprite3D_playing: +.. _class_AnimatedSprite3D_playing: - :ref:`bool` **playing** @@ -102,19 +102,19 @@ If ``true`` the :ref:`animation` is currently Method Descriptions ------------------- - .. _class_AnimatedSprite3D_is_playing: +.. _class_AnimatedSprite3D_is_playing: - :ref:`bool` **is_playing** **(** **)** const Return true if an animation if currently being played. - .. _class_AnimatedSprite3D_play: +.. _class_AnimatedSprite3D_play: - void **play** **(** :ref:`String` anim="" **)** Play the animation set in parameter. If no parameter is provided, the current animation is played. - .. _class_AnimatedSprite3D_stop: +.. _class_AnimatedSprite3D_stop: - void **stop** **(** **)** diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index c7e6d075f..7d19c41ae 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -41,7 +41,7 @@ Methods Property Descriptions --------------------- - .. _class_AnimatedTexture_fps: +.. _class_AnimatedTexture_fps: - :ref:`float` **fps** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | get_fps() | +----------+----------------+ - .. _class_AnimatedTexture_frames: +.. _class_AnimatedTexture_frames: - :ref:`int` **frames** @@ -64,19 +64,19 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimatedTexture_get_frame_delay: +.. _class_AnimatedTexture_get_frame_delay: - :ref:`float` **get_frame_delay** **(** :ref:`int` frame **)** const - .. _class_AnimatedTexture_get_frame_texture: +.. _class_AnimatedTexture_get_frame_texture: - :ref:`Texture` **get_frame_texture** **(** :ref:`int` frame **)** const - .. _class_AnimatedTexture_set_frame_delay: +.. _class_AnimatedTexture_set_frame_delay: - void **set_frame_delay** **(** :ref:`int` frame, :ref:`float` delay **)** - .. _class_AnimatedTexture_set_frame_texture: +.. _class_AnimatedTexture_set_frame_texture: - void **set_frame_texture** **(** :ref:`int` frame, :ref:`Texture` texture **)** diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 31ad273aa..a12e8427d 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -147,7 +147,7 @@ Methods Enumerations ------------ - .. _enum_Animation_UpdateMode: +.. _enum_Animation_UpdateMode: enum **UpdateMode**: @@ -156,7 +156,7 @@ enum **UpdateMode**: - **UPDATE_TRIGGER** = **2** --- Update at the keyframes. - **UPDATE_CAPTURE** = **3** - .. _enum_Animation_InterpolationType: +.. _enum_Animation_InterpolationType: enum **InterpolationType**: @@ -164,7 +164,7 @@ enum **InterpolationType**: - **INTERPOLATION_LINEAR** = **1** --- Linear interpolation. - **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. - .. _enum_Animation_TrackType: +.. _enum_Animation_TrackType: enum **TrackType**: @@ -186,10 +186,11 @@ Tutorials --------- - :doc:`../tutorials/animation/index` + Property Descriptions --------------------- - .. _class_Animation_length: +.. _class_Animation_length: - :ref:`float` **length** @@ -201,7 +202,7 @@ Property Descriptions 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: +.. _class_Animation_loop: - :ref:`bool` **loop** @@ -213,7 +214,7 @@ The total length of the animation (in seconds). Note that length is not delimite 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: +.. _class_Animation_step: - :ref:`float` **step** @@ -228,265 +229,265 @@ The animation step value. Method Descriptions ------------------- - .. _class_Animation_add_track: +.. _class_Animation_add_track: - :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: +.. _class_Animation_animation_track_get_key_animation: - :ref:`String` **animation_track_get_key_animation** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_animation_track_insert_key: +.. _class_Animation_animation_track_insert_key: - :ref:`int` **animation_track_insert_key** **(** :ref:`int` track, :ref:`float` time, :ref:`String` animation **)** - .. _class_Animation_animation_track_set_key_animation: +.. _class_Animation_animation_track_set_key_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: +.. _class_Animation_audio_track_get_key_end_offset: - :ref:`float` **audio_track_get_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_audio_track_get_key_start_offset: +.. _class_Animation_audio_track_get_key_start_offset: - :ref:`float` **audio_track_get_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_audio_track_get_key_stream: +.. _class_Animation_audio_track_get_key_stream: - :ref:`Resource` **audio_track_get_key_stream** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_audio_track_insert_key: +.. _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 **)** - .. _class_Animation_audio_track_set_key_end_offset: +.. _class_Animation_audio_track_set_key_end_offset: - void **audio_track_set_key_end_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** - .. _class_Animation_audio_track_set_key_start_offset: +.. _class_Animation_audio_track_set_key_start_offset: - void **audio_track_set_key_start_offset** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` offset **)** - .. _class_Animation_audio_track_set_key_stream: +.. _class_Animation_audio_track_set_key_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: +.. _class_Animation_bezier_track_get_key_in_handle: - :ref:`Vector2` **bezier_track_get_key_in_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_bezier_track_get_key_out_handle: +.. _class_Animation_bezier_track_get_key_out_handle: - :ref:`Vector2` **bezier_track_get_key_out_handle** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_bezier_track_get_key_value: +.. _class_Animation_bezier_track_get_key_value: - :ref:`float` **bezier_track_get_key_value** **(** :ref:`int` idx, :ref:`int` key_idx **)** const - .. _class_Animation_bezier_track_insert_key: +.. _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 ) **)** - .. _class_Animation_bezier_track_interpolate: +.. _class_Animation_bezier_track_interpolate: - :ref:`float` **bezier_track_interpolate** **(** :ref:`int` track, :ref:`float` time **)** const - .. _class_Animation_bezier_track_set_key_in_handle: +.. _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 **)** - .. _class_Animation_bezier_track_set_key_out_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 **)** - .. _class_Animation_bezier_track_set_key_value: +.. _class_Animation_bezier_track_set_key_value: - void **bezier_track_set_key_value** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` value **)** - .. _class_Animation_clear: +.. _class_Animation_clear: - void **clear** **(** **)** Clear the animation (clear all tracks and reset all). - .. _class_Animation_copy_track: +.. _class_Animation_copy_track: - 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: +.. _class_Animation_find_track: - :ref:`int` **find_track** **(** :ref:`NodePath` path **)** const Return the index of the specified track. If the track is not found, return -1. - .. _class_Animation_get_track_count: +.. _class_Animation_get_track_count: - :ref:`int` **get_track_count** **(** **)** const Return the amount of tracks in the animation. - .. _class_Animation_method_track_get_key_indices: +.. _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 Return all the key indices of a method track, given a position and delta time. - .. _class_Animation_method_track_get_name: +.. _class_Animation_method_track_get_name: - :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: +.. _class_Animation_method_track_get_params: - :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. - .. _class_Animation_remove_track: +.. _class_Animation_remove_track: - void **remove_track** **(** :ref:`int` idx **)** Remove a track by specifying the track index. - .. _class_Animation_track_find_key: +.. _class_Animation_track_find_key: - :ref:`int` **track_find_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const Find the key index by time in a given track. Optionally, only find it if the exact time is given. - .. _class_Animation_track_get_interpolation_loop_wrap: +.. _class_Animation_track_get_interpolation_loop_wrap: - :ref:`bool` **track_get_interpolation_loop_wrap** **(** :ref:`int` idx **)** const Returns ``true`` if the track at ``idx`` wraps the interpolation loop. Default value: ``true``. - .. _class_Animation_track_get_interpolation_type: +.. _class_Animation_track_get_interpolation_type: - :ref:`InterpolationType` **track_get_interpolation_type** **(** :ref:`int` idx **)** const Return the interpolation type of a given track, from the INTERPOLATION\_\* enum. - .. _class_Animation_track_get_key_count: +.. _class_Animation_track_get_key_count: - :ref:`int` **track_get_key_count** **(** :ref:`int` idx **)** const Return the amount of keys in a given track. - .. _class_Animation_track_get_key_time: +.. _class_Animation_track_get_key_time: - :ref:`float` **track_get_key_time** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the time at which the key is located. - .. _class_Animation_track_get_key_transition: +.. _class_Animation_track_get_key_transition: - :ref:`float` **track_get_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx **)** const Return the transition curve (easing) for a specific key (see built-in math function "ease"). - .. _class_Animation_track_get_key_value: +.. _class_Animation_track_get_key_value: - :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: +.. _class_Animation_track_get_path: - :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: +.. _class_Animation_track_get_type: - :ref:`TrackType` **track_get_type** **(** :ref:`int` idx **)** const Get the type of a track. - .. _class_Animation_track_insert_key: +.. _class_Animation_track_insert_key: - 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. - .. _class_Animation_track_is_enabled: +.. _class_Animation_track_is_enabled: - :ref:`bool` **track_is_enabled** **(** :ref:`int` idx **)** const Returns ``true`` if the track at index ``idx`` is enabled. - .. _class_Animation_track_is_imported: +.. _class_Animation_track_is_imported: - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const Return true if the given track is imported. Else, return false. - .. _class_Animation_track_move_down: +.. _class_Animation_track_move_down: - void **track_move_down** **(** :ref:`int` idx **)** Move a track down. - .. _class_Animation_track_move_up: +.. _class_Animation_track_move_up: - void **track_move_up** **(** :ref:`int` idx **)** Move a track up. - .. _class_Animation_track_remove_key: +.. _class_Animation_track_remove_key: - void **track_remove_key** **(** :ref:`int` idx, :ref:`int` key_idx **)** Remove a key by index in a given track. - .. _class_Animation_track_remove_key_at_position: +.. _class_Animation_track_remove_key_at_position: - void **track_remove_key_at_position** **(** :ref:`int` idx, :ref:`float` position **)** Remove a key by position (seconds) in a given track. - .. _class_Animation_track_set_enabled: +.. _class_Animation_track_set_enabled: - void **track_set_enabled** **(** :ref:`int` idx, :ref:`bool` enabled **)** Enables/disables the given track. Tracks are enabled by default. - .. _class_Animation_track_set_imported: +.. _class_Animation_track_set_imported: - void **track_set_imported** **(** :ref:`int` idx, :ref:`bool` imported **)** Set the given track as imported or not. - .. _class_Animation_track_set_interpolation_loop_wrap: +.. _class_Animation_track_set_interpolation_loop_wrap: - void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** If ``true`` the track at ``idx`` wraps the interpolation loop. - .. _class_Animation_track_set_interpolation_type: +.. _class_Animation_track_set_interpolation_type: - void **track_set_interpolation_type** **(** :ref:`int` idx, :ref:`InterpolationType` interpolation **)** Set the interpolation type of a given track, from the INTERPOLATION\_\* enum. - .. _class_Animation_track_set_key_transition: +.. _class_Animation_track_set_key_transition: - void **track_set_key_transition** **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** Set the transition curve (easing) for a specific key (see built-in math function "ease"). - .. _class_Animation_track_set_key_value: +.. _class_Animation_track_set_key_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: +.. _class_Animation_track_set_path: - void **track_set_path** **(** :ref:`int` idx, :ref:`NodePath` path **)** @@ -494,35 +495,35 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus **Example:** "character/skeleton:ankle" or "character/mesh:transform/local". - .. _class_Animation_track_swap: +.. _class_Animation_track_swap: - void **track_swap** **(** :ref:`int` idx, :ref:`int` with_idx **)** - .. _class_Animation_transform_track_insert_key: +.. _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 **)** Insert a transform key for a transform track. - .. _class_Animation_transform_track_interpolate: +.. _class_Animation_transform_track_interpolate: - :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`). - .. _class_Animation_value_track_get_key_indices: +.. _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 Return all the key indices of a value track, given a position and delta time. - .. _class_Animation_value_track_get_update_mode: +.. _class_Animation_value_track_get_update_mode: - :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: +.. _class_Animation_value_track_set_update_mode: - void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`UpdateMode` mode **)** diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 694fba07f..364c8c34b 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -61,18 +61,18 @@ Methods Signals ------- - .. _class_AnimationNode_removed_from_graph: +.. _class_AnimationNode_removed_from_graph: - **removed_from_graph** **(** **)** - .. _class_AnimationNode_tree_changed: +.. _class_AnimationNode_tree_changed: - **tree_changed** **(** **)** Enumerations ------------ - .. _enum_AnimationNode_FilterAction: +.. _enum_AnimationNode_FilterAction: enum **FilterAction**: @@ -84,7 +84,7 @@ enum **FilterAction**: Property Descriptions --------------------- - .. _class_AnimationNode_filter_enabled: +.. _class_AnimationNode_filter_enabled: - :ref:`bool` **filter_enabled** @@ -97,59 +97,59 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNode_add_input: +.. _class_AnimationNode_add_input: - void **add_input** **(** :ref:`String` name **)** - .. _class_AnimationNode_blend_animation: +.. _class_AnimationNode_blend_animation: - void **blend_animation** **(** :ref:`String` animation, :ref:`float` time, :ref:`float` delta, :ref:`bool` seeked, :ref:`float` blend **)** - .. _class_AnimationNode_blend_input: +.. _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 **)** - .. _class_AnimationNode_blend_node: +.. _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 **)** - .. _class_AnimationNode_get_caption: +.. _class_AnimationNode_get_caption: - :ref:`String` **get_caption** **(** **)** virtual - .. _class_AnimationNode_get_input_count: +.. _class_AnimationNode_get_input_count: - :ref:`int` **get_input_count** **(** **)** const - .. _class_AnimationNode_get_input_name: +.. _class_AnimationNode_get_input_name: - :ref:`String` **get_input_name** **(** :ref:`int` input **)** - .. _class_AnimationNode_get_parameter: +.. _class_AnimationNode_get_parameter: - :ref:`Variant` **get_parameter** **(** :ref:`String` name **)** const - .. _class_AnimationNode_has_filter: +.. _class_AnimationNode_has_filter: - :ref:`String` **has_filter** **(** **)** virtual - .. _class_AnimationNode_is_path_filtered: +.. _class_AnimationNode_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const - .. _class_AnimationNode_process: +.. _class_AnimationNode_process: - void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual - .. _class_AnimationNode_remove_input: +.. _class_AnimationNode_remove_input: - void **remove_input** **(** :ref:`int` index **)** - .. _class_AnimationNode_set_filter_path: +.. _class_AnimationNode_set_filter_path: - void **set_filter_path** **(** :ref:`NodePath` path, :ref:`bool` enable **)** - .. _class_AnimationNode_set_parameter: +.. _class_AnimationNode_set_parameter: - void **set_parameter** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_animationnodeadd2.rst b/classes/class_animationnodeadd2.rst index 180f98326..b3dc21691 100644 --- a/classes/class_animationnodeadd2.rst +++ b/classes/class_animationnodeadd2.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_AnimationNodeAdd2_sync: +.. _class_AnimationNodeAdd2_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeadd3.rst b/classes/class_animationnodeadd3.rst index 8e000e76b..eaab61192 100644 --- a/classes/class_animationnodeadd3.rst +++ b/classes/class_animationnodeadd3.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_AnimationNodeAdd3_sync: +.. _class_AnimationNodeAdd3_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeanimation.rst b/classes/class_animationnodeanimation.rst index f6efdd493..95b96117e 100644 --- a/classes/class_animationnodeanimation.rst +++ b/classes/class_animationnodeanimation.rst @@ -33,7 +33,7 @@ Methods Property Descriptions --------------------- - .. _class_AnimationNodeAnimation_animation: +.. _class_AnimationNodeAnimation_animation: - :ref:`String` **animation** @@ -46,7 +46,7 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNodeAnimation_get_playback_time: +.. _class_AnimationNodeAnimation_get_playback_time: - :ref:`float` **get_playback_time** **(** **)** const diff --git a/classes/class_animationnodeblend2.rst b/classes/class_animationnodeblend2.rst index 98302aa4d..dfe6f90ec 100644 --- a/classes/class_animationnodeblend2.rst +++ b/classes/class_animationnodeblend2.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_AnimationNodeBlend2_sync: +.. _class_AnimationNodeBlend2_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeblend3.rst b/classes/class_animationnodeblend3.rst index 5c171280e..46be973d5 100644 --- a/classes/class_animationnodeblend3.rst +++ b/classes/class_animationnodeblend3.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_AnimationNodeBlend3_sync: +.. _class_AnimationNodeBlend3_sync: - :ref:`bool` **sync** diff --git a/classes/class_animationnodeblendspace1d.rst b/classes/class_animationnodeblendspace1d.rst index 5346c6aa5..a50ad2620 100644 --- a/classes/class_animationnodeblendspace1d.rst +++ b/classes/class_animationnodeblendspace1d.rst @@ -51,7 +51,7 @@ Methods Property Descriptions --------------------- - .. _class_AnimationNodeBlendSpace1D_max_space: +.. _class_AnimationNodeBlendSpace1D_max_space: - :ref:`float` **max_space** @@ -61,7 +61,7 @@ Property Descriptions | *Getter* | get_max_space() | +----------+----------------------+ - .. _class_AnimationNodeBlendSpace1D_min_space: +.. _class_AnimationNodeBlendSpace1D_min_space: - :ref:`float` **min_space** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | get_min_space() | +----------+----------------------+ - .. _class_AnimationNodeBlendSpace1D_snap: +.. _class_AnimationNodeBlendSpace1D_snap: - :ref:`float` **snap** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_snap() | +----------+-----------------+ - .. _class_AnimationNodeBlendSpace1D_value_label: +.. _class_AnimationNodeBlendSpace1D_value_label: - :ref:`String` **value_label** @@ -94,31 +94,31 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNodeBlendSpace1D_add_blend_point: +.. _class_AnimationNodeBlendSpace1D_add_blend_point: - void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`float` pos, :ref:`int` at_index=-1 **)** - .. _class_AnimationNodeBlendSpace1D_get_blend_point_count: +.. _class_AnimationNodeBlendSpace1D_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const - .. _class_AnimationNodeBlendSpace1D_get_blend_point_node: +.. _class_AnimationNodeBlendSpace1D_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const - .. _class_AnimationNodeBlendSpace1D_get_blend_point_position: +.. _class_AnimationNodeBlendSpace1D_get_blend_point_position: - :ref:`float` **get_blend_point_position** **(** :ref:`int` point **)** const - .. _class_AnimationNodeBlendSpace1D_remove_blend_point: +.. _class_AnimationNodeBlendSpace1D_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** - .. _class_AnimationNodeBlendSpace1D_set_blend_point_node: +.. _class_AnimationNodeBlendSpace1D_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** - .. _class_AnimationNodeBlendSpace1D_set_blend_point_position: +.. _class_AnimationNodeBlendSpace1D_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`float` pos **)** diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 0a7406c89..3f8d7c6e0 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -63,7 +63,7 @@ Methods Property Descriptions --------------------- - .. _class_AnimationNodeBlendSpace2D_auto_triangles: +.. _class_AnimationNodeBlendSpace2D_auto_triangles: - :ref:`bool` **auto_triangles** @@ -73,7 +73,7 @@ Property Descriptions | *Getter* | get_auto_triangles() | +----------+---------------------------+ - .. _class_AnimationNodeBlendSpace2D_max_space: +.. _class_AnimationNodeBlendSpace2D_max_space: - :ref:`Vector2` **max_space** @@ -83,7 +83,7 @@ Property Descriptions | *Getter* | get_max_space() | +----------+----------------------+ - .. _class_AnimationNodeBlendSpace2D_min_space: +.. _class_AnimationNodeBlendSpace2D_min_space: - :ref:`Vector2` **min_space** @@ -93,7 +93,7 @@ Property Descriptions | *Getter* | get_min_space() | +----------+----------------------+ - .. _class_AnimationNodeBlendSpace2D_snap: +.. _class_AnimationNodeBlendSpace2D_snap: - :ref:`Vector2` **snap** @@ -103,7 +103,7 @@ Property Descriptions | *Getter* | get_snap() | +----------+-----------------+ - .. _class_AnimationNodeBlendSpace2D_x_label: +.. _class_AnimationNodeBlendSpace2D_x_label: - :ref:`String` **x_label** @@ -113,7 +113,7 @@ Property Descriptions | *Getter* | get_x_label() | +----------+--------------------+ - .. _class_AnimationNodeBlendSpace2D_y_label: +.. _class_AnimationNodeBlendSpace2D_y_label: - :ref:`String` **y_label** @@ -126,47 +126,47 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNodeBlendSpace2D_add_blend_point: +.. _class_AnimationNodeBlendSpace2D_add_blend_point: - void **add_blend_point** **(** :ref:`AnimationRootNode` node, :ref:`Vector2` pos, :ref:`int` at_index=-1 **)** - .. _class_AnimationNodeBlendSpace2D_add_triangle: +.. _class_AnimationNodeBlendSpace2D_add_triangle: - void **add_triangle** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` at_index=-1 **)** - .. _class_AnimationNodeBlendSpace2D_get_blend_point_count: +.. _class_AnimationNodeBlendSpace2D_get_blend_point_count: - :ref:`int` **get_blend_point_count** **(** **)** const - .. _class_AnimationNodeBlendSpace2D_get_blend_point_node: +.. _class_AnimationNodeBlendSpace2D_get_blend_point_node: - :ref:`AnimationRootNode` **get_blend_point_node** **(** :ref:`int` point **)** const - .. _class_AnimationNodeBlendSpace2D_get_blend_point_position: +.. _class_AnimationNodeBlendSpace2D_get_blend_point_position: - :ref:`Vector2` **get_blend_point_position** **(** :ref:`int` point **)** const - .. _class_AnimationNodeBlendSpace2D_get_triangle_count: +.. _class_AnimationNodeBlendSpace2D_get_triangle_count: - :ref:`int` **get_triangle_count** **(** **)** const - .. _class_AnimationNodeBlendSpace2D_get_triangle_point: +.. _class_AnimationNodeBlendSpace2D_get_triangle_point: - :ref:`int` **get_triangle_point** **(** :ref:`int` triangle, :ref:`int` point **)** - .. _class_AnimationNodeBlendSpace2D_remove_blend_point: +.. _class_AnimationNodeBlendSpace2D_remove_blend_point: - void **remove_blend_point** **(** :ref:`int` point **)** - .. _class_AnimationNodeBlendSpace2D_remove_triangle: +.. _class_AnimationNodeBlendSpace2D_remove_triangle: - void **remove_triangle** **(** :ref:`int` triangle **)** - .. _class_AnimationNodeBlendSpace2D_set_blend_point_node: +.. _class_AnimationNodeBlendSpace2D_set_blend_point_node: - void **set_blend_point_node** **(** :ref:`int` point, :ref:`AnimationRootNode` node **)** - .. _class_AnimationNodeBlendSpace2D_set_blend_point_position: +.. _class_AnimationNodeBlendSpace2D_set_blend_point_position: - void **set_blend_point_position** **(** :ref:`int` point, :ref:`Vector2` pos **)** diff --git a/classes/class_animationnodeblendtree.rst b/classes/class_animationnodeblendtree.rst index 27605216a..bc4dc4bd8 100644 --- a/classes/class_animationnodeblendtree.rst +++ b/classes/class_animationnodeblendtree.rst @@ -55,10 +55,11 @@ Constants - **CONNECTION_ERROR_NO_OUTPUT** = **3** - **CONNECTION_ERROR_SAME_NODE** = **4** - **CONNECTION_ERROR_CONNECTION_EXISTS** = **5** + Property Descriptions --------------------- - .. _class_AnimationNodeBlendTree_graph_offset: +.. _class_AnimationNodeBlendTree_graph_offset: - :ref:`Vector2` **graph_offset** @@ -71,39 +72,39 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNodeBlendTree_add_node: +.. _class_AnimationNodeBlendTree_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** - .. _class_AnimationNodeBlendTree_connect_node: +.. _class_AnimationNodeBlendTree_connect_node: - void **connect_node** **(** :ref:`String` input_node, :ref:`int` input_index, :ref:`String` output_node **)** - .. _class_AnimationNodeBlendTree_disconnect_node: +.. _class_AnimationNodeBlendTree_disconnect_node: - void **disconnect_node** **(** :ref:`String` input_node, :ref:`int` input_index **)** - .. _class_AnimationNodeBlendTree_get_node: +.. _class_AnimationNodeBlendTree_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const - .. _class_AnimationNodeBlendTree_get_node_position: +.. _class_AnimationNodeBlendTree_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const - .. _class_AnimationNodeBlendTree_has_node: +.. _class_AnimationNodeBlendTree_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const - .. _class_AnimationNodeBlendTree_remove_node: +.. _class_AnimationNodeBlendTree_remove_node: - void **remove_node** **(** :ref:`String` name **)** - .. _class_AnimationNodeBlendTree_rename_node: +.. _class_AnimationNodeBlendTree_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** - .. _class_AnimationNodeBlendTree_set_node_position: +.. _class_AnimationNodeBlendTree_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index e082258fd..20d5bef10 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -45,7 +45,7 @@ Methods Enumerations ------------ - .. _enum_AnimationNodeOneShot_MixMode: +.. _enum_AnimationNodeOneShot_MixMode: enum **MixMode**: @@ -55,7 +55,7 @@ enum **MixMode**: Property Descriptions --------------------- - .. _class_AnimationNodeOneShot_autorestart: +.. _class_AnimationNodeOneShot_autorestart: - :ref:`bool` **autorestart** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | has_autorestart() | +----------+------------------------+ - .. _class_AnimationNodeOneShot_autorestart_delay: +.. _class_AnimationNodeOneShot_autorestart_delay: - :ref:`float` **autorestart_delay** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_autorestart_delay() | +----------+------------------------------+ - .. _class_AnimationNodeOneShot_autorestart_random_delay: +.. _class_AnimationNodeOneShot_autorestart_random_delay: - :ref:`float` **autorestart_random_delay** @@ -85,7 +85,7 @@ Property Descriptions | *Getter* | get_autorestart_random_delay() | +----------+-------------------------------------+ - .. _class_AnimationNodeOneShot_fadein_time: +.. _class_AnimationNodeOneShot_fadein_time: - :ref:`float` **fadein_time** @@ -95,7 +95,7 @@ Property Descriptions | *Getter* | get_fadein_time() | +----------+------------------------+ - .. _class_AnimationNodeOneShot_fadeout_time: +.. _class_AnimationNodeOneShot_fadeout_time: - :ref:`float` **fadeout_time** @@ -105,7 +105,7 @@ Property Descriptions | *Getter* | get_fadeout_time() | +----------+-------------------------+ - .. _class_AnimationNodeOneShot_sync: +.. _class_AnimationNodeOneShot_sync: - :ref:`bool` **sync** @@ -118,11 +118,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationNodeOneShot_get_mix_mode: +.. _class_AnimationNodeOneShot_get_mix_mode: - :ref:`MixMode` **get_mix_mode** **(** **)** const - .. _class_AnimationNodeOneShot_set_mix_mode: +.. _class_AnimationNodeOneShot_set_mix_mode: - void **set_mix_mode** **(** :ref:`MixMode` mode **)** diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 84464ba99..7e74b5099 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -68,91 +68,91 @@ Methods Method Descriptions ------------------- - .. _class_AnimationNodeStateMachine_add_node: +.. _class_AnimationNodeStateMachine_add_node: - void **add_node** **(** :ref:`String` name, :ref:`AnimationNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** - .. _class_AnimationNodeStateMachine_add_transition: +.. _class_AnimationNodeStateMachine_add_transition: - void **add_transition** **(** :ref:`String` from, :ref:`String` to, :ref:`AnimationNodeStateMachineTransition` transition **)** - .. _class_AnimationNodeStateMachine_get_end_node: +.. _class_AnimationNodeStateMachine_get_end_node: - :ref:`String` **get_end_node** **(** **)** const - .. _class_AnimationNodeStateMachine_get_graph_offset: +.. _class_AnimationNodeStateMachine_get_graph_offset: - :ref:`Vector2` **get_graph_offset** **(** **)** const - .. _class_AnimationNodeStateMachine_get_node: +.. _class_AnimationNodeStateMachine_get_node: - :ref:`AnimationNode` **get_node** **(** :ref:`String` name **)** const - .. _class_AnimationNodeStateMachine_get_node_name: +.. _class_AnimationNodeStateMachine_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`AnimationNode` node **)** const - .. _class_AnimationNodeStateMachine_get_node_position: +.. _class_AnimationNodeStateMachine_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`String` name **)** const - .. _class_AnimationNodeStateMachine_get_start_node: +.. _class_AnimationNodeStateMachine_get_start_node: - :ref:`String` **get_start_node** **(** **)** const - .. _class_AnimationNodeStateMachine_get_transition: +.. _class_AnimationNodeStateMachine_get_transition: - :ref:`AnimationNodeStateMachineTransition` **get_transition** **(** :ref:`int` idx **)** const - .. _class_AnimationNodeStateMachine_get_transition_count: +.. _class_AnimationNodeStateMachine_get_transition_count: - :ref:`int` **get_transition_count** **(** **)** const - .. _class_AnimationNodeStateMachine_get_transition_from: +.. _class_AnimationNodeStateMachine_get_transition_from: - :ref:`String` **get_transition_from** **(** :ref:`int` idx **)** const - .. _class_AnimationNodeStateMachine_get_transition_to: +.. _class_AnimationNodeStateMachine_get_transition_to: - :ref:`String` **get_transition_to** **(** :ref:`int` idx **)** const - .. _class_AnimationNodeStateMachine_has_node: +.. _class_AnimationNodeStateMachine_has_node: - :ref:`bool` **has_node** **(** :ref:`String` name **)** const - .. _class_AnimationNodeStateMachine_has_transition: +.. _class_AnimationNodeStateMachine_has_transition: - :ref:`bool` **has_transition** **(** :ref:`String` from, :ref:`String` to **)** const - .. _class_AnimationNodeStateMachine_remove_node: +.. _class_AnimationNodeStateMachine_remove_node: - void **remove_node** **(** :ref:`String` name **)** - .. _class_AnimationNodeStateMachine_remove_transition: +.. _class_AnimationNodeStateMachine_remove_transition: - void **remove_transition** **(** :ref:`String` from, :ref:`String` to **)** - .. _class_AnimationNodeStateMachine_remove_transition_by_index: +.. _class_AnimationNodeStateMachine_remove_transition_by_index: - void **remove_transition_by_index** **(** :ref:`int` idx **)** - .. _class_AnimationNodeStateMachine_rename_node: +.. _class_AnimationNodeStateMachine_rename_node: - void **rename_node** **(** :ref:`String` name, :ref:`String` new_name **)** - .. _class_AnimationNodeStateMachine_set_end_node: +.. _class_AnimationNodeStateMachine_set_end_node: - void **set_end_node** **(** :ref:`String` name **)** - .. _class_AnimationNodeStateMachine_set_graph_offset: +.. _class_AnimationNodeStateMachine_set_graph_offset: - void **set_graph_offset** **(** :ref:`Vector2` name **)** - .. _class_AnimationNodeStateMachine_set_node_position: +.. _class_AnimationNodeStateMachine_set_node_position: - void **set_node_position** **(** :ref:`String` name, :ref:`Vector2` position **)** - .. _class_AnimationNodeStateMachine_set_start_node: +.. _class_AnimationNodeStateMachine_set_start_node: - void **set_start_node** **(** :ref:`String` name **)** diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index e10f434dc..95ac358b9 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -36,27 +36,27 @@ Methods Method Descriptions ------------------- - .. _class_AnimationNodeStateMachinePlayback_get_current_node: +.. _class_AnimationNodeStateMachinePlayback_get_current_node: - :ref:`String` **get_current_node** **(** **)** const - .. _class_AnimationNodeStateMachinePlayback_get_travel_path: +.. _class_AnimationNodeStateMachinePlayback_get_travel_path: - :ref:`PoolStringArray` **get_travel_path** **(** **)** const - .. _class_AnimationNodeStateMachinePlayback_is_playing: +.. _class_AnimationNodeStateMachinePlayback_is_playing: - :ref:`bool` **is_playing** **(** **)** const - .. _class_AnimationNodeStateMachinePlayback_start: +.. _class_AnimationNodeStateMachinePlayback_start: - void **start** **(** :ref:`String` node **)** - .. _class_AnimationNodeStateMachinePlayback_stop: +.. _class_AnimationNodeStateMachinePlayback_stop: - void **stop** **(** **)** - .. _class_AnimationNodeStateMachinePlayback_travel: +.. _class_AnimationNodeStateMachinePlayback_travel: - void **travel** **(** :ref:`String` to_node **)** diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 886ea5305..38d4abd6b 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -36,14 +36,14 @@ Properties Signals ------- - .. _class_AnimationNodeStateMachineTransition_advance_condition_changed: +.. _class_AnimationNodeStateMachineTransition_advance_condition_changed: - **advance_condition_changed** **(** **)** Enumerations ------------ - .. _enum_AnimationNodeStateMachineTransition_SwitchMode: +.. _enum_AnimationNodeStateMachineTransition_SwitchMode: enum **SwitchMode**: @@ -54,7 +54,7 @@ enum **SwitchMode**: Property Descriptions --------------------- - .. _class_AnimationNodeStateMachineTransition_advance_condition: +.. _class_AnimationNodeStateMachineTransition_advance_condition: - :ref:`String` **advance_condition** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_advance_condition() | +----------+------------------------------+ - .. _class_AnimationNodeStateMachineTransition_auto_advance: +.. _class_AnimationNodeStateMachineTransition_auto_advance: - :ref:`bool` **auto_advance** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | has_auto_advance() | +----------+-------------------------+ - .. _class_AnimationNodeStateMachineTransition_disabled: +.. _class_AnimationNodeStateMachineTransition_disabled: - :ref:`bool` **disabled** @@ -84,7 +84,7 @@ Property Descriptions | *Getter* | is_disabled() | +----------+---------------------+ - .. _class_AnimationNodeStateMachineTransition_priority: +.. _class_AnimationNodeStateMachineTransition_priority: - :ref:`int` **priority** @@ -94,7 +94,7 @@ Property Descriptions | *Getter* | get_priority() | +----------+---------------------+ - .. _class_AnimationNodeStateMachineTransition_switch_mode: +.. _class_AnimationNodeStateMachineTransition_switch_mode: - :ref:`SwitchMode` **switch_mode** @@ -104,7 +104,7 @@ Property Descriptions | *Getter* | get_switch_mode() | +----------+------------------------+ - .. _class_AnimationNodeStateMachineTransition_xfade_time: +.. _class_AnimationNodeStateMachineTransition_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index e1e7dbd0e..b1fd5752a 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -156,7 +156,7 @@ Properties Property Descriptions --------------------- - .. _class_AnimationNodeTransition_input_0/auto_advance: +.. _class_AnimationNodeTransition_input_0/auto_advance: - :ref:`bool` **input_0/auto_advance** @@ -166,7 +166,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_0/name: +.. _class_AnimationNodeTransition_input_0/name: - :ref:`String` **input_0/name** @@ -176,7 +176,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_1/auto_advance: +.. _class_AnimationNodeTransition_input_1/auto_advance: - :ref:`bool` **input_1/auto_advance** @@ -186,7 +186,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_1/name: +.. _class_AnimationNodeTransition_input_1/name: - :ref:`String` **input_1/name** @@ -196,7 +196,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_10/auto_advance: +.. _class_AnimationNodeTransition_input_10/auto_advance: - :ref:`bool` **input_10/auto_advance** @@ -206,7 +206,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_10/name: +.. _class_AnimationNodeTransition_input_10/name: - :ref:`String` **input_10/name** @@ -216,7 +216,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_11/auto_advance: +.. _class_AnimationNodeTransition_input_11/auto_advance: - :ref:`bool` **input_11/auto_advance** @@ -226,7 +226,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_11/name: +.. _class_AnimationNodeTransition_input_11/name: - :ref:`String` **input_11/name** @@ -236,7 +236,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_12/auto_advance: +.. _class_AnimationNodeTransition_input_12/auto_advance: - :ref:`bool` **input_12/auto_advance** @@ -246,7 +246,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_12/name: +.. _class_AnimationNodeTransition_input_12/name: - :ref:`String` **input_12/name** @@ -256,7 +256,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_13/auto_advance: +.. _class_AnimationNodeTransition_input_13/auto_advance: - :ref:`bool` **input_13/auto_advance** @@ -266,7 +266,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_13/name: +.. _class_AnimationNodeTransition_input_13/name: - :ref:`String` **input_13/name** @@ -276,7 +276,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_14/auto_advance: +.. _class_AnimationNodeTransition_input_14/auto_advance: - :ref:`bool` **input_14/auto_advance** @@ -286,7 +286,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_14/name: +.. _class_AnimationNodeTransition_input_14/name: - :ref:`String` **input_14/name** @@ -296,7 +296,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_15/auto_advance: +.. _class_AnimationNodeTransition_input_15/auto_advance: - :ref:`bool` **input_15/auto_advance** @@ -306,7 +306,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_15/name: +.. _class_AnimationNodeTransition_input_15/name: - :ref:`String` **input_15/name** @@ -316,7 +316,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_16/auto_advance: +.. _class_AnimationNodeTransition_input_16/auto_advance: - :ref:`bool` **input_16/auto_advance** @@ -326,7 +326,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_16/name: +.. _class_AnimationNodeTransition_input_16/name: - :ref:`String` **input_16/name** @@ -336,7 +336,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_17/auto_advance: +.. _class_AnimationNodeTransition_input_17/auto_advance: - :ref:`bool` **input_17/auto_advance** @@ -346,7 +346,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_17/name: +.. _class_AnimationNodeTransition_input_17/name: - :ref:`String` **input_17/name** @@ -356,7 +356,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_18/auto_advance: +.. _class_AnimationNodeTransition_input_18/auto_advance: - :ref:`bool` **input_18/auto_advance** @@ -366,7 +366,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_18/name: +.. _class_AnimationNodeTransition_input_18/name: - :ref:`String` **input_18/name** @@ -376,7 +376,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_19/auto_advance: +.. _class_AnimationNodeTransition_input_19/auto_advance: - :ref:`bool` **input_19/auto_advance** @@ -386,7 +386,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_19/name: +.. _class_AnimationNodeTransition_input_19/name: - :ref:`String` **input_19/name** @@ -396,7 +396,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_2/auto_advance: +.. _class_AnimationNodeTransition_input_2/auto_advance: - :ref:`bool` **input_2/auto_advance** @@ -406,7 +406,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_2/name: +.. _class_AnimationNodeTransition_input_2/name: - :ref:`String` **input_2/name** @@ -416,7 +416,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_20/auto_advance: +.. _class_AnimationNodeTransition_input_20/auto_advance: - :ref:`bool` **input_20/auto_advance** @@ -426,7 +426,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_20/name: +.. _class_AnimationNodeTransition_input_20/name: - :ref:`String` **input_20/name** @@ -436,7 +436,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_21/auto_advance: +.. _class_AnimationNodeTransition_input_21/auto_advance: - :ref:`bool` **input_21/auto_advance** @@ -446,7 +446,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_21/name: +.. _class_AnimationNodeTransition_input_21/name: - :ref:`String` **input_21/name** @@ -456,7 +456,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_22/auto_advance: +.. _class_AnimationNodeTransition_input_22/auto_advance: - :ref:`bool` **input_22/auto_advance** @@ -466,7 +466,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_22/name: +.. _class_AnimationNodeTransition_input_22/name: - :ref:`String` **input_22/name** @@ -476,7 +476,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_23/auto_advance: +.. _class_AnimationNodeTransition_input_23/auto_advance: - :ref:`bool` **input_23/auto_advance** @@ -486,7 +486,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_23/name: +.. _class_AnimationNodeTransition_input_23/name: - :ref:`String` **input_23/name** @@ -496,7 +496,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_24/auto_advance: +.. _class_AnimationNodeTransition_input_24/auto_advance: - :ref:`bool` **input_24/auto_advance** @@ -506,7 +506,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_24/name: +.. _class_AnimationNodeTransition_input_24/name: - :ref:`String` **input_24/name** @@ -516,7 +516,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_25/auto_advance: +.. _class_AnimationNodeTransition_input_25/auto_advance: - :ref:`bool` **input_25/auto_advance** @@ -526,7 +526,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_25/name: +.. _class_AnimationNodeTransition_input_25/name: - :ref:`String` **input_25/name** @@ -536,7 +536,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_26/auto_advance: +.. _class_AnimationNodeTransition_input_26/auto_advance: - :ref:`bool` **input_26/auto_advance** @@ -546,7 +546,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_26/name: +.. _class_AnimationNodeTransition_input_26/name: - :ref:`String` **input_26/name** @@ -556,7 +556,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_27/auto_advance: +.. _class_AnimationNodeTransition_input_27/auto_advance: - :ref:`bool` **input_27/auto_advance** @@ -566,7 +566,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_27/name: +.. _class_AnimationNodeTransition_input_27/name: - :ref:`String` **input_27/name** @@ -576,7 +576,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_28/auto_advance: +.. _class_AnimationNodeTransition_input_28/auto_advance: - :ref:`bool` **input_28/auto_advance** @@ -586,7 +586,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_28/name: +.. _class_AnimationNodeTransition_input_28/name: - :ref:`String` **input_28/name** @@ -596,7 +596,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_29/auto_advance: +.. _class_AnimationNodeTransition_input_29/auto_advance: - :ref:`bool` **input_29/auto_advance** @@ -606,7 +606,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_29/name: +.. _class_AnimationNodeTransition_input_29/name: - :ref:`String` **input_29/name** @@ -616,7 +616,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_3/auto_advance: +.. _class_AnimationNodeTransition_input_3/auto_advance: - :ref:`bool` **input_3/auto_advance** @@ -626,7 +626,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_3/name: +.. _class_AnimationNodeTransition_input_3/name: - :ref:`String` **input_3/name** @@ -636,7 +636,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_30/auto_advance: +.. _class_AnimationNodeTransition_input_30/auto_advance: - :ref:`bool` **input_30/auto_advance** @@ -646,7 +646,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_30/name: +.. _class_AnimationNodeTransition_input_30/name: - :ref:`String` **input_30/name** @@ -656,7 +656,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_31/auto_advance: +.. _class_AnimationNodeTransition_input_31/auto_advance: - :ref:`bool` **input_31/auto_advance** @@ -666,7 +666,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_31/name: +.. _class_AnimationNodeTransition_input_31/name: - :ref:`String` **input_31/name** @@ -676,7 +676,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_4/auto_advance: +.. _class_AnimationNodeTransition_input_4/auto_advance: - :ref:`bool` **input_4/auto_advance** @@ -686,7 +686,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_4/name: +.. _class_AnimationNodeTransition_input_4/name: - :ref:`String` **input_4/name** @@ -696,7 +696,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_5/auto_advance: +.. _class_AnimationNodeTransition_input_5/auto_advance: - :ref:`bool` **input_5/auto_advance** @@ -706,7 +706,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_5/name: +.. _class_AnimationNodeTransition_input_5/name: - :ref:`String` **input_5/name** @@ -716,7 +716,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_6/auto_advance: +.. _class_AnimationNodeTransition_input_6/auto_advance: - :ref:`bool` **input_6/auto_advance** @@ -726,7 +726,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_6/name: +.. _class_AnimationNodeTransition_input_6/name: - :ref:`String` **input_6/name** @@ -736,7 +736,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_7/auto_advance: +.. _class_AnimationNodeTransition_input_7/auto_advance: - :ref:`bool` **input_7/auto_advance** @@ -746,7 +746,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_7/name: +.. _class_AnimationNodeTransition_input_7/name: - :ref:`String` **input_7/name** @@ -756,7 +756,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_8/auto_advance: +.. _class_AnimationNodeTransition_input_8/auto_advance: - :ref:`bool` **input_8/auto_advance** @@ -766,7 +766,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_8/name: +.. _class_AnimationNodeTransition_input_8/name: - :ref:`String` **input_8/name** @@ -776,7 +776,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_9/auto_advance: +.. _class_AnimationNodeTransition_input_9/auto_advance: - :ref:`bool` **input_9/auto_advance** @@ -786,7 +786,7 @@ Property Descriptions | *Getter* | is_input_set_as_auto_advance() | +----------+----------------------------------+ - .. _class_AnimationNodeTransition_input_9/name: +.. _class_AnimationNodeTransition_input_9/name: - :ref:`String` **input_9/name** @@ -796,7 +796,7 @@ Property Descriptions | *Getter* | get_input_caption() | +----------+--------------------------+ - .. _class_AnimationNodeTransition_input_count: +.. _class_AnimationNodeTransition_input_count: - :ref:`int` **input_count** @@ -806,7 +806,7 @@ Property Descriptions | *Getter* | get_enabled_inputs() | +----------+---------------------------+ - .. _class_AnimationNodeTransition_xfade_time: +.. _class_AnimationNodeTransition_xfade_time: - :ref:`float` **xfade_time** diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index ee1e103ba..900e58faa 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -91,32 +91,32 @@ Methods Signals ------- - .. _class_AnimationPlayer_animation_changed: +.. _class_AnimationPlayer_animation_changed: - **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: +.. _class_AnimationPlayer_animation_finished: - **animation_finished** **(** :ref:`String` anim_name **)** Notifies when an animation finished playing. - .. _class_AnimationPlayer_animation_started: +.. _class_AnimationPlayer_animation_started: - **animation_started** **(** :ref:`String` anim_name **)** Notifies when an animation starts playing. - .. _class_AnimationPlayer_caches_cleared: +.. _class_AnimationPlayer_caches_cleared: - **caches_cleared** **(** **)** Enumerations ------------ - .. _enum_AnimationPlayer_AnimationProcessMode: +.. _enum_AnimationPlayer_AnimationProcessMode: enum **AnimationProcessMode**: @@ -133,11 +133,13 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/animations` + - :doc:`../tutorials/animation/index` + Property Descriptions --------------------- - .. _class_AnimationPlayer_assigned_animation: +.. _class_AnimationPlayer_assigned_animation: - :ref:`String` **assigned_animation** @@ -149,7 +151,7 @@ Property Descriptions 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: +.. _class_AnimationPlayer_autoplay: - :ref:`String` **autoplay** @@ -161,7 +163,7 @@ If playing, the current animation; otherwise, the animation last played. When se The name of the animation to play when the scene loads. Default value: ``""``. - .. _class_AnimationPlayer_current_animation: +.. _class_AnimationPlayer_current_animation: - :ref:`String` **current_animation** @@ -173,7 +175,7 @@ The name of the animation to play when the scene loads. Default value: ``""``. 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: +.. _class_AnimationPlayer_current_animation_length: - :ref:`float` **current_animation_length** @@ -183,7 +185,7 @@ The name of the current animation, "" if not playing anything. When being set, d The length (in seconds) of the currently being played animation. - .. _class_AnimationPlayer_current_animation_position: +.. _class_AnimationPlayer_current_animation_position: - :ref:`float` **current_animation_position** @@ -193,7 +195,7 @@ The length (in seconds) of the currently being played animation. The position (in seconds) of the currently playing animation. - .. _class_AnimationPlayer_playback_active: +.. _class_AnimationPlayer_playback_active: - :ref:`bool` **playback_active** @@ -205,7 +207,7 @@ The position (in seconds) of the currently playing animation. If ``true``, updates animations in response to process-related notifications. Default value: ``true``. - .. _class_AnimationPlayer_playback_default_blend_time: +.. _class_AnimationPlayer_playback_default_blend_time: - :ref:`float` **playback_default_blend_time** @@ -217,7 +219,7 @@ If ``true``, updates animations in response to process-related notifications. De The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``. - .. _class_AnimationPlayer_playback_process_mode: +.. _class_AnimationPlayer_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -229,7 +231,7 @@ The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 p The process notification in which to update animations. Default value: :ref:`ANIMATION_PROCESS_IDLE`. - .. _class_AnimationPlayer_playback_speed: +.. _class_AnimationPlayer_playback_speed: - :ref:`float` **playback_speed** @@ -241,7 +243,7 @@ The process notification in which to update animations. Default value: :ref:`ANI The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: ``1``. - .. _class_AnimationPlayer_root_node: +.. _class_AnimationPlayer_root_node: - :ref:`NodePath` **root_node** @@ -256,127 +258,127 @@ The node from which node path references will travel. Default value: ``".."``. Method Descriptions ------------------- - .. _class_AnimationPlayer_add_animation: +.. _class_AnimationPlayer_add_animation: - :ref:`Error` **add_animation** **(** :ref:`String` name, :ref:`Animation` animation **)** Adds ``animation`` to the player accessible with the key ``name``. - .. _class_AnimationPlayer_advance: +.. _class_AnimationPlayer_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. - .. _class_AnimationPlayer_animation_get_next: +.. _class_AnimationPlayer_animation_get_next: - :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: +.. _class_AnimationPlayer_animation_set_next: - void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** Triggers the ``anim_to`` animation when the ``anim_from`` animation completes. - .. _class_AnimationPlayer_clear_caches: +.. _class_AnimationPlayer_clear_caches: - void **clear_caches** **(** **)** ``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again. - .. _class_AnimationPlayer_clear_queue: +.. _class_AnimationPlayer_clear_queue: - void **clear_queue** **(** **)** Clears all queued, unplayed animations. - .. _class_AnimationPlayer_find_animation: +.. _class_AnimationPlayer_find_animation: - :ref:`String` **find_animation** **(** :ref:`Animation` animation **)** const Returns the name of ``animation`` or empty string if not found. - .. _class_AnimationPlayer_get_animation: +.. _class_AnimationPlayer_get_animation: - :ref:`Animation` **get_animation** **(** :ref:`String` name **)** const Returns the :ref:`Animation` with key ``name`` or ``null`` if not found. - .. _class_AnimationPlayer_get_animation_list: +.. _class_AnimationPlayer_get_animation_list: - :ref:`PoolStringArray` **get_animation_list** **(** **)** const Returns the list of stored animation names. - .. _class_AnimationPlayer_get_blend_time: +.. _class_AnimationPlayer_get_blend_time: - :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. - .. _class_AnimationPlayer_get_playing_speed: +.. _class_AnimationPlayer_get_playing_speed: - :ref:`float` **get_playing_speed** **(** **)** const Get the actual playing speed of current animation or 0 if not playing. This speed is the ``playback_speed`` property multiplied by ``custom_speed`` argument specified when calling the ``play`` method. - .. _class_AnimationPlayer_has_animation: +.. _class_AnimationPlayer_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` name **)** const Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation` with key ``name``. - .. _class_AnimationPlayer_is_playing: +.. _class_AnimationPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if playing an animation. - .. _class_AnimationPlayer_play: +.. _class_AnimationPlayer_play: - 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: +.. _class_AnimationPlayer_play_backwards: - void **play_backwards** **(** :ref:`String` name="", :ref:`float` custom_blend=-1 **)** Play the animation with key ``name`` in reverse. - .. _class_AnimationPlayer_queue: +.. _class_AnimationPlayer_queue: - void **queue** **(** :ref:`String` name **)** Queue an animation for playback once the current one is done. - .. _class_AnimationPlayer_remove_animation: +.. _class_AnimationPlayer_remove_animation: - void **remove_animation** **(** :ref:`String` name **)** Remove the animation with key ``name``. - .. _class_AnimationPlayer_rename_animation: +.. _class_AnimationPlayer_rename_animation: - void **rename_animation** **(** :ref:`String` name, :ref:`String` newname **)** Rename an existing animation with key ``name`` to ``newname``. - .. _class_AnimationPlayer_seek: +.. _class_AnimationPlayer_seek: - void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. - .. _class_AnimationPlayer_set_blend_time: +.. _class_AnimationPlayer_set_blend_time: - 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. - .. _class_AnimationPlayer_stop: +.. _class_AnimationPlayer_stop: - void **stop** **(** :ref:`bool` reset=true **)** diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 74fdc6a72..0878165d3 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -45,7 +45,7 @@ Methods Enumerations ------------ - .. _enum_AnimationTree_AnimationProcessMode: +.. _enum_AnimationTree_AnimationProcessMode: enum **AnimationProcessMode**: @@ -56,7 +56,7 @@ enum **AnimationProcessMode**: Property Descriptions --------------------- - .. _class_AnimationTree_active: +.. _class_AnimationTree_active: - :ref:`bool` **active** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | is_active() | +----------+-------------------+ - .. _class_AnimationTree_anim_player: +.. _class_AnimationTree_anim_player: - :ref:`NodePath` **anim_player** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | get_animation_player() | +----------+-----------------------------+ - .. _class_AnimationTree_process_mode: +.. _class_AnimationTree_process_mode: - :ref:`AnimationProcessMode` **process_mode** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | get_process_mode() | +----------+-------------------------+ - .. _class_AnimationTree_root_motion_track: +.. _class_AnimationTree_root_motion_track: - :ref:`NodePath` **root_motion_track** @@ -96,7 +96,7 @@ Property Descriptions | *Getter* | get_root_motion_track() | +----------+------------------------------+ - .. _class_AnimationTree_tree_root: +.. _class_AnimationTree_tree_root: - :ref:`AnimationNode` **tree_root** @@ -109,15 +109,15 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AnimationTree_advance: +.. _class_AnimationTree_advance: - void **advance** **(** :ref:`float` delta **)** - .. _class_AnimationTree_get_root_motion_transform: +.. _class_AnimationTree_get_root_motion_transform: - :ref:`Transform` **get_root_motion_transform** **(** **)** const - .. _class_AnimationTree_rename_parameter: +.. _class_AnimationTree_rename_parameter: - void **rename_parameter** **(** :ref:`String` old_name, :ref:`String` new_name **)** diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 1d1c8dac8..9ce06e1fc 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -151,14 +151,14 @@ Methods Enumerations ------------ - .. _enum_AnimationTreePlayer_AnimationProcessMode: +.. _enum_AnimationTreePlayer_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. - .. _enum_AnimationTreePlayer_NodeType: +.. _enum_AnimationTreePlayer_NodeType: enum **NodeType**: @@ -183,7 +183,7 @@ It takes :ref:`Animation`\ s from an :ref:`AnimationPlayer` **active** @@ -195,7 +195,7 @@ Property Descriptions If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. - .. _class_AnimationTreePlayer_base_path: +.. _class_AnimationTreePlayer_base_path: - :ref:`NodePath` **base_path** @@ -209,7 +209,7 @@ 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: +.. _class_AnimationTreePlayer_master_player: - :ref:`NodePath` **master_player** @@ -223,7 +223,7 @@ The path to the :ref:`AnimationPlayer` from which this `` Once set, Animation nodes can be added to the AnimationTreePlayer. - .. _class_AnimationTreePlayer_playback_process_mode: +.. _class_AnimationTreePlayer_playback_process_mode: - :ref:`AnimationProcessMode` **playback_process_mode** @@ -238,65 +238,65 @@ The thread in which to update animations. Default value: :ref:`ANIMATION_PROCESS Method Descriptions ------------------- - .. _class_AnimationTreePlayer_add_node: +.. _class_AnimationTreePlayer_add_node: - void **add_node** **(** :ref:`NodeType` type, :ref:`String` id **)** Adds a ``type`` node to the graph with name ``id``. - .. _class_AnimationTreePlayer_advance: +.. _class_AnimationTreePlayer_advance: - void **advance** **(** :ref:`float` delta **)** Shifts position in the animation timeline. Delta is the time in seconds to shift. - .. _class_AnimationTreePlayer_animation_node_get_animation: +.. _class_AnimationTreePlayer_animation_node_get_animation: - :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``. - .. _class_AnimationTreePlayer_animation_node_get_master_animation: +.. _class_AnimationTreePlayer_animation_node_get_master_animation: - :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. - .. _class_AnimationTreePlayer_animation_node_get_position: +.. _class_AnimationTreePlayer_animation_node_get_position: - :ref:`float` **animation_node_get_position** **(** :ref:`String` id **)** const - .. _class_AnimationTreePlayer_animation_node_set_animation: +.. _class_AnimationTreePlayer_animation_node_set_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``. - .. _class_AnimationTreePlayer_animation_node_set_filter_path: +.. _class_AnimationTreePlayer_animation_node_set_filter_path: - 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: +.. _class_AnimationTreePlayer_animation_node_set_master_animation: - 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. - .. _class_AnimationTreePlayer_are_nodes_connected: +.. _class_AnimationTreePlayer_are_nodes_connected: - :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: +.. _class_AnimationTreePlayer_blend2_node_get_amount: - :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: +.. _class_AnimationTreePlayer_blend2_node_set_amount: - void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -310,19 +310,19 @@ Towards 1, the influence of a gets lessened, the influence of b gets raised. At 1, Output is input b. - .. _class_AnimationTreePlayer_blend2_node_set_filter_path: +.. _class_AnimationTreePlayer_blend2_node_set_filter_path: - 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: +.. _class_AnimationTreePlayer_blend3_node_get_amount: - :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: +.. _class_AnimationTreePlayer_blend3_node_set_amount: - void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** @@ -340,13 +340,13 @@ From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised a At 1, Output is input b+. - .. _class_AnimationTreePlayer_blend4_node_get_amount: +.. _class_AnimationTreePlayer_blend4_node_get_amount: - :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: +.. _class_AnimationTreePlayer_blend4_node_set_amount: - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** @@ -356,31 +356,31 @@ A Blend4 Node blends two pairs of animations. The two pairs are blended like blend2 and then added together. - .. _class_AnimationTreePlayer_connect_nodes: +.. _class_AnimationTreePlayer_connect_nodes: - :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: +.. _class_AnimationTreePlayer_disconnect_nodes: - 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: +.. _class_AnimationTreePlayer_get_node_list: - :ref:`PoolStringArray` **get_node_list** **(** **)** Returns a :ref:`PoolStringArray` containing the name of all nodes. - .. _class_AnimationTreePlayer_mix_node_get_amount: +.. _class_AnimationTreePlayer_mix_node_get_amount: - :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: +.. _class_AnimationTreePlayer_mix_node_set_amount: - void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** @@ -388,157 +388,157 @@ Sets mix amount of a Mix node given its name and value. A Mix node adds input b to input a by a the amount given by ratio. - .. _class_AnimationTreePlayer_node_exists: +.. _class_AnimationTreePlayer_node_exists: - :ref:`bool` **node_exists** **(** :ref:`String` node **)** const Check if a node exists (by name). - .. _class_AnimationTreePlayer_node_get_input_count: +.. _class_AnimationTreePlayer_node_get_input_count: - :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: +.. _class_AnimationTreePlayer_node_get_input_source: - :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: +.. _class_AnimationTreePlayer_node_get_position: - :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: +.. _class_AnimationTreePlayer_node_get_type: - :ref:`NodeType` **node_get_type** **(** :ref:`String` id **)** const Get the node type, will return from NODE\_\* enum. - .. _class_AnimationTreePlayer_node_rename: +.. _class_AnimationTreePlayer_node_rename: - :ref:`Error` **node_rename** **(** :ref:`String` node, :ref:`String` new_name **)** Rename a node in the graph. - .. _class_AnimationTreePlayer_node_set_position: +.. _class_AnimationTreePlayer_node_set_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: +.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay: - :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: +.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay: - :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: +.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time: - :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: +.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time: - :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: +.. _class_AnimationTreePlayer_oneshot_node_has_autorestart: - :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: +.. _class_AnimationTreePlayer_oneshot_node_is_active: - :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: +.. _class_AnimationTreePlayer_oneshot_node_set_autorestart: - 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: +.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay: - 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: +.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay: - 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: +.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time: - 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: +.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time: - 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: +.. _class_AnimationTreePlayer_oneshot_node_set_filter_path: - 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: +.. _class_AnimationTreePlayer_oneshot_node_start: - void **oneshot_node_start** **(** :ref:`String` id **)** Starts a OneShot node given its name. - .. _class_AnimationTreePlayer_oneshot_node_stop: +.. _class_AnimationTreePlayer_oneshot_node_stop: - void **oneshot_node_stop** **(** :ref:`String` id **)** Stops the OneShot node with name ``id``. - .. _class_AnimationTreePlayer_recompute_caches: +.. _class_AnimationTreePlayer_recompute_caches: - void **recompute_caches** **(** **)** Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. - .. _class_AnimationTreePlayer_remove_node: +.. _class_AnimationTreePlayer_remove_node: - void **remove_node** **(** :ref:`String` id **)** Removes the animation node with name ``id``. - .. _class_AnimationTreePlayer_reset: +.. _class_AnimationTreePlayer_reset: - void **reset** **(** **)** Resets this ``AnimationTreePlayer``. - .. _class_AnimationTreePlayer_timescale_node_get_scale: +.. _class_AnimationTreePlayer_timescale_node_get_scale: - :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: +.. _class_AnimationTreePlayer_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** @@ -548,7 +548,7 @@ The timescale node is used to speed :ref:`Animation`\ s up if t If applied after a blend or mix, affects all input animations to that blend or mix. - .. _class_AnimationTreePlayer_timeseek_node_seek: +.. _class_AnimationTreePlayer_timeseek_node_seek: - void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** @@ -556,55 +556,55 @@ 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. - .. _class_AnimationTreePlayer_transition_node_delete_input: +.. _class_AnimationTreePlayer_transition_node_delete_input: - 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: +.. _class_AnimationTreePlayer_transition_node_get_current: - :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: +.. _class_AnimationTreePlayer_transition_node_get_input_count: - :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: +.. _class_AnimationTreePlayer_transition_node_get_xfade_time: - :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: +.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance: - :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: +.. _class_AnimationTreePlayer_transition_node_set_current: - 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: +.. _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 **)** 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: +.. _class_AnimationTreePlayer_transition_node_set_input_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: +.. _class_AnimationTreePlayer_transition_node_set_xfade_time: - void **transition_node_set_xfade_time** **(** :ref:`String` id, :ref:`float` time_sec **)** diff --git a/classes/class_area.rst b/classes/class_area.rst index f902b2edd..19b1cf610 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -81,49 +81,49 @@ Methods Signals ------- - .. _class_Area_area_entered: +.. _class_Area_area_entered: - **area_entered** **(** :ref:`Area` area **)** Emitted when another area enters. - .. _class_Area_area_exited: +.. _class_Area_area_exited: - **area_exited** **(** :ref:`Area` area **)** Emitted when another area exits. - .. _class_Area_area_shape_entered: +.. _class_Area_area_shape_entered: - **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: +.. _class_Area_area_shape_exited: - **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: +.. _class_Area_body_entered: - **body_entered** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object enters. - .. _class_Area_body_exited: +.. _class_Area_body_exited: - **body_exited** **(** :ref:`Node` body **)** Emitted when a :ref:`PhysicsBody` object exits. - .. _class_Area_body_shape_entered: +.. _class_Area_body_shape_entered: - **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. - .. _class_Area_body_shape_exited: +.. _class_Area_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -132,7 +132,7 @@ Emitted when a :ref:`PhysicsBody` object exits, reporting whi Enumerations ------------ - .. _enum_Area_SpaceOverride: +.. _enum_Area_SpaceOverride: enum **SpaceOverride**: @@ -150,7 +150,7 @@ Description Property Descriptions --------------------- - .. _class_Area_angular_damp: +.. _class_Area_angular_damp: - :ref:`float` **angular_damp** @@ -162,7 +162,7 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). - .. _class_Area_audio_bus_name: +.. _class_Area_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -174,7 +174,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. - .. _class_Area_audio_bus_override: +.. _class_Area_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -186,7 +186,7 @@ The name of the area's audio bus. If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. - .. _class_Area_collision_layer: +.. _class_Area_collision_layer: - :ref:`int` **collision_layer** @@ -198,7 +198,7 @@ If ``true`` the area's audio bus overrides the default audio bus. Default value: The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also ``collision_mask``. - .. _class_Area_collision_mask: +.. _class_Area_collision_mask: - :ref:`int` **collision_mask** @@ -210,7 +210,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. - .. _class_Area_gravity: +.. _class_Area_gravity: - :ref:`float` **gravity** @@ -222,7 +222,7 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. - .. _class_Area_gravity_distance_scale: +.. _class_Area_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -234,7 +234,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. - .. _class_Area_gravity_point: +.. _class_Area_gravity_point: - :ref:`bool` **gravity_point** @@ -246,7 +246,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. - .. _class_Area_gravity_vec: +.. _class_Area_gravity_vec: - :ref:`Vector3` **gravity_vec** @@ -258,7 +258,7 @@ If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also s 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: +.. _class_Area_linear_damp: - :ref:`float` **linear_damp** @@ -270,7 +270,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_ The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). - .. _class_Area_monitorable: +.. _class_Area_monitorable: - :ref:`bool` **monitorable** @@ -282,7 +282,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true`` other monitoring areas can detect this area. Default value: ``true``. - .. _class_Area_monitoring: +.. _class_Area_monitoring: - :ref:`bool` **monitoring** @@ -294,7 +294,7 @@ If ``true`` other monitoring areas can detect this area. Default value: ``true`` If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. - .. _class_Area_priority: +.. _class_Area_priority: - :ref:`float` **priority** @@ -306,7 +306,7 @@ If ``true`` the area detects bodies or areas entering and exiting it. Default va The area's priority. Higher priority areas are processed first. Default value: 0. - .. _class_Area_reverb_bus_amount: +.. _class_Area_reverb_bus_amount: - :ref:`float` **reverb_bus_amount** @@ -318,7 +318,7 @@ The area's priority. Higher priority areas are processed first. Default value: 0 The degree to which this area applies reverb to its associated audio. Ranges from ``0`` to ``1`` with ``0.1`` precision. - .. _class_Area_reverb_bus_enable: +.. _class_Area_reverb_bus_enable: - :ref:`bool` **reverb_bus_enable** @@ -330,7 +330,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro If ``true`` the area applies reverb to its associated audio. - .. _class_Area_reverb_bus_name: +.. _class_Area_reverb_bus_name: - :ref:`String` **reverb_bus_name** @@ -342,7 +342,7 @@ If ``true`` the area applies reverb to its associated audio. The reverb bus name to use for this area's associated audio. - .. _class_Area_reverb_bus_uniformity: +.. _class_Area_reverb_bus_uniformity: - :ref:`float` **reverb_bus_uniformity** @@ -354,7 +354,7 @@ The reverb bus name to use for this area's associated audio. The degree to which this area's reverb is a uniform effect. Ranges from ``0`` to ``1`` with ``0.1`` precision. - .. _class_Area_space_override: +.. _class_Area_space_override: - :ref:`SpaceOverride` **space_override** @@ -369,49 +369,49 @@ Override mode for gravity and damping calculations within this area. See the SPA Method Descriptions ------------------- - .. _class_Area_get_collision_layer_bit: +.. _class_Area_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the layer mask. - .. _class_Area_get_collision_mask_bit: +.. _class_Area_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_Area_get_overlapping_areas: +.. _class_Area_get_overlapping_areas: - :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: +.. _class_Area_get_overlapping_bodies: - :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. - .. _class_Area_overlaps_area: +.. _class_Area_overlaps_area: - :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: +.. _class_Area_overlaps_body: - :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. - .. _class_Area_set_collision_layer_bit: +.. _class_Area_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This simplifies editing this ``Area[code]'s layers. - .. _class_Area_set_collision_mask_bit: +.. _class_Area_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index eabc871dd..a51205d2c 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -73,49 +73,49 @@ Methods Signals ------- - .. _class_Area2D_area_entered: +.. _class_Area2D_area_entered: - **area_entered** **(** :ref:`Area2D` area **)** Emitted when another area enters. - .. _class_Area2D_area_exited: +.. _class_Area2D_area_exited: - **area_exited** **(** :ref:`Area2D` area **)** Emitted when another area exits. - .. _class_Area2D_area_shape_entered: +.. _class_Area2D_area_shape_entered: - **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: +.. _class_Area2D_area_shape_exited: - **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: +.. _class_Area2D_body_entered: - **body_entered** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object enters. - .. _class_Area2D_body_exited: +.. _class_Area2D_body_exited: - **body_exited** **(** :ref:`PhysicsBody2D` body **)** Emitted when a :ref:`PhysicsBody2D` object exits. - .. _class_Area2D_body_shape_entered: +.. _class_Area2D_body_shape_entered: - **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. - .. _class_Area2D_body_shape_exited: +.. _class_Area2D_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`PhysicsBody2D` body, :ref:`int` body_shape, :ref:`int` area_shape **)** @@ -124,7 +124,7 @@ Emitted when a :ref:`PhysicsBody2D` object exits, reporting Enumerations ------------ - .. _enum_Area2D_SpaceOverride: +.. _enum_Area2D_SpaceOverride: enum **SpaceOverride**: @@ -142,7 +142,7 @@ Description Property Descriptions --------------------- - .. _class_Area2D_angular_damp: +.. _class_Area2D_angular_damp: - :ref:`float` **angular_damp** @@ -154,7 +154,7 @@ Property Descriptions The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). - .. _class_Area2D_audio_bus_name: +.. _class_Area2D_audio_bus_name: - :ref:`String` **audio_bus_name** @@ -166,7 +166,7 @@ The rate at which objects stop spinning in this area. Represents the angular vel The name of the area's audio bus. - .. _class_Area2D_audio_bus_override: +.. _class_Area2D_audio_bus_override: - :ref:`bool` **audio_bus_override** @@ -178,7 +178,7 @@ The name of the area's audio bus. If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. - .. _class_Area2D_collision_layer: +.. _class_Area2D_collision_layer: - :ref:`int` **collision_layer** @@ -190,7 +190,7 @@ If ``true`` the area's audio bus overrides the default audio bus. Default value: The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also ``collision_mask``. - .. _class_Area2D_collision_mask: +.. _class_Area2D_collision_mask: - :ref:`int` **collision_mask** @@ -202,7 +202,7 @@ The area's physics layer(s). Collidable objects can exist in any of 32 different The physics layers this area scans to determine collision detection. - .. _class_Area2D_gravity: +.. _class_Area2D_gravity: - :ref:`float` **gravity** @@ -214,7 +214,7 @@ The physics layers this area scans to determine collision detection. The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. - .. _class_Area2D_gravity_distance_scale: +.. _class_Area2D_gravity_distance_scale: - :ref:`float` **gravity_distance_scale** @@ -226,7 +226,7 @@ The area's gravity intensity (ranges from -1024 to 1024). This value multiplies The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. - .. _class_Area2D_gravity_point: +.. _class_Area2D_gravity_point: - :ref:`bool` **gravity_point** @@ -238,7 +238,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. - .. _class_Area2D_gravity_vec: +.. _class_Area2D_gravity_vec: - :ref:`Vector2` **gravity_vec** @@ -250,7 +250,7 @@ If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also s 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: +.. _class_Area2D_linear_damp: - :ref:`float` **linear_damp** @@ -262,7 +262,7 @@ The area's gravity vector (not normalized). If gravity is a point (see :ref:`is_ The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from ``0`` (no damping) to ``1`` (full damping). - .. _class_Area2D_monitorable: +.. _class_Area2D_monitorable: - :ref:`bool` **monitorable** @@ -274,7 +274,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci If ``true`` other monitoring areas can detect this area. Default value: ``true``. - .. _class_Area2D_monitoring: +.. _class_Area2D_monitoring: - :ref:`bool` **monitoring** @@ -286,7 +286,7 @@ If ``true`` other monitoring areas can detect this area. Default value: ``true`` If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. - .. _class_Area2D_priority: +.. _class_Area2D_priority: - :ref:`float` **priority** @@ -298,7 +298,7 @@ If ``true`` the area detects bodies or areas entering and exiting it. Default va The area's priority. Higher priority areas are processed first. Default value: 0. - .. _class_Area2D_space_override: +.. _class_Area2D_space_override: - :ref:`SpaceOverride` **space_override** @@ -313,49 +313,49 @@ Override mode for gravity and damping calculations within this area. See the SPA Method Descriptions ------------------- - .. _class_Area2D_get_collision_layer_bit: +.. _class_Area2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. - .. _class_Area2D_get_collision_mask_bit: +.. _class_Area2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. - .. _class_Area2D_get_overlapping_areas: +.. _class_Area2D_get_overlapping_areas: - :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: +.. _class_Area2D_get_overlapping_bodies: - :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. - .. _class_Area2D_overlaps_area: +.. _class_Area2D_overlaps_area: - :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: +.. _class_Area2D_overlaps_body: - :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. - .. _class_Area2D_set_collision_layer_bit: +.. _class_Area2D_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. - .. _class_Area2D_set_collision_mask_bit: +.. _class_Area2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_array.rst b/classes/class_array.rst index db3e75b37..436a32f11 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -110,85 +110,85 @@ Arrays are always passed by reference. Method Descriptions ------------------- - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** Construct an array from a :ref:`PoolColorArray`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** Construct an array from a :ref:`PoolVector3Array`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** Construct an array from a :ref:`PoolVector2Array`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolStringArray` from **)** Construct an array from a :ref:`PoolStringArray`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolRealArray` from **)** Construct an array from a :ref:`PoolRealArray`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** Construct an array from a :ref:`PoolIntArray`. - .. _class_Array_Array: +.. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolByteArray` from **)** Construct an array from a :ref:`PoolByteArray`. - .. _class_Array_append: +.. _class_Array_append: - void **append** **(** :ref:`Variant` value **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_Array_back: +.. _class_Array_back: - :ref:`Variant` **back** **(** **)** Returns the last element of the array if the array is not empty (size>0). - .. _class_Array_bsearch: +.. _class_Array_bsearch: - :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: +.. _class_Array_bsearch_custom: - :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. - .. _class_Array_clear: +.. _class_Array_clear: - void **clear** **(** **)** Clear the array (resize to 0). - .. _class_Array_count: +.. _class_Array_count: - :ref:`int` **count** **(** :ref:`Variant` value **)** Return the amount of times an element is in the array. - .. _class_Array_duplicate: +.. _class_Array_duplicate: - :ref:`Array` **duplicate** **(** :ref:`bool` deep=False **)** @@ -196,37 +196,37 @@ Returns a copy of the array. If ``deep`` is ``true``, a deep copy is be performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If ``false``, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. - .. _class_Array_empty: +.. _class_Array_empty: - :ref:`bool` **empty** **(** **)** Return true if the array is empty (size==0). - .. _class_Array_erase: +.. _class_Array_erase: - void **erase** **(** :ref:`Variant` value **)** Remove the first occurrence of a value from the array. - .. _class_Array_find: +.. _class_Array_find: - :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: +.. _class_Array_find_last: - :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: +.. _class_Array_front: - :ref:`Variant` **front** **(** **)** Returns the first element of the array if the array is not empty (size>0). - .. _class_Array_has: +.. _class_Array_has: - :ref:`bool` **has** **(** :ref:`Variant` value **)** @@ -239,97 +239,97 @@ Return true if the array contains given value. [ "inside", 7 ].has(7) == true [ "inside", 7 ].has("7") == false - .. _class_Array_hash: +.. _class_Array_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the array contents. - .. _class_Array_insert: +.. _class_Array_insert: - 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()``). - .. _class_Array_invert: +.. _class_Array_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_Array_max: +.. _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: +.. _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: +.. _class_Array_pop_back: - :ref:`Variant` **pop_back** **(** **)** Remove the last element of the array. - .. _class_Array_pop_front: +.. _class_Array_pop_front: - :ref:`Variant` **pop_front** **(** **)** Remove the first element of the array. - .. _class_Array_push_back: +.. _class_Array_push_back: - void **push_back** **(** :ref:`Variant` value **)** Append an element at the end of the array. - .. _class_Array_push_front: +.. _class_Array_push_front: - void **push_front** **(** :ref:`Variant` value **)** Add an element at the beginning of the array. - .. _class_Array_remove: +.. _class_Array_remove: - void **remove** **(** :ref:`int` position **)** Remove an element from the array by index. - .. _class_Array_resize: +.. _class_Array_resize: - void **resize** **(** :ref:`int` size **)** Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. - .. _class_Array_rfind: +.. _class_Array_rfind: - :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. - .. _class_Array_shuffle: +.. _class_Array_shuffle: - void **shuffle** **(** **)** Shuffle the array such that the items will have a random order. - .. _class_Array_size: +.. _class_Array_size: - :ref:`int` **size** **(** **)** Return the amount of elements in the array. - .. _class_Array_sort: +.. _class_Array_sort: - void **sort** **(** **)** Sort the array using natural order. - .. _class_Array_sort_custom: +.. _class_Array_sort_custom: - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index b681d7a73..dc903659b 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -69,7 +69,7 @@ Methods Enumerations ------------ - .. _enum_ArrayMesh_ArrayFormat: +.. _enum_ArrayMesh_ArrayFormat: enum **ArrayFormat**: @@ -83,7 +83,7 @@ enum **ArrayFormat**: - **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights. - **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used. - .. _enum_ArrayMesh_ArrayType: +.. _enum_ArrayMesh_ArrayType: enum **ArrayType**: @@ -105,10 +105,11 @@ 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: +.. _class_ArrayMesh_blend_shape_mode: - :ref:`BlendShapeMode` **blend_shape_mode** @@ -118,7 +119,7 @@ Property Descriptions | *Getter* | get_blend_shape_mode() | +----------+-----------------------------+ - .. _class_ArrayMesh_custom_aabb: +.. _class_ArrayMesh_custom_aabb: - :ref:`AABB` **custom_aabb** @@ -133,11 +134,11 @@ An overriding bounding box for this mesh. Method Descriptions ------------------- - .. _class_ArrayMesh_add_blend_shape: +.. _class_ArrayMesh_add_blend_shape: - void **add_blend_shape** **(** :ref:`String` name **)** - .. _class_ArrayMesh_add_surface_from_arrays: +.. _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 **)** @@ -151,97 +152,97 @@ Adding an index array puts this function into "index mode" where the vertex and Godot uses clockwise winding order for front faces of triangle primitive modes. - .. _class_ArrayMesh_center_geometry: +.. _class_ArrayMesh_center_geometry: - void **center_geometry** **(** **)** Centers the geometry. - .. _class_ArrayMesh_clear_blend_shapes: +.. _class_ArrayMesh_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** Remove all blend shapes from this ``ArrayMesh``. - .. _class_ArrayMesh_get_blend_shape_count: +.. _class_ArrayMesh_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const Returns the number of blend shapes that the ``ArrayMesh`` holds. - .. _class_ArrayMesh_get_blend_shape_name: +.. _class_ArrayMesh_get_blend_shape_name: - :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const Returns the name of the blend shape at this index. - .. _class_ArrayMesh_lightmap_unwrap: +.. _class_ArrayMesh_lightmap_unwrap: - :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. - .. _class_ArrayMesh_regen_normalmaps: +.. _class_ArrayMesh_regen_normalmaps: - void **regen_normalmaps** **(** **)** Will regenerate normal maps for the ``ArrayMesh``. - .. _class_ArrayMesh_surface_find_by_name: +.. _class_ArrayMesh_surface_find_by_name: - :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. - .. _class_ArrayMesh_surface_get_array_index_len: +.. _class_ArrayMesh_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const Return the length in indices of the index array in the requested surface (see :ref:`add_surface_from_arrays`). - .. _class_ArrayMesh_surface_get_array_len: +.. _class_ArrayMesh_surface_get_array_len: - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface_from_arrays`). - .. _class_ArrayMesh_surface_get_format: +.. _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_name: +.. _class_ArrayMesh_surface_get_name: - :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const Get the name assigned to this surface. - .. _class_ArrayMesh_surface_get_primitive_type: +.. _class_ArrayMesh_surface_get_primitive_type: - :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`). - .. _class_ArrayMesh_surface_remove: +.. _class_ArrayMesh_surface_remove: - void **surface_remove** **(** :ref:`int` surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. - .. _class_ArrayMesh_surface_set_material: +.. _class_ArrayMesh_surface_set_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. - .. _class_ArrayMesh_surface_set_name: +.. _class_ArrayMesh_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a name for a given surface. - .. _class_ArrayMesh_surface_update_region: +.. _class_ArrayMesh_surface_update_region: - 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 83673750d..b73096cef 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -48,7 +48,7 @@ Keep in mind that as long as plane detection is enable the size, placing and ori Property Descriptions --------------------- - .. _class_ARVRAnchor_anchor_id: +.. _class_ARVRAnchor_anchor_id: - :ref:`int` **anchor_id** @@ -63,25 +63,25 @@ The anchor's id. You can set this before the anchor itself exists. The first anc Method Descriptions ------------------- - .. _class_ARVRAnchor_get_anchor_name: +.. _class_ARVRAnchor_get_anchor_name: - :ref:`String` **get_anchor_name** **(** **)** const Returns the name given to this anchor. - .. _class_ARVRAnchor_get_is_active: +.. _class_ARVRAnchor_get_is_active: - :ref:`bool` **get_is_active** **(** **)** const Returns true if the anchor is being tracked and false if no anchor with this id is currently known. - .. _class_ARVRAnchor_get_plane: +.. _class_ARVRAnchor_get_plane: - :ref:`Plane` **get_plane** **(** **)** const Returns a plane aligned with our anchor, handy for intersection testing - .. _class_ARVRAnchor_get_size: +.. _class_ARVRAnchor_get_size: - :ref:`Vector3` **get_size** **(** **)** const diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index 8e45d8174..471c52e7a 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -45,13 +45,13 @@ Methods Signals ------- - .. _class_ARVRController_button_pressed: +.. _class_ARVRController_button_pressed: - **button_pressed** **(** :ref:`int` button **)** Emitted when a button on this controller is pressed. - .. _class_ARVRController_button_release: +.. _class_ARVRController_button_release: - **button_release** **(** :ref:`int` button **)** @@ -69,7 +69,7 @@ The position of the controller node is automatically updated by the ARVR Server. Property Descriptions --------------------- - .. _class_ARVRController_controller_id: +.. _class_ARVRController_controller_id: - :ref:`int` **controller_id** @@ -87,7 +87,7 @@ For any other controller that the :ref:`ARVRServer` detects we 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: +.. _class_ARVRController_rumble: - :ref:`float` **rumble** @@ -102,37 +102,37 @@ The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with pre Method Descriptions ------------------- - .. _class_ARVRController_get_controller_name: +.. _class_ARVRController_get_controller_name: - :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: +.. _class_ARVRController_get_hand: - :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this controller, if known. See TRACKER\_\* constants in :ref:`ARVRPositionalTracker`. - .. _class_ARVRController_get_is_active: +.. _class_ARVRController_get_is_active: - :ref:`bool` **get_is_active** **(** **)** const Returns ``true`` if the bound controller is active. ARVR systems attempt to track active controllers. - .. _class_ARVRController_get_joystick_axis: +.. _class_ARVRController_get_joystick_axis: - :ref:`float` **get_joystick_axis** **(** :ref:`int` axis **)** const Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. - .. _class_ARVRController_get_joystick_id: +.. _class_ARVRController_get_joystick_id: - :ref:`int` **get_joystick_id** **(** **)** const Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. - .. _class_ARVRController_is_button_pressed: +.. _class_ARVRController_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 3e21d27ed..8cd39e4d8 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -51,7 +51,7 @@ Methods Enumerations ------------ - .. _enum_ARVRInterface_Eyes: +.. _enum_ARVRInterface_Eyes: enum **Eyes**: @@ -59,7 +59,7 @@ enum **Eyes**: - **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. - **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. - .. _enum_ARVRInterface_Tracking_status: +.. _enum_ARVRInterface_Tracking_status: enum **Tracking_status**: @@ -69,7 +69,7 @@ enum **Tracking_status**: - **ARVR_UNKNOWN_TRACKING** = **3** --- We don't know the status of the tracking or this interface does not provide feedback. - **ARVR_NOT_TRACKING** = **4** --- Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.) - .. _enum_ARVRInterface_Capabilities: +.. _enum_ARVRInterface_Capabilities: enum **Capabilities**: @@ -89,7 +89,7 @@ Interfaces should be written in such a way that simply enabling them will give u Property Descriptions --------------------- - .. _class_ARVRInterface_ar_is_anchor_detection_enabled: +.. _class_ARVRInterface_ar_is_anchor_detection_enabled: - :ref:`bool` **ar_is_anchor_detection_enabled** @@ -101,7 +101,7 @@ Property Descriptions On an AR interface, is our anchor detection enabled? - .. _class_ARVRInterface_interface_is_initialized: +.. _class_ARVRInterface_interface_is_initialized: - :ref:`bool` **interface_is_initialized** @@ -113,7 +113,7 @@ On an AR interface, is our anchor detection enabled? Has this interface been initialized? - .. _class_ARVRInterface_interface_is_primary: +.. _class_ARVRInterface_interface_is_primary: - :ref:`bool` **interface_is_primary** @@ -128,31 +128,31 @@ Is this our primary interface? Method Descriptions ------------------- - .. _class_ARVRInterface_get_capabilities: +.. _class_ARVRInterface_get_capabilities: - :ref:`int` **get_capabilities** **(** **)** const Returns a combination of flags providing information about the capabilities of this interface. - .. _class_ARVRInterface_get_name: +.. _class_ARVRInterface_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). - .. _class_ARVRInterface_get_render_targetsize: +.. _class_ARVRInterface_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: +.. _class_ARVRInterface_get_tracking_status: - :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. - .. _class_ARVRInterface_initialize: +.. _class_ARVRInterface_initialize: - :ref:`bool` **initialize** **(** **)** @@ -166,13 +166,13 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD. - .. _class_ARVRInterface_is_stereo: +.. _class_ARVRInterface_is_stereo: - :ref:`bool` **is_stereo** **(** **)** Returns true if the current output of this interface is in stereo. - .. _class_ARVRInterface_uninitialize: +.. _class_ARVRInterface_uninitialize: - void **uninitialize** **(** **)** diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index 9b5cbba08..d593e2035 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -37,7 +37,7 @@ So say that your character is driving a car, the ARVROrigin node should be a chi Property Descriptions --------------------- - .. _class_ARVROrigin_world_scale: +.. _class_ARVROrigin_world_scale: - :ref:`float` **world_scale** diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index c406356a6..9999f728b 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -49,7 +49,7 @@ Methods Enumerations ------------ - .. _enum_ARVRPositionalTracker_TrackerHand: +.. _enum_ARVRPositionalTracker_TrackerHand: enum **TrackerHand**: @@ -69,7 +69,7 @@ The ARVRController and ARVRAnchor both consume objects of this type and should b Property Descriptions --------------------- - .. _class_ARVRPositionalTracker_rumble: +.. _class_ARVRPositionalTracker_rumble: - :ref:`float` **rumble** @@ -84,55 +84,55 @@ The degree to which the tracker rumbles. Ranges from ``0.0`` to ``1.0`` with pre Method Descriptions ------------------- - .. _class_ARVRPositionalTracker_get_hand: +.. _class_ARVRPositionalTracker_get_hand: - :ref:`TrackerHand` **get_hand** **(** **)** const Returns the hand holding this tracker, if known. See TRACKER\_\* constants. - .. _class_ARVRPositionalTracker_get_joy_id: +.. _class_ARVRPositionalTracker_get_joy_id: - :ref:`int` **get_joy_id** **(** **)** const If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. - .. _class_ARVRPositionalTracker_get_name: +.. _class_ARVRPositionalTracker_get_name: - :ref:`String` **get_name** **(** **)** const Returns the controller or anchor point's name if available. - .. _class_ARVRPositionalTracker_get_orientation: +.. _class_ARVRPositionalTracker_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const Returns the controller's orientation matrix. - .. _class_ARVRPositionalTracker_get_position: +.. _class_ARVRPositionalTracker_get_position: - :ref:`Vector3` **get_position** **(** **)** const Returns the world-space controller position. - .. _class_ARVRPositionalTracker_get_tracks_orientation: +.. _class_ARVRPositionalTracker_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const Returns ``true`` if this device tracks orientation. - .. _class_ARVRPositionalTracker_get_tracks_position: +.. _class_ARVRPositionalTracker_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const Returns ``true`` if this device tracks position. - .. _class_ARVRPositionalTracker_get_transform: +.. _class_ARVRPositionalTracker_get_transform: - :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: +.. _class_ARVRPositionalTracker_get_type: - :ref:`TrackerType` **get_type** **(** **)** const diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 728d8ccde..91f51ad33 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -57,25 +57,25 @@ Methods Signals ------- - .. _class_ARVRServer_interface_added: +.. _class_ARVRServer_interface_added: - **interface_added** **(** :ref:`String` interface_name **)** Signal send when a new interface has been added. - .. _class_ARVRServer_interface_removed: +.. _class_ARVRServer_interface_removed: - **interface_removed** **(** :ref:`String` interface_name **)** Signal send when an interface is removed. - .. _class_ARVRServer_tracker_added: +.. _class_ARVRServer_tracker_added: - **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: +.. _class_ARVRServer_tracker_removed: - **tracker_removed** **(** :ref:`String` tracker_name, :ref:`int` type, :ref:`int` id **)** @@ -84,7 +84,7 @@ Signal send when a tracker is removed, you should remove any ARVRController or A Enumerations ------------ - .. _enum_ARVRServer_RotationMode: +.. _enum_ARVRServer_RotationMode: enum **RotationMode**: @@ -92,7 +92,7 @@ enum **RotationMode**: - **RESET_BUT_KEEP_TILT** = **1** --- Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset. - **DONT_RESET_ROTATION** = **2** --- Does not reset the orientation of the HMD, only the position of the player gets centered. - .. _enum_ARVRServer_TrackerType: +.. _enum_ARVRServer_TrackerType: enum **TrackerType**: @@ -111,7 +111,7 @@ The AR/VR Server is the heart of our AR/VR solution and handles all the processi Property Descriptions --------------------- - .. _class_ARVRServer_primary_interface: +.. _class_ARVRServer_primary_interface: - :ref:`ARVRInterface` **primary_interface** @@ -121,7 +121,7 @@ Property Descriptions | *Getter* | get_primary_interface() | +----------+------------------------------+ - .. _class_ARVRServer_world_scale: +.. _class_ARVRServer_world_scale: - :ref:`float` **world_scale** @@ -136,7 +136,7 @@ Allows you to adjust the scale to your game's units. Most AR/VR platforms assume Method Descriptions ------------------- - .. _class_ARVRServer_center_on_hmd: +.. _class_ARVRServer_center_on_hmd: - void **center_on_hmd** **(** :ref:`RotationMode` rotation_mode, :ref:`bool` keep_height **)** @@ -152,61 +152,61 @@ For this method to produce usable results tracking information should be availab You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism. - .. _class_ARVRServer_find_interface: +.. _class_ARVRServer_find_interface: - :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: +.. _class_ARVRServer_get_hmd_transform: - :ref:`Transform` **get_hmd_transform** **(** **)** Returns the primary interface's transformation. - .. _class_ARVRServer_get_interface: +.. _class_ARVRServer_get_interface: - :ref:`ARVRInterface` **get_interface** **(** :ref:`int` idx **)** const Get the interface registered at a given index in our list of interfaces. - .. _class_ARVRServer_get_interface_count: +.. _class_ARVRServer_get_interface_count: - :ref:`int` **get_interface_count** **(** **)** const Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. - .. _class_ARVRServer_get_interfaces: +.. _class_ARVRServer_get_interfaces: - :ref:`Array` **get_interfaces** **(** **)** const Returns a list of available interfaces with both id and name of the interface. - .. _class_ARVRServer_get_last_commit_usec: +.. _class_ARVRServer_get_last_commit_usec: - :ref:`int` **get_last_commit_usec** **(** **)** - .. _class_ARVRServer_get_last_frame_usec: +.. _class_ARVRServer_get_last_frame_usec: - :ref:`int` **get_last_frame_usec** **(** **)** - .. _class_ARVRServer_get_last_process_usec: +.. _class_ARVRServer_get_last_process_usec: - :ref:`int` **get_last_process_usec** **(** **)** - .. _class_ARVRServer_get_reference_frame: +.. _class_ARVRServer_get_reference_frame: - :ref:`Transform` **get_reference_frame** **(** **)** const Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. - .. _class_ARVRServer_get_tracker: +.. _class_ARVRServer_get_tracker: - :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const Get the positional tracker at the given ID. - .. _class_ARVRServer_get_tracker_count: +.. _class_ARVRServer_get_tracker_count: - :ref:`int` **get_tracker_count** **(** **)** const diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 5ea3e6b47..481ec663e 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -71,19 +71,19 @@ You must add points manually with :ref:`AStar.add_point` Method Descriptions ------------------- - .. _class_AStar__compute_cost: +.. _class_AStar__compute_cost: - :ref:`float` **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual Called when computing the cost between two connected points. - .. _class_AStar__estimate_cost: +.. _class_AStar__estimate_cost: - :ref:`float` **_estimate_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual Called when estimating the cost between a point and the path's ending point. - .. _class_AStar_add_point: +.. _class_AStar_add_point: - void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** @@ -97,19 +97,19 @@ Adds a new point at the given position with the given identifier. The algorithm If there already exists a point for the given id, its position and weight scale are updated to the given values. - .. _class_AStar_are_points_connected: +.. _class_AStar_are_points_connected: - :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const Returns whether there is a connection/segment between the given points. - .. _class_AStar_clear: +.. _class_AStar_clear: - void **clear** **(** **)** Clears all the points and segments. - .. _class_AStar_connect_points: +.. _class_AStar_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** @@ -125,25 +125,25 @@ Creates a segment between the given points. as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 # and not from point 2 to point 1. - .. _class_AStar_disconnect_points: +.. _class_AStar_disconnect_points: - void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** Deletes the segment between the given points. - .. _class_AStar_get_available_point_id: +.. _class_AStar_get_available_point_id: - :ref:`int` **get_available_point_id** **(** **)** const Returns the next available point id with no point associated to it. - .. _class_AStar_get_closest_point: +.. _class_AStar_get_closest_point: - :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: +.. _class_AStar_get_closest_position_in_segment: - :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const @@ -162,7 +162,7 @@ Returns the closest position to ``to_position`` that resides inside a segment be The result is in the segment that goes from ``y=0`` to ``y=5``. It's the closest position in the segment to the given point. - .. _class_AStar_get_id_path: +.. _class_AStar_get_id_path: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** @@ -187,7 +187,7 @@ Returns an array with the ids of the points that form the path found by AStar be If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]`` instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. - .. _class_AStar_get_point_connections: +.. _class_AStar_get_point_connections: - :ref:`PoolIntArray` **get_point_connections** **(** :ref:`int` id **)** @@ -207,49 +207,49 @@ Returns an array with the ids of the points that form the connect with the given var neighbors = as.get_point_connections(1) # returns [2, 3] - .. _class_AStar_get_point_path: +.. _class_AStar_get_point_path: - :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: +.. _class_AStar_get_point_position: - :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const Returns the position of the point associated with the given id. - .. _class_AStar_get_point_weight_scale: +.. _class_AStar_get_point_weight_scale: - :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const Returns the weight scale of the point associated with the given id. - .. _class_AStar_get_points: +.. _class_AStar_get_points: - :ref:`Array` **get_points** **(** **)** Returns an array of all points. - .. _class_AStar_has_point: +.. _class_AStar_has_point: - :ref:`bool` **has_point** **(** :ref:`int` id **)** const Returns whether a point associated with the given id exists. - .. _class_AStar_remove_point: +.. _class_AStar_remove_point: - void **remove_point** **(** :ref:`int` id **)** Removes the point associated with the given id from the points pool. - .. _class_AStar_set_point_position: +.. _class_AStar_set_point_position: - void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** Sets the position for the point with the given id. - .. _class_AStar_set_point_weight_scale: +.. _class_AStar_set_point_weight_scale: - void **set_point_weight_scale** **(** :ref:`int` id, :ref:`float` weight_scale **)** diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 959d4087d..effdff829 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -39,7 +39,7 @@ and a region that defines the actual area of the AtlasTexture. Property Descriptions --------------------- - .. _class_AtlasTexture_atlas: +.. _class_AtlasTexture_atlas: - :ref:`Texture` **atlas** @@ -51,7 +51,7 @@ Property Descriptions The texture that contains the atlas. Can be any :ref:`Texture` subtype. - .. _class_AtlasTexture_filter_clip: +.. _class_AtlasTexture_filter_clip: - :ref:`bool` **filter_clip** @@ -63,7 +63,7 @@ The texture that contains the atlas. Can be any :ref:`Texture` su If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels. - .. _class_AtlasTexture_margin: +.. _class_AtlasTexture_margin: - :ref:`Rect2` **margin** @@ -75,7 +75,7 @@ If ``true`` clips the area outside of the region to avoid bleeding of the surrou 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: +.. _class_AtlasTexture_region: - :ref:`Rect2` **region** diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index cde6ca060..f66b80d74 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -33,7 +33,7 @@ Increases or decreases the volume being routed through the audio bus. Property Descriptions --------------------- - .. _class_AudioEffectAmplify_volume_db: +.. _class_AudioEffectAmplify_volume_db: - :ref:`float` **volume_db** diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 08f31fcd6..c53ac6a77 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -83,7 +83,7 @@ Adds a chorus audio effect. The effect applies a filter with voices to duplicate Property Descriptions --------------------- - .. _class_AudioEffectChorus_dry: +.. _class_AudioEffectChorus_dry: - :ref:`float` **dry** @@ -95,7 +95,7 @@ Property Descriptions The effect's raw signal. - .. _class_AudioEffectChorus_voice/1/cutoff_hz: +.. _class_AudioEffectChorus_voice/1/cutoff_hz: - :ref:`float` **voice/1/cutoff_hz** @@ -107,7 +107,7 @@ The effect's raw signal. The voice's cutoff frequency. - .. _class_AudioEffectChorus_voice/1/delay_ms: +.. _class_AudioEffectChorus_voice/1/delay_ms: - :ref:`float` **voice/1/delay_ms** @@ -119,7 +119,7 @@ The voice's cutoff frequency. The voice's signal delay. - .. _class_AudioEffectChorus_voice/1/depth_ms: +.. _class_AudioEffectChorus_voice/1/depth_ms: - :ref:`float` **voice/1/depth_ms** @@ -131,7 +131,7 @@ The voice's signal delay. The voice filter's depth. - .. _class_AudioEffectChorus_voice/1/level_db: +.. _class_AudioEffectChorus_voice/1/level_db: - :ref:`float` **voice/1/level_db** @@ -143,7 +143,7 @@ The voice filter's depth. The voice's volume. - .. _class_AudioEffectChorus_voice/1/pan: +.. _class_AudioEffectChorus_voice/1/pan: - :ref:`float` **voice/1/pan** @@ -155,7 +155,7 @@ The voice's volume. The voice's pan level. - .. _class_AudioEffectChorus_voice/1/rate_hz: +.. _class_AudioEffectChorus_voice/1/rate_hz: - :ref:`float` **voice/1/rate_hz** @@ -167,7 +167,7 @@ The voice's pan level. The voice's filter rate. - .. _class_AudioEffectChorus_voice/2/cutoff_hz: +.. _class_AudioEffectChorus_voice/2/cutoff_hz: - :ref:`float` **voice/2/cutoff_hz** @@ -179,7 +179,7 @@ The voice's filter rate. The voice's cutoff frequency. - .. _class_AudioEffectChorus_voice/2/delay_ms: +.. _class_AudioEffectChorus_voice/2/delay_ms: - :ref:`float` **voice/2/delay_ms** @@ -191,7 +191,7 @@ The voice's cutoff frequency. The voice's signal delay. - .. _class_AudioEffectChorus_voice/2/depth_ms: +.. _class_AudioEffectChorus_voice/2/depth_ms: - :ref:`float` **voice/2/depth_ms** @@ -203,7 +203,7 @@ The voice's signal delay. The voice filter's depth. - .. _class_AudioEffectChorus_voice/2/level_db: +.. _class_AudioEffectChorus_voice/2/level_db: - :ref:`float` **voice/2/level_db** @@ -215,7 +215,7 @@ The voice filter's depth. The voice's volume. - .. _class_AudioEffectChorus_voice/2/pan: +.. _class_AudioEffectChorus_voice/2/pan: - :ref:`float` **voice/2/pan** @@ -227,7 +227,7 @@ The voice's volume. The voice's pan level. - .. _class_AudioEffectChorus_voice/2/rate_hz: +.. _class_AudioEffectChorus_voice/2/rate_hz: - :ref:`float` **voice/2/rate_hz** @@ -239,7 +239,7 @@ The voice's pan level. The voice's filter rate. - .. _class_AudioEffectChorus_voice/3/cutoff_hz: +.. _class_AudioEffectChorus_voice/3/cutoff_hz: - :ref:`float` **voice/3/cutoff_hz** @@ -251,7 +251,7 @@ The voice's filter rate. The voice's cutoff frequency. - .. _class_AudioEffectChorus_voice/3/delay_ms: +.. _class_AudioEffectChorus_voice/3/delay_ms: - :ref:`float` **voice/3/delay_ms** @@ -263,7 +263,7 @@ The voice's cutoff frequency. The voice's signal delay. - .. _class_AudioEffectChorus_voice/3/depth_ms: +.. _class_AudioEffectChorus_voice/3/depth_ms: - :ref:`float` **voice/3/depth_ms** @@ -275,7 +275,7 @@ The voice's signal delay. The voice filter's depth. - .. _class_AudioEffectChorus_voice/3/level_db: +.. _class_AudioEffectChorus_voice/3/level_db: - :ref:`float` **voice/3/level_db** @@ -287,7 +287,7 @@ The voice filter's depth. The voice's volume. - .. _class_AudioEffectChorus_voice/3/pan: +.. _class_AudioEffectChorus_voice/3/pan: - :ref:`float` **voice/3/pan** @@ -299,7 +299,7 @@ The voice's volume. The voice's pan level. - .. _class_AudioEffectChorus_voice/3/rate_hz: +.. _class_AudioEffectChorus_voice/3/rate_hz: - :ref:`float` **voice/3/rate_hz** @@ -311,7 +311,7 @@ The voice's pan level. The voice's filter rate. - .. _class_AudioEffectChorus_voice/4/cutoff_hz: +.. _class_AudioEffectChorus_voice/4/cutoff_hz: - :ref:`float` **voice/4/cutoff_hz** @@ -323,7 +323,7 @@ The voice's filter rate. The voice's cutoff frequency. - .. _class_AudioEffectChorus_voice/4/delay_ms: +.. _class_AudioEffectChorus_voice/4/delay_ms: - :ref:`float` **voice/4/delay_ms** @@ -335,7 +335,7 @@ The voice's cutoff frequency. The voice's signal delay. - .. _class_AudioEffectChorus_voice/4/depth_ms: +.. _class_AudioEffectChorus_voice/4/depth_ms: - :ref:`float` **voice/4/depth_ms** @@ -347,7 +347,7 @@ The voice's signal delay. The voice filter's depth. - .. _class_AudioEffectChorus_voice/4/level_db: +.. _class_AudioEffectChorus_voice/4/level_db: - :ref:`float` **voice/4/level_db** @@ -359,7 +359,7 @@ The voice filter's depth. The voice's volume. - .. _class_AudioEffectChorus_voice/4/pan: +.. _class_AudioEffectChorus_voice/4/pan: - :ref:`float` **voice/4/pan** @@ -371,7 +371,7 @@ The voice's volume. The voice's pan level. - .. _class_AudioEffectChorus_voice/4/rate_hz: +.. _class_AudioEffectChorus_voice/4/rate_hz: - :ref:`float` **voice/4/rate_hz** @@ -383,7 +383,7 @@ The voice's pan level. The voice's filter rate. - .. _class_AudioEffectChorus_voice_count: +.. _class_AudioEffectChorus_voice_count: - :ref:`int` **voice_count** @@ -395,7 +395,7 @@ The voice's filter rate. The amount of voices in the effect. - .. _class_AudioEffectChorus_wet: +.. _class_AudioEffectChorus_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 993e201ac..15004d91e 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -55,7 +55,7 @@ Compressor has many uses in the mix: Property Descriptions --------------------- - .. _class_AudioEffectCompressor_attack_us: +.. _class_AudioEffectCompressor_attack_us: - :ref:`float` **attack_us** @@ -67,7 +67,7 @@ Property Descriptions Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: ``20ms``. - .. _class_AudioEffectCompressor_gain: +.. _class_AudioEffectCompressor_gain: - :ref:`float` **gain** @@ -79,7 +79,7 @@ Compressor's reaction time when the signal exceeds the threshold. Value can rang Gain applied to the output signal. - .. _class_AudioEffectCompressor_mix: +.. _class_AudioEffectCompressor_mix: - :ref:`float` **mix** @@ -91,7 +91,7 @@ Gain applied to the output signal. Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: ``1``. - .. _class_AudioEffectCompressor_ratio: +.. _class_AudioEffectCompressor_ratio: - :ref:`float` **ratio** @@ -103,7 +103,7 @@ Balance between original signal and effect signal. Value can range from 0 (total Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: ``4``. - .. _class_AudioEffectCompressor_release_ms: +.. _class_AudioEffectCompressor_release_ms: - :ref:`float` **release_ms** @@ -115,7 +115,7 @@ Amount of compression applied to the audio once it passes the threshold level. T Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: ``250ms``. - .. _class_AudioEffectCompressor_sidechain: +.. _class_AudioEffectCompressor_sidechain: - :ref:`String` **sidechain** @@ -127,7 +127,7 @@ Compressor's delay time to stop reducing the signal after the signal level falls Reduce the sound level using another audio bus for threshold detection. - .. _class_AudioEffectCompressor_threshold: +.. _class_AudioEffectCompressor_threshold: - :ref:`float` **threshold** diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index a0785befb..e896816ea 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -57,7 +57,7 @@ Plays input signal back after a period of time. The delayed signal may be played Property Descriptions --------------------- - .. _class_AudioEffectDelay_dry: +.. _class_AudioEffectDelay_dry: - :ref:`float` **dry** @@ -69,7 +69,7 @@ Property Descriptions Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: ``1``. - .. _class_AudioEffectDelay_feedback/active: +.. _class_AudioEffectDelay_feedback/active: - :ref:`bool` **feedback/active** @@ -81,7 +81,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca If ``true`` feedback is enabled. Default value: ``false``. - .. _class_AudioEffectDelay_feedback/delay_ms: +.. _class_AudioEffectDelay_feedback/delay_ms: - :ref:`float` **feedback/delay_ms** @@ -93,7 +93,7 @@ If ``true`` feedback is enabled. Default value: ``false``. Feedback delay time in milliseconds. Default value: ``340``. - .. _class_AudioEffectDelay_feedback/level_db: +.. _class_AudioEffectDelay_feedback/level_db: - :ref:`float` **feedback/level_db** @@ -105,7 +105,7 @@ Feedback delay time in milliseconds. Default value: ``340``. Sound level for ``tap1``. Default value: ``-6 dB``. - .. _class_AudioEffectDelay_feedback/lowpass: +.. _class_AudioEffectDelay_feedback/lowpass: - :ref:`float` **feedback/lowpass** @@ -117,7 +117,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: ``16000``. - .. _class_AudioEffectDelay_tap1/active: +.. _class_AudioEffectDelay_tap1/active: - :ref:`bool` **tap1/active** @@ -129,7 +129,7 @@ Low-pass filter for feedback. Frequencies below the Low Cut value are filtered o If ``true``, ``tap1`` will be enabled. Default value: ``true``. - .. _class_AudioEffectDelay_tap1/delay_ms: +.. _class_AudioEffectDelay_tap1/delay_ms: - :ref:`float` **tap1/delay_ms** @@ -141,7 +141,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. **Tap1** delay time in milliseconds. Default value: ``250ms``. - .. _class_AudioEffectDelay_tap1/level_db: +.. _class_AudioEffectDelay_tap1/level_db: - :ref:`float` **tap1/level_db** @@ -153,7 +153,7 @@ If ``true``, ``tap1`` will be enabled. Default value: ``true``. Sound level for ``tap1``. Default value: ``-6 dB``. - .. _class_AudioEffectDelay_tap1/pan: +.. _class_AudioEffectDelay_tap1/pan: - :ref:`float` **tap1/pan** @@ -165,7 +165,7 @@ Sound level for ``tap1``. Default value: ``-6 dB``. Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right). Default value: ``0.2``. - .. _class_AudioEffectDelay_tap2/active: +.. _class_AudioEffectDelay_tap2/active: - :ref:`bool` **tap2/active** @@ -177,7 +177,7 @@ Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully righ If ``true``, ``tap2`` will be enabled. Default value: ``true``. - .. _class_AudioEffectDelay_tap2/delay_ms: +.. _class_AudioEffectDelay_tap2/delay_ms: - :ref:`float` **tap2/delay_ms** @@ -189,7 +189,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. **Tap2** delay time in milliseconds. Default value: ``500ms``. - .. _class_AudioEffectDelay_tap2/level_db: +.. _class_AudioEffectDelay_tap2/level_db: - :ref:`float` **tap2/level_db** @@ -201,7 +201,7 @@ If ``true``, ``tap2`` will be enabled. Default value: ``true``. Sound level for ``tap2``. Default value: ``-12 dB``. - .. _class_AudioEffectDelay_tap2/pan: +.. _class_AudioEffectDelay_tap2/pan: - :ref:`float` **tap2/pan** diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 4142f71c0..1ac7c6cf7 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -36,7 +36,7 @@ Properties Enumerations ------------ - .. _enum_AudioEffectDistortion_Mode: +.. _enum_AudioEffectDistortion_Mode: enum **Mode**: @@ -56,7 +56,7 @@ By distorting the waveform the frequency content change, which will often make t Property Descriptions --------------------- - .. _class_AudioEffectDistortion_drive: +.. _class_AudioEffectDistortion_drive: - :ref:`float` **drive** @@ -68,7 +68,7 @@ Property Descriptions Distortion power. Value can range from 0 to 1. Default value: ``0``. - .. _class_AudioEffectDistortion_keep_hf_hz: +.. _class_AudioEffectDistortion_keep_hf_hz: - :ref:`float` **keep_hf_hz** @@ -80,7 +80,7 @@ Distortion power. Value can range from 0 to 1. Default value: ``0``. 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: +.. _class_AudioEffectDistortion_mode: - :ref:`Mode` **mode** @@ -92,7 +92,7 @@ High-pass filter. Frequencies higher than this value will not be affected by the Distortion type. Default value: ``MODE_CLIP``. - .. _class_AudioEffectDistortion_post_gain: +.. _class_AudioEffectDistortion_post_gain: - :ref:`float` **post_gain** @@ -104,7 +104,7 @@ Distortion type. Default value: ``MODE_CLIP``. Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: ``0``. - .. _class_AudioEffectDistortion_pre_gain: +.. _class_AudioEffectDistortion_pre_gain: - :ref:`float` **pre_gain** diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 54b53b7e7..b74d8bbd2 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -39,19 +39,19 @@ AudioEffectEQ gives you control over frequencies. Use it to compensate for exist Method Descriptions ------------------- - .. _class_AudioEffectEQ_get_band_count: +.. _class_AudioEffectEQ_get_band_count: - :ref:`int` **get_band_count** **(** **)** const Returns the number of bands of the equalizer. - .. _class_AudioEffectEQ_get_band_gain_db: +.. _class_AudioEffectEQ_get_band_gain_db: - :ref:`float` **get_band_gain_db** **(** :ref:`int` band_idx **)** const Returns the band's gain at the specified index, in dB. - .. _class_AudioEffectEQ_set_band_gain_db: +.. _class_AudioEffectEQ_set_band_gain_db: - void **set_band_gain_db** **(** :ref:`int` band_idx, :ref:`float` volume_db **)** diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index a369a7115..cecce6d08 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -34,7 +34,7 @@ Properties Enumerations ------------ - .. _enum_AudioEffectFilter_FilterDB: +.. _enum_AudioEffectFilter_FilterDB: enum **FilterDB**: @@ -51,7 +51,7 @@ Allows frequencies other than the :ref:`cutoff_hz` **cutoff_hz** @@ -63,7 +63,7 @@ Property Descriptions Threshold frequency for the filter. - .. _class_AudioEffectFilter_db: +.. _class_AudioEffectFilter_db: - :ref:`FilterDB` **db** @@ -73,7 +73,7 @@ Threshold frequency for the filter. | *Getter* | get_db() | +----------+---------------+ - .. _class_AudioEffectFilter_gain: +.. _class_AudioEffectFilter_gain: - :ref:`float` **gain** @@ -85,7 +85,7 @@ Threshold frequency for the filter. Gain amount of the frequencies after the filter. - .. _class_AudioEffectFilter_resonance: +.. _class_AudioEffectFilter_resonance: - :ref:`float` **resonance** diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 70efb5f8a..b236e5b0f 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -39,7 +39,7 @@ Soft clipping starts to reduce the peaks a little below the threshold level and Property Descriptions --------------------- - .. _class_AudioEffectLimiter_ceiling_db: +.. _class_AudioEffectLimiter_ceiling_db: - :ref:`float` **ceiling_db** @@ -51,7 +51,7 @@ Property Descriptions The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``. - .. _class_AudioEffectLimiter_soft_clip_db: +.. _class_AudioEffectLimiter_soft_clip_db: - :ref:`float` **soft_clip_db** @@ -63,7 +63,7 @@ The waveform's maximum allowed value. Value can range from -20 to -0.1. Default Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``. - .. _class_AudioEffectLimiter_soft_clip_ratio: +.. _class_AudioEffectLimiter_soft_clip_ratio: - :ref:`float` **soft_clip_ratio** @@ -73,7 +73,7 @@ Applies a gain to the limited waves. Value can range from 0 to 6. Default value: | *Getter* | get_soft_clip_ratio() | +----------+----------------------------+ - .. _class_AudioEffectLimiter_threshold_db: +.. _class_AudioEffectLimiter_threshold_db: - :ref:`float` **threshold_db** diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index d3453af7b..3a53d4ee0 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -31,7 +31,7 @@ Determines how much of an audio signal is sent to the left and right buses. Property Descriptions --------------------- - .. _class_AudioEffectPanner_pan: +.. _class_AudioEffectPanner_pan: - :ref:`float` **pan** diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 6e2828d13..7d586b2a4 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -41,7 +41,7 @@ Combines phase-shifted signals with the original signal. The movement of the pha Property Descriptions --------------------- - .. _class_AudioEffectPhaser_depth: +.. _class_AudioEffectPhaser_depth: - :ref:`float` **depth** @@ -53,7 +53,7 @@ Property Descriptions Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: ``1``. - .. _class_AudioEffectPhaser_feedback: +.. _class_AudioEffectPhaser_feedback: - :ref:`float` **feedback** @@ -65,7 +65,7 @@ Governs how high the filter frequencies sweep. Low value will primarily affect b Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: ``0.7``. - .. _class_AudioEffectPhaser_range_max_hz: +.. _class_AudioEffectPhaser_range_max_hz: - :ref:`float` **range_max_hz** @@ -77,7 +77,7 @@ Output percent of modified sound. Value can range from 0.1 to 0.9. Default value Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``1600hz``. - .. _class_AudioEffectPhaser_range_min_hz: +.. _class_AudioEffectPhaser_range_min_hz: - :ref:`float` **range_min_hz** @@ -89,7 +89,7 @@ Determines the maximum frequency affected by the LFO modulations. Value can rang Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: ``440hz``. - .. _class_AudioEffectPhaser_rate_hz: +.. _class_AudioEffectPhaser_rate_hz: - :ref:`float` **rate_hz** diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 0ada89dd8..85793edc1 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -33,7 +33,7 @@ Allows modulation of pitch independently of tempo. All frequencies can be increa Property Descriptions --------------------- - .. _class_AudioEffectPitchShift_pitch_scale: +.. _class_AudioEffectPitchShift_pitch_scale: - :ref:`float` **pitch_scale** diff --git a/classes/class_audioeffectrecord.rst b/classes/class_audioeffectrecord.rst index ea19c9d53..ae1531453 100644 --- a/classes/class_audioeffectrecord.rst +++ b/classes/class_audioeffectrecord.rst @@ -37,7 +37,7 @@ Methods Property Descriptions --------------------- - .. _class_AudioEffectRecord_format: +.. _class_AudioEffectRecord_format: - :ref:`Format` **format** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- - .. _class_AudioEffectRecord_get_recording: +.. _class_AudioEffectRecord_get_recording: - :ref:`AudioStreamSample` **get_recording** **(** **)** const - .. _class_AudioEffectRecord_is_recording_active: +.. _class_AudioEffectRecord_is_recording_active: - :ref:`bool` **is_recording_active** **(** **)** const - .. _class_AudioEffectRecord_set_recording_active: +.. _class_AudioEffectRecord_set_recording_active: - void **set_recording_active** **(** :ref:`bool` record **)** diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index 5fbae5c59..8d7780eb0 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -47,7 +47,7 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t Property Descriptions --------------------- - .. _class_AudioEffectReverb_damping: +.. _class_AudioEffectReverb_damping: - :ref:`float` **damping** @@ -59,7 +59,7 @@ Property Descriptions Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: ``1``. - .. _class_AudioEffectReverb_dry: +.. _class_AudioEffectReverb_dry: - :ref:`float` **dry** @@ -71,7 +71,7 @@ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Val Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: ``1``. - .. _class_AudioEffectReverb_hipass: +.. _class_AudioEffectReverb_hipass: - :ref:`float` **hipass** @@ -83,7 +83,7 @@ Output percent of original sound. At 0, only modified sound is outputted. Value High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: ``0``. - .. _class_AudioEffectReverb_predelay_feedback: +.. _class_AudioEffectReverb_predelay_feedback: - :ref:`float` **predelay_feedback** @@ -95,7 +95,7 @@ High-pass filter passes signals with a frequency higher than a certain cutoff fr Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. - .. _class_AudioEffectReverb_predelay_msec: +.. _class_AudioEffectReverb_predelay_msec: - :ref:`float` **predelay_msec** @@ -107,7 +107,7 @@ Output percent of predelay. Value can range from 0 to 1. Default value: ``1``. Time between the original signal and the early reflections of the reverb signal. Default value: ``150ms``. - .. _class_AudioEffectReverb_room_size: +.. _class_AudioEffectReverb_room_size: - :ref:`float` **room_size** @@ -119,7 +119,7 @@ Time between the original signal and the early reflections of the reverb signal. Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: ``0.8``. - .. _class_AudioEffectReverb_spread: +.. _class_AudioEffectReverb_spread: - :ref:`float` **spread** @@ -131,7 +131,7 @@ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 t Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: ``1``. - .. _class_AudioEffectReverb_wet: +.. _class_AudioEffectReverb_wet: - :ref:`float` **wet** diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 0c9442799..b5d67d4d7 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -30,7 +30,7 @@ Properties Property Descriptions --------------------- - .. _class_AudioEffectStereoEnhance_pan_pullout: +.. _class_AudioEffectStereoEnhance_pan_pullout: - :ref:`float` **pan_pullout** @@ -40,7 +40,7 @@ Property Descriptions | *Getter* | get_pan_pullout() | +----------+------------------------+ - .. _class_AudioEffectStereoEnhance_surround: +.. _class_AudioEffectStereoEnhance_surround: - :ref:`float` **surround** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_surround() | +----------+---------------------+ - .. _class_AudioEffectStereoEnhance_time_pullout_ms: +.. _class_AudioEffectStereoEnhance_time_pullout_ms: - :ref:`float` **time_pullout_ms** diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 7a54794d1..b49868ba9 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -102,7 +102,7 @@ Methods Signals ------- - .. _class_AudioServer_bus_layout_changed: +.. _class_AudioServer_bus_layout_changed: - **bus_layout_changed** **(** **)** @@ -111,7 +111,7 @@ Emitted when the :ref:`AudioBusLayout` changes. Enumerations ------------ - .. _enum_AudioServer_SpeakerMode: +.. _enum_AudioServer_SpeakerMode: enum **SpeakerMode**: @@ -128,226 +128,227 @@ Tutorials --------- - :doc:`../tutorials/audio/audio_buses` + Method Descriptions ------------------- - .. _class_AudioServer_add_bus: +.. _class_AudioServer_add_bus: - void **add_bus** **(** :ref:`int` at_position=-1 **)** Adds a bus at ``at_position``. - .. _class_AudioServer_add_bus_effect: +.. _class_AudioServer_add_bus_effect: - 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``. - .. _class_AudioServer_capture_get_device: +.. _class_AudioServer_capture_get_device: - :ref:`String` **capture_get_device** **(** **)** - .. _class_AudioServer_capture_get_device_list: +.. _class_AudioServer_capture_get_device_list: - :ref:`Array` **capture_get_device_list** **(** **)** - .. _class_AudioServer_capture_set_device: +.. _class_AudioServer_capture_set_device: - void **capture_set_device** **(** :ref:`String` name **)** - .. _class_AudioServer_generate_bus_layout: +.. _class_AudioServer_generate_bus_layout: - :ref:`AudioBusLayout` **generate_bus_layout** **(** **)** const Generates an :ref:`AudioBusLayout` using the available busses and effects. - .. _class_AudioServer_get_bus_count: +.. _class_AudioServer_get_bus_count: - :ref:`int` **get_bus_count** **(** **)** const Returns the number of available busses. - .. _class_AudioServer_get_bus_effect: +.. _class_AudioServer_get_bus_effect: - :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``. - .. _class_AudioServer_get_bus_effect_count: +.. _class_AudioServer_get_bus_effect_count: - :ref:`int` **get_bus_effect_count** **(** :ref:`int` bus_idx **)** Returns the number of effects on the bus at ``bus_idx``. - .. _class_AudioServer_get_bus_index: +.. _class_AudioServer_get_bus_index: - :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: +.. _class_AudioServer_get_bus_name: - :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const Returns the name of the bus with the index ``bus_idx``. - .. _class_AudioServer_get_bus_peak_volume_left_db: +.. _class_AudioServer_get_bus_peak_volume_left_db: - :ref:`float` **get_bus_peak_volume_left_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``. - .. _class_AudioServer_get_bus_peak_volume_right_db: +.. _class_AudioServer_get_bus_peak_volume_right_db: - :ref:`float` **get_bus_peak_volume_right_db** **(** :ref:`int` bus_idx, :ref:`int` channel **)** const Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``. - .. _class_AudioServer_get_bus_send: +.. _class_AudioServer_get_bus_send: - :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. - .. _class_AudioServer_get_bus_volume_db: +.. _class_AudioServer_get_bus_volume_db: - :ref:`float` **get_bus_volume_db** **(** :ref:`int` bus_idx **)** const Returns the volume of the bus at index ``bus_idx`` in dB. - .. _class_AudioServer_get_device: +.. _class_AudioServer_get_device: - :ref:`String` **get_device** **(** **)** - .. _class_AudioServer_get_device_list: +.. _class_AudioServer_get_device_list: - :ref:`Array` **get_device_list** **(** **)** - .. _class_AudioServer_get_mix_rate: +.. _class_AudioServer_get_mix_rate: - :ref:`float` **get_mix_rate** **(** **)** const Returns the sample rate at the output of the audioserver. - .. _class_AudioServer_get_speaker_mode: +.. _class_AudioServer_get_speaker_mode: - :ref:`SpeakerMode` **get_speaker_mode** **(** **)** const Returns the speaker configuration. - .. _class_AudioServer_is_bus_bypassing_effects: +.. _class_AudioServer_is_bus_bypassing_effects: - :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is bypassing effects. - .. _class_AudioServer_is_bus_effect_enabled: +.. _class_AudioServer_is_bus_effect_enabled: - :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. - .. _class_AudioServer_is_bus_mute: +.. _class_AudioServer_is_bus_mute: - :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is muted. - .. _class_AudioServer_is_bus_solo: +.. _class_AudioServer_is_bus_solo: - :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const If ``true`` the bus at index ``bus_idx`` is in solo mode. - .. _class_AudioServer_lock: +.. _class_AudioServer_lock: - void **lock** **(** **)** Locks the audio drivers mainloop. Remember to unlock it afterwards. - .. _class_AudioServer_move_bus: +.. _class_AudioServer_move_bus: - void **move_bus** **(** :ref:`int` index, :ref:`int` to_index **)** Moves the bus from index ``index`` to index ``to_index``. - .. _class_AudioServer_remove_bus: +.. _class_AudioServer_remove_bus: - void **remove_bus** **(** :ref:`int` index **)** Removes the bus at index ``index``. - .. _class_AudioServer_remove_bus_effect: +.. _class_AudioServer_remove_bus_effect: - void **remove_bus_effect** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. - .. _class_AudioServer_set_bus_bypass_effects: +.. _class_AudioServer_set_bus_bypass_effects: - void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is bypassing effects. - .. _class_AudioServer_set_bus_count: +.. _class_AudioServer_set_bus_count: - void **set_bus_count** **(** :ref:`int` amount **)** Adds and removes busses to make the number of busses match ``amount``. - .. _class_AudioServer_set_bus_effect_enabled: +.. _class_AudioServer_set_bus_effect_enabled: - void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. - .. _class_AudioServer_set_bus_layout: +.. _class_AudioServer_set_bus_layout: - void **set_bus_layout** **(** :ref:`AudioBusLayout` bus_layout **)** Overwrites the currently used :ref:`AudioBusLayout`. - .. _class_AudioServer_set_bus_mute: +.. _class_AudioServer_set_bus_mute: - void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is muted. - .. _class_AudioServer_set_bus_name: +.. _class_AudioServer_set_bus_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: +.. _class_AudioServer_set_bus_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``. - .. _class_AudioServer_set_bus_solo: +.. _class_AudioServer_set_bus_solo: - void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** If ``true`` the bus at index ``bus_idx`` is in solo mode. - .. _class_AudioServer_set_bus_volume_db: +.. _class_AudioServer_set_bus_volume_db: - void **set_bus_volume_db** **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** Sets the volume of the bus at index ``bus_idx`` to ``volume_db``. - .. _class_AudioServer_set_device: +.. _class_AudioServer_set_device: - void **set_device** **(** :ref:`String` device **)** - .. _class_AudioServer_swap_bus_effects: +.. _class_AudioServer_swap_bus_effects: - void **swap_bus_effects** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** Swaps the position of two effects in bus ``bus_idx``. - .. _class_AudioServer_unlock: +.. _class_AudioServer_unlock: - void **unlock** **(** **)** diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 0c8be7705..da446dd2a 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -34,10 +34,11 @@ Tutorials --------- - :doc:`../tutorials/audio/audio_streams` + Method Descriptions ------------------- - .. _class_AudioStream_get_length: +.. _class_AudioStream_get_length: - :ref:`float` **get_length** **(** **)** const diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index d67902a5d..ea81f0657 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -35,7 +35,7 @@ OGG Vorbis audio stream driver. Property Descriptions --------------------- - .. _class_AudioStreamOGGVorbis_data: +.. _class_AudioStreamOGGVorbis_data: - :ref:`PoolByteArray` **data** @@ -47,7 +47,7 @@ Property Descriptions Contains the audio data in bytes. - .. _class_AudioStreamOGGVorbis_loop: +.. _class_AudioStreamOGGVorbis_loop: - :ref:`bool` **loop** @@ -57,7 +57,7 @@ Contains the audio data in bytes. | *Getter* | has_loop() | +----------+-----------------+ - .. _class_AudioStreamOGGVorbis_loop_offset: +.. _class_AudioStreamOGGVorbis_loop_offset: - :ref:`float` **loop_offset** diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index f1ef28175..883f7193d 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -53,7 +53,7 @@ Methods Signals ------- - .. _class_AudioStreamPlayer_finished: +.. _class_AudioStreamPlayer_finished: - **finished** **(** **)** @@ -62,7 +62,7 @@ Emitted when the audio stops playing. Enumerations ------------ - .. _enum_AudioStreamPlayer_MixTarget: +.. _enum_AudioStreamPlayer_MixTarget: enum **MixTarget**: @@ -79,11 +79,13 @@ Tutorials --------- - :doc:`../learning/features/audio/index` + - :doc:`../tutorials/audio/audio_streams` + Property Descriptions --------------------- - .. _class_AudioStreamPlayer_autoplay: +.. _class_AudioStreamPlayer_autoplay: - :ref:`bool` **autoplay** @@ -95,7 +97,7 @@ Property Descriptions If ``true`` audio plays when added to scene tree. Default value: ``false``. - .. _class_AudioStreamPlayer_bus: +.. _class_AudioStreamPlayer_bus: - :ref:`String` **bus** @@ -107,7 +109,7 @@ If ``true`` audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. - .. _class_AudioStreamPlayer_mix_target: +.. _class_AudioStreamPlayer_mix_target: - :ref:`MixTarget` **mix_target** @@ -119,7 +121,7 @@ Bus on which this audio is playing. If the audio configuration has more than two speakers, this sets the target channels. See ``MIX_TARGET_*`` constants. - .. _class_AudioStreamPlayer_pitch_scale: +.. _class_AudioStreamPlayer_pitch_scale: - :ref:`float` **pitch_scale** @@ -131,7 +133,7 @@ If the audio configuration has more than two speakers, this sets the target chan Changes the pitch and the tempo of the audio. - .. _class_AudioStreamPlayer_playing: +.. _class_AudioStreamPlayer_playing: - :ref:`bool` **playing** @@ -141,7 +143,7 @@ Changes the pitch and the tempo of the audio. If ``true`` audio is playing. - .. _class_AudioStreamPlayer_stream: +.. _class_AudioStreamPlayer_stream: - :ref:`AudioStream` **stream** @@ -153,7 +155,7 @@ If ``true`` audio is playing. The :ref:`AudioStream` object to be played. - .. _class_AudioStreamPlayer_stream_paused: +.. _class_AudioStreamPlayer_stream_paused: - :ref:`bool` **stream_paused** @@ -163,7 +165,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ - .. _class_AudioStreamPlayer_volume_db: +.. _class_AudioStreamPlayer_volume_db: - :ref:`float` **volume_db** @@ -178,25 +180,25 @@ Volume of sound, in dB. Method Descriptions ------------------- - .. _class_AudioStreamPlayer_get_playback_position: +.. _class_AudioStreamPlayer_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream` in seconds. - .. _class_AudioStreamPlayer_play: +.. _class_AudioStreamPlayer_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. - .. _class_AudioStreamPlayer_seek: +.. _class_AudioStreamPlayer_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. - .. _class_AudioStreamPlayer_stop: +.. _class_AudioStreamPlayer_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index f5b07e717..9e30bba8e 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -57,7 +57,7 @@ Methods Signals ------- - .. _class_AudioStreamPlayer2D_finished: +.. _class_AudioStreamPlayer2D_finished: - **finished** **(** **)** @@ -72,11 +72,13 @@ Tutorials --------- - :doc:`../learning/features/audio/index` + - :doc:`../tutorials/audio/audio_streams` + Property Descriptions --------------------- - .. _class_AudioStreamPlayer2D_area_mask: +.. _class_AudioStreamPlayer2D_area_mask: - :ref:`int` **area_mask** @@ -88,7 +90,7 @@ Property Descriptions Areas in which this sound plays. - .. _class_AudioStreamPlayer2D_attenuation: +.. _class_AudioStreamPlayer2D_attenuation: - :ref:`float` **attenuation** @@ -100,7 +102,7 @@ Areas in which this sound plays. Dampens audio over distance with this as an exponent. - .. _class_AudioStreamPlayer2D_autoplay: +.. _class_AudioStreamPlayer2D_autoplay: - :ref:`bool` **autoplay** @@ -112,7 +114,7 @@ Dampens audio over distance with this as an exponent. If ``true`` audio plays when added to scene tree. Default value: ``false``. - .. _class_AudioStreamPlayer2D_bus: +.. _class_AudioStreamPlayer2D_bus: - :ref:`String` **bus** @@ -124,7 +126,7 @@ If ``true`` audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. - .. _class_AudioStreamPlayer2D_max_distance: +.. _class_AudioStreamPlayer2D_max_distance: - :ref:`float` **max_distance** @@ -136,7 +138,7 @@ Bus on which this audio is playing. Maximum distance from which audio is still hearable. - .. _class_AudioStreamPlayer2D_pitch_scale: +.. _class_AudioStreamPlayer2D_pitch_scale: - :ref:`float` **pitch_scale** @@ -148,7 +150,7 @@ Maximum distance from which audio is still hearable. Changes the pitch and the tempo of the audio. - .. _class_AudioStreamPlayer2D_playing: +.. _class_AudioStreamPlayer2D_playing: - :ref:`bool` **playing** @@ -158,7 +160,7 @@ Changes the pitch and the tempo of the audio. If ``true`` audio is playing. - .. _class_AudioStreamPlayer2D_stream: +.. _class_AudioStreamPlayer2D_stream: - :ref:`AudioStream` **stream** @@ -170,7 +172,7 @@ If ``true`` audio is playing. The :ref:`AudioStream` object to be played. - .. _class_AudioStreamPlayer2D_stream_paused: +.. _class_AudioStreamPlayer2D_stream_paused: - :ref:`bool` **stream_paused** @@ -180,7 +182,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ - .. _class_AudioStreamPlayer2D_volume_db: +.. _class_AudioStreamPlayer2D_volume_db: - :ref:`float` **volume_db** @@ -195,25 +197,25 @@ Base volume without dampening. Method Descriptions ------------------- - .. _class_AudioStreamPlayer2D_get_playback_position: +.. _class_AudioStreamPlayer2D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. - .. _class_AudioStreamPlayer2D_play: +.. _class_AudioStreamPlayer2D_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. - .. _class_AudioStreamPlayer2D_seek: +.. _class_AudioStreamPlayer2D_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. - .. _class_AudioStreamPlayer2D_stop: +.. _class_AudioStreamPlayer2D_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 78a707bef..ac2a42432 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -75,7 +75,7 @@ Methods Signals ------- - .. _class_AudioStreamPlayer3D_finished: +.. _class_AudioStreamPlayer3D_finished: - **finished** **(** **)** @@ -84,7 +84,7 @@ Fires when the audio stops playing. Enumerations ------------ - .. _enum_AudioStreamPlayer3D_DopplerTracking: +.. _enum_AudioStreamPlayer3D_DopplerTracking: enum **DopplerTracking**: @@ -92,14 +92,14 @@ enum **DopplerTracking**: - **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler tracking in idle step. - **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Executes doppler tracking in physics step. - .. _enum_AudioStreamPlayer3D_OutOfRangeMode: +.. _enum_AudioStreamPlayer3D_OutOfRangeMode: enum **OutOfRangeMode**: - **OUT_OF_RANGE_MIX** = **0** --- Mix this audio in, even when it's out of range. - **OUT_OF_RANGE_PAUSE** = **1** --- Pause this audio when it gets out of range. - .. _enum_AudioStreamPlayer3D_AttenuationModel: +.. _enum_AudioStreamPlayer3D_AttenuationModel: enum **AttenuationModel**: @@ -116,11 +116,13 @@ Tutorials --------- - :doc:`../learning/features/audio/index` + - :doc:`../tutorials/audio/audio_streams` + Property Descriptions --------------------- - .. _class_AudioStreamPlayer3D_area_mask: +.. _class_AudioStreamPlayer3D_area_mask: - :ref:`int` **area_mask** @@ -132,7 +134,7 @@ Property Descriptions Areas in which this sound plays. - .. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: +.. _class_AudioStreamPlayer3D_attenuation_filter_cutoff_hz: - :ref:`float` **attenuation_filter_cutoff_hz** @@ -144,7 +146,7 @@ Areas in which this sound plays. Dampens audio above this frequency, in Hz. - .. _class_AudioStreamPlayer3D_attenuation_filter_db: +.. _class_AudioStreamPlayer3D_attenuation_filter_db: - :ref:`float` **attenuation_filter_db** @@ -156,7 +158,7 @@ Dampens audio above this frequency, in Hz. Amount how much the filter affects the loudness, in dB. - .. _class_AudioStreamPlayer3D_attenuation_model: +.. _class_AudioStreamPlayer3D_attenuation_model: - :ref:`AttenuationModel` **attenuation_model** @@ -168,7 +170,7 @@ Amount how much the filter affects the loudness, in dB. Decides if audio should get quieter with distance linearly, quadratically or logarithmically. - .. _class_AudioStreamPlayer3D_autoplay: +.. _class_AudioStreamPlayer3D_autoplay: - :ref:`bool` **autoplay** @@ -180,7 +182,7 @@ Decides if audio should get quieter with distance linearly, quadratically or log If ``true`` audio plays when added to scene tree. Default value: ``false``. - .. _class_AudioStreamPlayer3D_bus: +.. _class_AudioStreamPlayer3D_bus: - :ref:`String` **bus** @@ -192,7 +194,7 @@ If ``true`` audio plays when added to scene tree. Default value: ``false``. Bus on which this audio is playing. - .. _class_AudioStreamPlayer3D_doppler_tracking: +.. _class_AudioStreamPlayer3D_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -204,7 +206,7 @@ Bus on which this audio is playing. Decides in which step the Doppler effect should be calculated. - .. _class_AudioStreamPlayer3D_emission_angle_degrees: +.. _class_AudioStreamPlayer3D_emission_angle_degrees: - :ref:`float` **emission_angle_degrees** @@ -216,7 +218,7 @@ Decides in which step the Doppler effect should be calculated. The angle in which the audio reaches cameras undampened. - .. _class_AudioStreamPlayer3D_emission_angle_enabled: +.. _class_AudioStreamPlayer3D_emission_angle_enabled: - :ref:`bool` **emission_angle_enabled** @@ -228,7 +230,7 @@ The angle in which the audio reaches cameras undampened. If ``true`` the audio should be dampened according to the direction of the sound. - .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: +.. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: - :ref:`float` **emission_angle_filter_attenuation_db** @@ -240,7 +242,7 @@ If ``true`` the audio should be dampened according to the direction of the sound 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: +.. _class_AudioStreamPlayer3D_max_db: - :ref:`float` **max_db** @@ -252,7 +254,7 @@ dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_ang Sets the absolute maximum of the soundlevel, in dB. - .. _class_AudioStreamPlayer3D_max_distance: +.. _class_AudioStreamPlayer3D_max_distance: - :ref:`float` **max_distance** @@ -264,7 +266,7 @@ Sets the absolute maximum of the soundlevel, in dB. 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: +.. _class_AudioStreamPlayer3D_out_of_range_mode: - :ref:`OutOfRangeMode` **out_of_range_mode** @@ -276,7 +278,7 @@ Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect Decides if audio should pause when source is outside of 'max_distance' range. - .. _class_AudioStreamPlayer3D_pitch_scale: +.. _class_AudioStreamPlayer3D_pitch_scale: - :ref:`float` **pitch_scale** @@ -288,7 +290,7 @@ Decides if audio should pause when source is outside of 'max_distance' range. Changes the pitch and the tempo of the audio. - .. _class_AudioStreamPlayer3D_playing: +.. _class_AudioStreamPlayer3D_playing: - :ref:`bool` **playing** @@ -298,7 +300,7 @@ Changes the pitch and the tempo of the audio. If ``true``, audio is playing. - .. _class_AudioStreamPlayer3D_stream: +.. _class_AudioStreamPlayer3D_stream: - :ref:`AudioStream` **stream** @@ -310,7 +312,7 @@ If ``true``, audio is playing. The :ref:`AudioStream` object to be played. - .. _class_AudioStreamPlayer3D_stream_paused: +.. _class_AudioStreamPlayer3D_stream_paused: - :ref:`bool` **stream_paused** @@ -320,7 +322,7 @@ The :ref:`AudioStream` object to be played. | *Getter* | get_stream_paused() | +----------+--------------------------+ - .. _class_AudioStreamPlayer3D_unit_db: +.. _class_AudioStreamPlayer3D_unit_db: - :ref:`float` **unit_db** @@ -332,7 +334,7 @@ The :ref:`AudioStream` object to be played. Base sound level unaffected by dampening, in dB. - .. _class_AudioStreamPlayer3D_unit_size: +.. _class_AudioStreamPlayer3D_unit_size: - :ref:`float` **unit_size** @@ -347,25 +349,25 @@ Factor for the attenuation effect. Method Descriptions ------------------- - .. _class_AudioStreamPlayer3D_get_playback_position: +.. _class_AudioStreamPlayer3D_get_playback_position: - :ref:`float` **get_playback_position** **(** **)** Returns the position in the :ref:`AudioStream`. - .. _class_AudioStreamPlayer3D_play: +.. _class_AudioStreamPlayer3D_play: - void **play** **(** :ref:`float` from_position=0.0 **)** Plays the audio from the given position 'from_position', in seconds. - .. _class_AudioStreamPlayer3D_seek: +.. _class_AudioStreamPlayer3D_seek: - void **seek** **(** :ref:`float` to_position **)** Sets the position from which audio will be played, in seconds. - .. _class_AudioStreamPlayer3D_stop: +.. _class_AudioStreamPlayer3D_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 81438634e..be4a4fcde 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -33,7 +33,7 @@ Randomly varies pitch on each start. Property Descriptions --------------------- - .. _class_AudioStreamRandomPitch_audio_stream: +.. _class_AudioStreamRandomPitch_audio_stream: - :ref:`AudioStream` **audio_stream** @@ -45,7 +45,7 @@ Property Descriptions The current :ref:`AudioStream`. - .. _class_AudioStreamRandomPitch_random_pitch: +.. _class_AudioStreamRandomPitch_random_pitch: - :ref:`float` **random_pitch** diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index ecf911ee5..c6aa8c204 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -45,7 +45,7 @@ Methods Enumerations ------------ - .. _enum_AudioStreamSample_LoopMode: +.. _enum_AudioStreamSample_LoopMode: enum **LoopMode**: @@ -53,7 +53,7 @@ enum **LoopMode**: - **LOOP_FORWARD** = **1** --- Audio loops the data between loop_begin and loop_end playing forward only. - **LOOP_PING_PONG** = **2** --- Audio loops the data between loop_begin and loop_end playing back and forth. - .. _enum_AudioStreamSample_Format: +.. _enum_AudioStreamSample_Format: enum **Format**: @@ -69,7 +69,7 @@ Plays audio, can loop. Property Descriptions --------------------- - .. _class_AudioStreamSample_data: +.. _class_AudioStreamSample_data: - :ref:`PoolByteArray` **data** @@ -81,7 +81,7 @@ Property Descriptions Contains the audio data in bytes. - .. _class_AudioStreamSample_format: +.. _class_AudioStreamSample_format: - :ref:`Format` **format** @@ -93,7 +93,7 @@ Contains the audio data in bytes. Audio format. See FORMAT\_\* constants for values. - .. _class_AudioStreamSample_loop_begin: +.. _class_AudioStreamSample_loop_begin: - :ref:`int` **loop_begin** @@ -105,7 +105,7 @@ Audio format. See FORMAT\_\* constants for values. Loop start in bytes. - .. _class_AudioStreamSample_loop_end: +.. _class_AudioStreamSample_loop_end: - :ref:`int` **loop_end** @@ -117,7 +117,7 @@ Loop start in bytes. Loop end in bytes. - .. _class_AudioStreamSample_loop_mode: +.. _class_AudioStreamSample_loop_mode: - :ref:`LoopMode` **loop_mode** @@ -129,7 +129,7 @@ Loop end in bytes. Loop mode. See LOOP\_\* constants for values. - .. _class_AudioStreamSample_mix_rate: +.. _class_AudioStreamSample_mix_rate: - :ref:`int` **mix_rate** @@ -141,7 +141,7 @@ Loop mode. See LOOP\_\* constants for values. The sample rate for mixing this audio. - .. _class_AudioStreamSample_stereo: +.. _class_AudioStreamSample_stereo: - :ref:`bool` **stereo** @@ -156,7 +156,7 @@ If ``true``, audio is stereo. Default value: ``false``. Method Descriptions ------------------- - .. _class_AudioStreamSample_save_to_wav: +.. _class_AudioStreamSample_save_to_wav: - void **save_to_wav** **(** :ref:`String` path **)** diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 6f0dc5965..b42eeffee 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_BackBufferCopy_CopyMode: +.. _enum_BackBufferCopy_CopyMode: enum **CopyMode**: @@ -44,7 +44,7 @@ Node for back-buffering the currently displayed screen. The region defined in th Property Descriptions --------------------- - .. _class_BackBufferCopy_copy_mode: +.. _class_BackBufferCopy_copy_mode: - :ref:`CopyMode` **copy_mode** @@ -56,7 +56,7 @@ Property Descriptions Buffer mode. See ``COPY_MODE_*`` constants. - .. _class_BackBufferCopy_rect: +.. _class_BackBufferCopy_rect: - :ref:`Rect2` **rect** diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index 54fb7d260..2f1b51c49 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -53,7 +53,7 @@ Methods Enumerations ------------ - .. _enum_BakedLightmap_BakeQuality: +.. _enum_BakedLightmap_BakeQuality: enum **BakeQuality**: @@ -61,7 +61,7 @@ enum **BakeQuality**: - **BAKE_QUALITY_MEDIUM** = **1** --- Default bake quality mode. - **BAKE_QUALITY_HIGH** = **2** --- Highest bake quality mode. Takes longer to calculate. - .. _enum_BakedLightmap_BakeError: +.. _enum_BakedLightmap_BakeError: enum **BakeError**: @@ -71,7 +71,7 @@ enum **BakeError**: - **BAKE_ERROR_CANT_CREATE_IMAGE** = **3** - **BAKE_ERROR_USER_ABORTED** = **4** - .. _enum_BakedLightmap_BakeMode: +.. _enum_BakedLightmap_BakeMode: enum **BakeMode**: @@ -87,10 +87,11 @@ Tutorials --------- - :doc:`../tutorials/3d/baked_lightmaps` + Property Descriptions --------------------- - .. _class_BakedLightmap_bake_cell_size: +.. _class_BakedLightmap_bake_cell_size: - :ref:`float` **bake_cell_size** @@ -102,7 +103,7 @@ Property Descriptions 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: +.. _class_BakedLightmap_bake_energy: - :ref:`float` **bake_energy** @@ -112,7 +113,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil | *Getter* | get_energy() | +----------+-------------------+ - .. _class_BakedLightmap_bake_extents: +.. _class_BakedLightmap_bake_extents: - :ref:`Vector3` **bake_extents** @@ -124,7 +125,7 @@ Grid subdivision size for lightmapper calculation. Default value of ``0.25`` wil Size of affected area. - .. _class_BakedLightmap_bake_hdr: +.. _class_BakedLightmap_bake_hdr: - :ref:`bool` **bake_hdr** @@ -136,7 +137,7 @@ Size of affected area. 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: +.. _class_BakedLightmap_bake_mode: - :ref:`BakeMode` **bake_mode** @@ -148,7 +149,7 @@ If ``true`` lightmap can capture light values greater than ``1.0``. Turning this Lightmapping mode. See :ref:`BakeMode`. - .. _class_BakedLightmap_bake_propagation: +.. _class_BakedLightmap_bake_propagation: - :ref:`float` **bake_propagation** @@ -158,7 +159,7 @@ Lightmapping mode. See :ref:`BakeMode`. | *Getter* | get_propagation() | +----------+------------------------+ - .. _class_BakedLightmap_bake_quality: +.. _class_BakedLightmap_bake_quality: - :ref:`BakeQuality` **bake_quality** @@ -170,7 +171,7 @@ Lightmapping mode. See :ref:`BakeMode`. Three quality modes are available. Higher quality requires more rendering time. See :ref:`BakeQuality`. - .. _class_BakedLightmap_capture_cell_size: +.. _class_BakedLightmap_capture_cell_size: - :ref:`float` **capture_cell_size** @@ -182,7 +183,7 @@ Three quality modes are available. Higher quality requires more rendering time. Grid size used for real-time capture information on dynamic objects. Cannot be larger than :ref:`bake_cell_size`. - .. _class_BakedLightmap_image_path: +.. _class_BakedLightmap_image_path: - :ref:`String` **image_path** @@ -194,7 +195,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be l Location where lightmaps will be saved. - .. _class_BakedLightmap_light_data: +.. _class_BakedLightmap_light_data: - :ref:`BakedLightmapData` **light_data** @@ -209,11 +210,11 @@ The calculated light data. Method Descriptions ------------------- - .. _class_BakedLightmap_bake: +.. _class_BakedLightmap_bake: - :ref:`BakeError` **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** - .. _class_BakedLightmap_debug_bake: +.. _class_BakedLightmap_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_bakedlightmapdata.rst b/classes/class_bakedlightmapdata.rst index c43b8393d..f73d3db6b 100644 --- a/classes/class_bakedlightmapdata.rst +++ b/classes/class_bakedlightmapdata.rst @@ -49,7 +49,7 @@ Methods Property Descriptions --------------------- - .. _class_BakedLightmapData_bounds: +.. _class_BakedLightmapData_bounds: - :ref:`AABB` **bounds** @@ -59,7 +59,7 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ - .. _class_BakedLightmapData_cell_space_transform: +.. _class_BakedLightmapData_cell_space_transform: - :ref:`Transform` **cell_space_transform** @@ -69,7 +69,7 @@ Property Descriptions | *Getter* | get_cell_space_transform() | +----------+---------------------------------+ - .. _class_BakedLightmapData_cell_subdiv: +.. _class_BakedLightmapData_cell_subdiv: - :ref:`int` **cell_subdiv** @@ -79,7 +79,7 @@ Property Descriptions | *Getter* | get_cell_subdiv() | +----------+------------------------+ - .. _class_BakedLightmapData_energy: +.. _class_BakedLightmapData_energy: - :ref:`float` **energy** @@ -89,7 +89,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ - .. _class_BakedLightmapData_octree: +.. _class_BakedLightmapData_octree: - :ref:`PoolByteArray` **octree** @@ -102,23 +102,23 @@ Property Descriptions Method Descriptions ------------------- - .. _class_BakedLightmapData_add_user: +.. _class_BakedLightmapData_add_user: - void **add_user** **(** :ref:`NodePath` path, :ref:`Texture` lightmap, :ref:`int` instance **)** - .. _class_BakedLightmapData_clear_users: +.. _class_BakedLightmapData_clear_users: - void **clear_users** **(** **)** - .. _class_BakedLightmapData_get_user_count: +.. _class_BakedLightmapData_get_user_count: - :ref:`int` **get_user_count** **(** **)** const - .. _class_BakedLightmapData_get_user_lightmap: +.. _class_BakedLightmapData_get_user_lightmap: - :ref:`Texture` **get_user_lightmap** **(** :ref:`int` user_idx **)** const - .. _class_BakedLightmapData_get_user_path: +.. _class_BakedLightmapData_get_user_path: - :ref:`NodePath` **get_user_path** **(** :ref:`int` user_idx **)** const diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index 375eef7cc..122eefc09 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -55,25 +55,25 @@ Methods Signals ------- - .. _class_BaseButton_button_down: +.. _class_BaseButton_button_down: - **button_down** **(** **)** Emitted when the button starts being held down. - .. _class_BaseButton_button_up: +.. _class_BaseButton_button_up: - **button_up** **(** **)** Emitted when the button stops being held down. - .. _class_BaseButton_pressed: +.. _class_BaseButton_pressed: - **pressed** **(** **)** This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise). - .. _class_BaseButton_toggled: +.. _class_BaseButton_toggled: - **toggled** **(** :ref:`bool` button_pressed **)** @@ -82,14 +82,14 @@ This signal is emitted when the button was just toggled between pressed and norm Enumerations ------------ - .. _enum_BaseButton_ActionMode: +.. _enum_BaseButton_ActionMode: enum **ActionMode**: - **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked. - **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked. - .. _enum_BaseButton_DrawMode: +.. _enum_BaseButton_DrawMode: enum **DrawMode**: @@ -106,7 +106,7 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc Property Descriptions --------------------- - .. _class_BaseButton_action_mode: +.. _class_BaseButton_action_mode: - :ref:`ActionMode` **action_mode** @@ -118,7 +118,7 @@ Property Descriptions Determines when the button is considered clicked, one of the ACTION_MODE\_\* constants. - .. _class_BaseButton_button_mask: +.. _class_BaseButton_button_mask: - :ref:`int` **button_mask** @@ -132,7 +132,7 @@ 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: +.. _class_BaseButton_disabled: - :ref:`bool` **disabled** @@ -144,7 +144,7 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS If ``true`` the button is in disabled state and can't be clicked or toggled. - .. _class_BaseButton_enabled_focus_mode: +.. _class_BaseButton_enabled_focus_mode: - :ref:`FocusMode` **enabled_focus_mode** @@ -156,7 +156,7 @@ If ``true`` the button is in disabled state and can't be clicked or toggled. Focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode` and :ref:`disabled`). - .. _class_BaseButton_group: +.. _class_BaseButton_group: - :ref:`ButtonGroup` **group** @@ -168,7 +168,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont :ref:`ButtonGroup` associated to the button. - .. _class_BaseButton_pressed: +.. _class_BaseButton_pressed: - :ref:`bool` **pressed** @@ -180,7 +180,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). - .. _class_BaseButton_shortcut: +.. _class_BaseButton_shortcut: - :ref:`ShortCut` **shortcut** @@ -192,7 +192,7 @@ If ``true`` the button's state is pressed. Means the button is pressed down or t Shortcut associated to the button. - .. _class_BaseButton_toggle_mode: +.. _class_BaseButton_toggle_mode: - :ref:`bool` **toggle_mode** @@ -207,25 +207,25 @@ If ``true`` the button is in toggle mode. Makes the button flip state between pr Method Descriptions ------------------- - .. _class_BaseButton__pressed: +.. _class_BaseButton__pressed: - void **_pressed** **(** **)** virtual Called when the button is pressed. - .. _class_BaseButton__toggled: +.. _class_BaseButton__toggled: - void **_toggled** **(** :ref:`bool` button_pressed **)** virtual Called when the button is toggled (only if toggle_mode is active). - .. _class_BaseButton_get_draw_mode: +.. _class_BaseButton_get_draw_mode: - :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. - .. _class_BaseButton_is_hovered: +.. _class_BaseButton_is_hovered: - :ref:`bool` **is_hovered** **(** **)** const diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 746188880..f846ee9e5 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -79,23 +79,25 @@ Tutorials --------- - :doc:`../tutorials/3d/using_transforms` + - :doc:`../tutorials/math/rotations` + Property Descriptions --------------------- - .. _class_Basis_x: +.. _class_Basis_x: - :ref:`Vector3` **x** The basis matrix's x vector. - .. _class_Basis_y: +.. _class_Basis_y: - :ref:`Vector3` **y** The basis matrix's y vector. - .. _class_Basis_z: +.. _class_Basis_z: - :ref:`Vector3` **z** @@ -104,115 +106,115 @@ The basis matrix's z vector. Method Descriptions ------------------- - .. _class_Basis_Basis: +.. _class_Basis_Basis: - :ref:`Basis` **Basis** **(** :ref:`Quat` from **)** Create a rotation matrix from the given quaternion. - .. _class_Basis_Basis: +.. _class_Basis_Basis: - :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: +.. _class_Basis_Basis: - :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: +.. _class_Basis_Basis: - :ref:`Basis` **Basis** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** Create a matrix from 3 axis vectors. - .. _class_Basis_determinant: +.. _class_Basis_determinant: - :ref:`float` **determinant** **(** **)** Return the determinant of the matrix. - .. _class_Basis_get_euler: +.. _class_Basis_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). - .. _class_Basis_get_orthogonal_index: +.. _class_Basis_get_orthogonal_index: - :ref:`int` **get_orthogonal_index** **(** **)** This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. - .. _class_Basis_get_scale: +.. _class_Basis_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: +.. _class_Basis_inverse: - :ref:`Basis` **inverse** **(** **)** Return the inverse of the matrix. - .. _class_Basis_orthonormalized: +.. _class_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: +.. _class_Basis_rotated: - :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: +.. _class_Basis_scaled: - :ref:`Basis` **scaled** **(** :ref:`Vector3` scale **)** Introduce an additional scaling specified by the given 3D scaling factor. - .. _class_Basis_slerp: +.. _class_Basis_slerp: - :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: +.. _class_Basis_tdotx: - :ref:`float` **tdotx** **(** :ref:`Vector3` with **)** Transposed dot product with the x axis of the matrix. - .. _class_Basis_tdoty: +.. _class_Basis_tdoty: - :ref:`float` **tdoty** **(** :ref:`Vector3` with **)** Transposed dot product with the y axis of the matrix. - .. _class_Basis_tdotz: +.. _class_Basis_tdotz: - :ref:`float` **tdotz** **(** :ref:`Vector3` with **)** Transposed dot product with the z axis of the matrix. - .. _class_Basis_transposed: +.. _class_Basis_transposed: - :ref:`Basis` **transposed** **(** **)** Return the transposed version of the matrix. - .. _class_Basis_xform: +.. _class_Basis_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** Return a vector transformed (multiplied) by the matrix. - .. _class_Basis_xform_inv: +.. _class_Basis_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index e96d9d55d..13a784fdb 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -47,51 +47,51 @@ A two-dimensional array of boolean values, can be used to efficiently store a bi Method Descriptions ------------------- - .. _class_BitMap_create: +.. _class_BitMap_create: - void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with false. - .. _class_BitMap_create_from_image_alpha: +.. _class_BitMap_create_from_image_alpha: - 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: +.. _class_BitMap_get_bit: - :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. - .. _class_BitMap_get_size: +.. _class_BitMap_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. - .. _class_BitMap_get_true_bit_count: +.. _class_BitMap_get_true_bit_count: - :ref:`int` **get_true_bit_count** **(** **)** const Returns the amount of bitmap elements that are set to true. - .. _class_BitMap_grow_mask: +.. _class_BitMap_grow_mask: - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** - .. _class_BitMap_opaque_to_polygons: +.. _class_BitMap_opaque_to_polygons: - :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const - .. _class_BitMap_set_bit: +.. _class_BitMap_set_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: +.. _class_BitMap_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index d0c562276..789f570f7 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -60,7 +60,7 @@ Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance Property Descriptions --------------------- - .. _class_BitmapFont_ascent: +.. _class_BitmapFont_ascent: - :ref:`float` **ascent** @@ -72,7 +72,7 @@ Property Descriptions Ascent (number of pixels above the baseline). - .. _class_BitmapFont_distance_field: +.. _class_BitmapFont_distance_field: - :ref:`bool` **distance_field** @@ -84,7 +84,7 @@ Ascent (number of pixels above the baseline). If ``true`` distance field hint is enabled. - .. _class_BitmapFont_fallback: +.. _class_BitmapFont_fallback: - :ref:`BitmapFont` **fallback** @@ -96,7 +96,7 @@ If ``true`` distance field hint is enabled. The fallback font. - .. _class_BitmapFont_height: +.. _class_BitmapFont_height: - :ref:`float` **height** @@ -111,55 +111,55 @@ Total font height (ascent plus descent) in pixels. Method Descriptions ------------------- - .. _class_BitmapFont_add_char: +.. _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 **)** 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. - .. _class_BitmapFont_add_kerning_pair: +.. _class_BitmapFont_add_kerning_pair: - void **add_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b, :ref:`int` kerning **)** Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. - .. _class_BitmapFont_add_texture: +.. _class_BitmapFont_add_texture: - void **add_texture** **(** :ref:`Texture` texture **)** Adds a texture to the ``BitmapFont``. - .. _class_BitmapFont_clear: +.. _class_BitmapFont_clear: - void **clear** **(** **)** Clears all the font data and settings. - .. _class_BitmapFont_create_from_fnt: +.. _class_BitmapFont_create_from_fnt: - :ref:`Error` **create_from_fnt** **(** :ref:`String` path **)** Creates a BitmapFont from the ``*.fnt`` file at ``path``. - .. _class_BitmapFont_get_char_size: +.. _class_BitmapFont_get_char_size: - :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. - .. _class_BitmapFont_get_kerning_pair: +.. _class_BitmapFont_get_kerning_pair: - :ref:`int` **get_kerning_pair** **(** :ref:`int` char_a, :ref:`int` char_b **)** const Returns a kerning pair as a difference. - .. _class_BitmapFont_get_texture: +.. _class_BitmapFont_get_texture: - :ref:`Texture` **get_texture** **(** :ref:`int` idx **)** const Returns the font atlas texture at index ``idx``. - .. _class_BitmapFont_get_texture_count: +.. _class_BitmapFont_get_texture_count: - :ref:`int` **get_texture_count** **(** **)** const diff --git a/classes/class_bone2d.rst b/classes/class_bone2d.rst index 4b25398ed..5b99e825f 100644 --- a/classes/class_bone2d.rst +++ b/classes/class_bone2d.rst @@ -39,7 +39,7 @@ Methods Property Descriptions --------------------- - .. _class_Bone2D_default_length: +.. _class_Bone2D_default_length: - :ref:`float` **default_length** @@ -49,7 +49,7 @@ Property Descriptions | *Getter* | get_default_length() | +----------+---------------------------+ - .. _class_Bone2D_rest: +.. _class_Bone2D_rest: - :ref:`Transform2D` **rest** @@ -62,15 +62,15 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Bone2D_apply_rest: +.. _class_Bone2D_apply_rest: - void **apply_rest** **(** **)** - .. _class_Bone2D_get_index_in_skeleton: +.. _class_Bone2D_get_index_in_skeleton: - :ref:`int` **get_index_in_skeleton** **(** **)** const - .. _class_Bone2D_get_skeleton_rest: +.. _class_Bone2D_get_skeleton_rest: - :ref:`Transform2D` **get_skeleton_rest** **(** **)** const diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index bd504fa7e..940ef97a8 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -31,7 +31,7 @@ This node must be the child of a :ref:`Skeleton` node. You can t Property Descriptions --------------------- - .. _class_BoneAttachment_bone_name: +.. _class_BoneAttachment_bone_name: - :ref:`String` **bone_name** diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 27d1d493a..319846714 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -33,19 +33,19 @@ Boolean built-in type. Method Descriptions ------------------- - .. _class_bool_bool: +.. _class_bool_bool: - :ref:`bool` **bool** **(** :ref:`int` from **)** Cast an :ref:`int` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. - .. _class_bool_bool: +.. _class_bool_bool: - :ref:`bool` **bool** **(** :ref:`float` from **)** Cast a :ref:`float` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. - .. _class_bool_bool: +.. _class_bool_bool: - :ref:`bool` **bool** **(** :ref:`String` from **)** diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index b859d4fcf..6985a83ff 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -35,7 +35,7 @@ Methods Enumerations ------------ - .. _enum_BoxContainer_AlignMode: +.. _enum_BoxContainer_AlignMode: enum **AlignMode**: @@ -51,7 +51,7 @@ Arranges child controls vertically or horizontally, and rearranges the controls Property Descriptions --------------------- - .. _class_BoxContainer_alignment: +.. _class_BoxContainer_alignment: - :ref:`AlignMode` **alignment** @@ -66,7 +66,7 @@ The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CEN Method Descriptions ------------------- - .. _class_BoxContainer_add_spacer: +.. _class_BoxContainer_add_spacer: - void **add_spacer** **(** :ref:`bool` begin **)** diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 7fcbf8e31..89d3907bf 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -31,7 +31,7 @@ Description Property Descriptions --------------------- - .. _class_BoxShape_extents: +.. _class_BoxShape_extents: - :ref:`Vector3` **extents** diff --git a/classes/class_button.rst b/classes/class_button.rst index 5084be899..fd8eba9c4 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -63,7 +63,7 @@ Theme Properties Enumerations ------------ - .. _enum_Button_TextAlign: +.. _enum_Button_TextAlign: enum **TextAlign**: @@ -79,7 +79,7 @@ Button is the standard themed button. It can contain text and an icon, and will Property Descriptions --------------------- - .. _class_Button_align: +.. _class_Button_align: - :ref:`TextAlign` **align** @@ -91,7 +91,7 @@ Property Descriptions Text alignment policy for the button's text, use one of the ALIGN\_\* constants. - .. _class_Button_clip_text: +.. _class_Button_clip_text: - :ref:`bool` **clip_text** @@ -103,7 +103,7 @@ Text alignment policy for the button's text, use one of the ALIGN\_\* constants. 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: +.. _class_Button_flat: - :ref:`bool` **flat** @@ -115,7 +115,7 @@ When this property is enabled, text that is too large to fit the button is clipp Flat buttons don't display decoration. - .. _class_Button_icon: +.. _class_Button_icon: - :ref:`Texture` **icon** @@ -127,7 +127,7 @@ Flat buttons don't display decoration. Button's icon, if text is present the icon will be placed before the text. - .. _class_Button_text: +.. _class_Button_text: - :ref:`String` **text** diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 1a13909f8..0e8dc04a9 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -40,7 +40,7 @@ Group of :ref:`Button`. All direct and indirect children buttons b Method Descriptions ------------------- - .. _class_ButtonGroup_get_pressed_button: +.. _class_ButtonGroup_get_pressed_button: - :ref:`BaseButton` **get_pressed_button** **(** **)** diff --git a/classes/class_camera.rst b/classes/class_camera.rst index ee226b1d5..a56e37d5f 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -81,7 +81,7 @@ Methods Enumerations ------------ - .. _enum_Camera_DopplerTracking: +.. _enum_Camera_DopplerTracking: enum **DopplerTracking**: @@ -89,14 +89,14 @@ enum **DopplerTracking**: - **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). - **DOPPLER_TRACKING_PHYSICS_STEP** = **2** --- Simulate Doppler effect by tracking positions of objects that are changed in ``_physics_process``. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's ``pitch shift``). - .. _enum_Camera_Projection: +.. _enum_Camera_Projection: enum **Projection**: - **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away). - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). - .. _enum_Camera_KeepAspect: +.. _enum_Camera_KeepAspect: enum **KeepAspect**: @@ -111,7 +111,7 @@ Camera is a special node that displays what is visible from its current location Property Descriptions --------------------- - .. _class_Camera_cull_mask: +.. _class_Camera_cull_mask: - :ref:`int` **cull_mask** @@ -123,7 +123,7 @@ Property Descriptions The culling mask that describes which 3D render layers are rendered by this camera. - .. _class_Camera_current: +.. _class_Camera_current: - :ref:`bool` **current** @@ -135,7 +135,7 @@ The culling mask that describes which 3D render layers are rendered by this came If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. - .. _class_Camera_doppler_tracking: +.. _class_Camera_doppler_tracking: - :ref:`DopplerTracking` **doppler_tracking** @@ -147,7 +147,7 @@ If ``true`` the ancestor :ref:`Viewport` is currently using this 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: +.. _class_Camera_environment: - :ref:`Environment` **environment** @@ -159,7 +159,7 @@ If not ``DOPPLER_TRACKING_DISABLED`` this Camera will simulate the Doppler effec The :ref:`Environment` to use for this Camera. - .. _class_Camera_far: +.. _class_Camera_far: - :ref:`float` **far** @@ -171,7 +171,7 @@ The :ref:`Environment` to use for this Camera. The distance to the far culling boundary for this Camera relative to its local z-axis. - .. _class_Camera_fov: +.. _class_Camera_fov: - :ref:`float` **fov** @@ -183,7 +183,7 @@ The distance to the far culling boundary for this Camera relative to its local z 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: +.. _class_Camera_h_offset: - :ref:`float` **h_offset** @@ -195,7 +195,7 @@ The camera's field of view angle (in degrees). Only applicable in perspective mo The horizontal (X) offset of the Camera viewport. - .. _class_Camera_keep_aspect: +.. _class_Camera_keep_aspect: - :ref:`KeepAspect` **keep_aspect** @@ -207,7 +207,7 @@ The horizontal (X) offset of the Camera viewport. The axis to lock during :ref:`fov`/:ref:`size` adjustments. Can be either ``KEEP_WIDTH`` or ``KEEP_HEIGHT``. - .. _class_Camera_near: +.. _class_Camera_near: - :ref:`float` **near** @@ -219,7 +219,7 @@ The axis to lock during :ref:`fov`/:ref:`size` **projection** @@ -231,7 +231,7 @@ The distance to the near culling boundary for this Camera relative to its local 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: +.. _class_Camera_size: - :ref:`float` **size** @@ -243,7 +243,7 @@ The camera's projection mode. In ``PROJECTION_PERSPECTIVE`` mode, objects' z-dis 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: +.. _class_Camera_v_offset: - :ref:`float` **v_offset** @@ -258,75 +258,75 @@ The vertical (Y) offset of the Camera viewport. Method Descriptions ------------------- - .. _class_Camera_clear_current: +.. _class_Camera_clear_current: - void **clear_current** **(** :ref:`bool` enable_next=true **)** If this is the current Camera, remove it from being current. If ``enable_next`` is true, request to make the next Camera current, if any. - .. _class_Camera_get_camera_transform: +.. _class_Camera_get_camera_transform: - :ref:`Transform` **get_camera_transform** **(** **)** const Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node` transform. - .. _class_Camera_get_cull_mask_bit: +.. _class_Camera_get_cull_mask_bit: - :ref:`bool` **get_cull_mask_bit** **(** :ref:`int` layer **)** const - .. _class_Camera_is_position_behind: +.. _class_Camera_is_position_behind: - :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. - .. _class_Camera_make_current: +.. _class_Camera_make_current: - 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. - .. _class_Camera_project_local_ray_normal: +.. _class_Camera_project_local_ray_normal: - :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: +.. _class_Camera_project_position: - :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. - .. _class_Camera_project_ray_normal: +.. _class_Camera_project_ray_normal: - :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. - .. _class_Camera_project_ray_origin: +.. _class_Camera_project_ray_origin: - :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. - .. _class_Camera_set_cull_mask_bit: +.. _class_Camera_set_cull_mask_bit: - void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** - .. _class_Camera_set_orthogonal: +.. _class_Camera_set_orthogonal: - void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** Sets the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) - .. _class_Camera_set_perspective: +.. _class_Camera_set_perspective: - void **set_perspective** **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** Sets the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units. - .. _class_Camera_unproject_position: +.. _class_Camera_unproject_position: - :ref:`Vector2` **unproject_position** **(** :ref:`Vector3` world_point **)** const diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 1080607df..ab738fedd 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -91,7 +91,7 @@ Methods Enumerations ------------ - .. _enum_Camera2D_AnchorMode: +.. _enum_Camera2D_AnchorMode: enum **AnchorMode**: @@ -108,7 +108,7 @@ This node is intended to be a simple helper to get things going quickly and it m Property Descriptions --------------------- - .. _class_Camera2D_anchor_mode: +.. _class_Camera2D_anchor_mode: - :ref:`AnchorMode` **anchor_mode** @@ -120,7 +120,7 @@ Property Descriptions The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. - .. _class_Camera2D_current: +.. _class_Camera2D_current: - :ref:`bool` **current** @@ -130,7 +130,7 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. If ``true`` the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. - .. _class_Camera2D_custom_viewport: +.. _class_Camera2D_custom_viewport: - :ref:`Node` **custom_viewport** @@ -142,7 +142,7 @@ If ``true`` the camera is the active camera for the current scene. Only one came 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: +.. _class_Camera2D_drag_margin_bottom: - :ref:`float` **drag_margin_bottom** @@ -154,7 +154,7 @@ The custom :ref:`Viewport` node attached to the ``Camera2D``. If Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. - .. _class_Camera2D_drag_margin_h_enabled: +.. _class_Camera2D_drag_margin_h_enabled: - :ref:`bool` **drag_margin_h_enabled** @@ -166,7 +166,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move If ``true`` the camera only moves when reaching the horizontal drag margins. If ``false`` the camera moves horizontally regardless of margins. Default value: ``true``. - .. _class_Camera2D_drag_margin_left: +.. _class_Camera2D_drag_margin_left: - :ref:`float` **drag_margin_left** @@ -178,7 +178,7 @@ If ``true`` the camera only moves when reaching the horizontal drag margins. If Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. - .. _class_Camera2D_drag_margin_right: +.. _class_Camera2D_drag_margin_right: - :ref:`float` **drag_margin_right** @@ -190,7 +190,7 @@ Left margin needed to drag the camera. A value of ``1`` makes the camera move on Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. - .. _class_Camera2D_drag_margin_top: +.. _class_Camera2D_drag_margin_top: - :ref:`float` **drag_margin_top** @@ -202,7 +202,7 @@ Right margin needed to drag the camera. A value of ``1`` makes the camera move o Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen. - .. _class_Camera2D_drag_margin_v_enabled: +.. _class_Camera2D_drag_margin_v_enabled: - :ref:`bool` **drag_margin_v_enabled** @@ -214,7 +214,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl If ``true`` the camera only moves when reaching the vertical drag margins. If ``false`` the camera moves vertically regardless of margins. Default value: ``true``. - .. _class_Camera2D_editor_draw_drag_margin: +.. _class_Camera2D_editor_draw_drag_margin: - :ref:`bool` **editor_draw_drag_margin** @@ -226,7 +226,7 @@ If ``true`` the camera only moves when reaching the vertical drag margins. If `` If ``true`` draws the camera's drag margin rectangle in the editor. Default value: ``false`` - .. _class_Camera2D_editor_draw_limits: +.. _class_Camera2D_editor_draw_limits: - :ref:`bool` **editor_draw_limits** @@ -238,7 +238,7 @@ If ``true`` draws the camera's drag margin rectangle in the editor. Default valu If ``true`` draws the camera's limits rectangle in the editor. Default value: ``true`` - .. _class_Camera2D_editor_draw_screen: +.. _class_Camera2D_editor_draw_screen: - :ref:`bool` **editor_draw_screen** @@ -250,7 +250,7 @@ If ``true`` draws the camera's limits rectangle in the editor. Default value: `` If ``true`` draws the camera's screen rectangle in the editor. Default value: ``false`` - .. _class_Camera2D_limit_bottom: +.. _class_Camera2D_limit_bottom: - :ref:`int` **limit_bottom** @@ -262,7 +262,7 @@ If ``true`` draws the camera's screen rectangle in the editor. Default value: `` Bottom scroll limit in pixels. The camera stops moving when reaching this value. - .. _class_Camera2D_limit_left: +.. _class_Camera2D_limit_left: - :ref:`int` **limit_left** @@ -274,7 +274,7 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value. Left scroll limit in pixels. The camera stops moving when reaching this value. - .. _class_Camera2D_limit_right: +.. _class_Camera2D_limit_right: - :ref:`int` **limit_right** @@ -286,7 +286,7 @@ Left scroll limit in pixels. The camera stops moving when reaching this value. Right scroll limit in pixels. The camera stops moving when reaching this value. - .. _class_Camera2D_limit_smoothed: +.. _class_Camera2D_limit_smoothed: - :ref:`bool` **limit_smoothed** @@ -298,7 +298,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. If ``true`` the camera smoothly stops when reaches its limits. Default value: ``false`` - .. _class_Camera2D_limit_top: +.. _class_Camera2D_limit_top: - :ref:`int` **limit_top** @@ -310,7 +310,7 @@ If ``true`` the camera smoothly stops when reaches its limits. Default value: `` Top scroll limit in pixels. The camera stops moving when reaching this value. - .. _class_Camera2D_offset: +.. _class_Camera2D_offset: - :ref:`Vector2` **offset** @@ -322,7 +322,7 @@ Top scroll limit in pixels. The camera stops moving when reaching this value. The camera's offset, useful for looking around or camera shake animations. - .. _class_Camera2D_offset_h: +.. _class_Camera2D_offset_h: - :ref:`float` **offset_h** @@ -334,7 +334,7 @@ The camera's offset, useful for looking around or camera shake animations. The horizontal offset of the camera, relative to the drag margins. Default value: ``0`` - .. _class_Camera2D_offset_v: +.. _class_Camera2D_offset_v: - :ref:`float` **offset_v** @@ -346,7 +346,7 @@ The horizontal offset of the camera, relative to the drag margins. Default value The vertical offset of the camera, relative to the drag margins. Default value: ``0`` - .. _class_Camera2D_rotating: +.. _class_Camera2D_rotating: - :ref:`bool` **rotating** @@ -358,7 +358,7 @@ The vertical offset of the camera, relative to the drag margins. Default value: If ``true`` the camera rotates with the target. Default value: ``false`` - .. _class_Camera2D_smoothing_enabled: +.. _class_Camera2D_smoothing_enabled: - :ref:`bool` **smoothing_enabled** @@ -370,7 +370,7 @@ If ``true`` the camera rotates with the target. Default value: ``false`` If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` - .. _class_Camera2D_smoothing_speed: +.. _class_Camera2D_smoothing_speed: - :ref:`float` **smoothing_speed** @@ -382,7 +382,7 @@ If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_spee Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled` is ``true`` - .. _class_Camera2D_zoom: +.. _class_Camera2D_zoom: - :ref:`Vector2` **zoom** @@ -397,43 +397,43 @@ The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` Method Descriptions ------------------- - .. _class_Camera2D_align: +.. _class_Camera2D_align: - void **align** **(** **)** Align the camera to the tracked node - .. _class_Camera2D_clear_current: +.. _class_Camera2D_clear_current: - void **clear_current** **(** **)** Removes any ``Camera2D`` from the ancestor :ref:`Viewport`'s internal currently-assigned camera. - .. _class_Camera2D_force_update_scroll: +.. _class_Camera2D_force_update_scroll: - void **force_update_scroll** **(** **)** Force the camera to update scroll immediately. - .. _class_Camera2D_get_camera_position: +.. _class_Camera2D_get_camera_position: - :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. - .. _class_Camera2D_get_camera_screen_center: +.. _class_Camera2D_get_camera_screen_center: - :ref:`Vector2` **get_camera_screen_center** **(** **)** const Returns the location of the ``Camera2D``'s screen-center, relative to the origin. - .. _class_Camera2D_make_current: +.. _class_Camera2D_make_current: - void **make_current** **(** **)** Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. - .. _class_Camera2D_reset_smoothing: +.. _class_Camera2D_reset_smoothing: - void **reset_smoothing** **(** **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index dc612f314..7a18162d3 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -137,25 +137,25 @@ Methods Signals ------- - .. _class_CanvasItem_draw: +.. _class_CanvasItem_draw: - **draw** **(** **)** Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. - .. _class_CanvasItem_hide: +.. _class_CanvasItem_hide: - **hide** **(** **)** Emitted when becoming hidden. - .. _class_CanvasItem_item_rect_changed: +.. _class_CanvasItem_item_rect_changed: - **item_rect_changed** **(** **)** Emitted when the item rect has changed. - .. _class_CanvasItem_visibility_changed: +.. _class_CanvasItem_visibility_changed: - **visibility_changed** **(** **)** @@ -164,7 +164,7 @@ Emitted when the visibility (hidden/visible) changes. Enumerations ------------ - .. _enum_CanvasItem_BlendMode: +.. _enum_CanvasItem_BlendMode: enum **BlendMode**: @@ -183,6 +183,7 @@ Constants - **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 ----------- @@ -200,11 +201,13 @@ Tutorials --------- - :doc:`../tutorials/2d/2d_transforms` + - :doc:`../tutorials/2d/custom_drawing_in_2d` + Property Descriptions --------------------- - .. _class_CanvasItem_light_mask: +.. _class_CanvasItem_light_mask: - :ref:`int` **light_mask** @@ -216,7 +219,7 @@ Property Descriptions The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` nodes. Default value: ``1``. - .. _class_CanvasItem_material: +.. _class_CanvasItem_material: - :ref:`Material` **material** @@ -228,7 +231,7 @@ The rendering layers in which this ``CanvasItem`` responds to :ref:`Light2D` **modulate** @@ -240,7 +243,7 @@ The material applied to textures on this ``CanvasItem``. Default value: ``null`` The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 1, 1, 1)`` (opaque "white"). - .. _class_CanvasItem_self_modulate: +.. _class_CanvasItem_self_modulate: - :ref:`Color` **self_modulate** @@ -252,7 +255,7 @@ The color applied to textures on this ``CanvasItem``. Default value: ``Color(1, 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: +.. _class_CanvasItem_show_behind_parent: - :ref:`bool` **show_behind_parent** @@ -264,13 +267,13 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c If ``true`` the object draws behind its parent. Default value: ``false``. - .. _class_CanvasItem_show_on_top: +.. _class_CanvasItem_show_on_top: - :ref:`bool` **show_on_top** If ``true`` the object draws on top of its parent. Default value: ``true``. - .. _class_CanvasItem_use_parent_material: +.. _class_CanvasItem_use_parent_material: - :ref:`bool` **use_parent_material** @@ -282,7 +285,7 @@ If ``true`` the object draws on top of its parent. Default value: ``true``. If ``true`` the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. - .. _class_CanvasItem_visible: +.. _class_CanvasItem_visible: - :ref:`bool` **visible** @@ -297,265 +300,265 @@ If ``true`` this ``CanvasItem`` is drawn. Default value: ``true``. Method Descriptions ------------------- - .. _class_CanvasItem__draw: +.. _class_CanvasItem__draw: - void **_draw** **(** **)** virtual Called (if exists) to draw the canvas item. - .. _class_CanvasItem_draw_char: +.. _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 ) **)** 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: +.. _class_CanvasItem_draw_circle: - void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draws a colored circle. - .. _class_CanvasItem_draw_colored_polygon: +.. _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 **)** Draws a colored polygon of any amount of points, convex or concave. - .. _class_CanvasItem_draw_line: +.. _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 **)** Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. - .. _class_CanvasItem_draw_mesh: +.. _class_CanvasItem_draw_mesh: - void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** - .. _class_CanvasItem_draw_multiline: +.. _class_CanvasItem_draw_multiline: - 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: +.. _class_CanvasItem_draw_multiline_colors: - 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: +.. _class_CanvasItem_draw_multimesh: - void **draw_multimesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** - .. _class_CanvasItem_draw_polygon: +.. _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 **)** Draws a polygon of any amount of points, convex or concave. - .. _class_CanvasItem_draw_polyline: +.. _class_CanvasItem_draw_polyline: - 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: +.. _class_CanvasItem_draw_polyline_colors: - 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: +.. _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 **)** 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: +.. _class_CanvasItem_draw_rect: - void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draws a colored rectangle. - .. _class_CanvasItem_draw_set_transform: +.. _class_CanvasItem_draw_set_transform: - 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: +.. _class_CanvasItem_draw_set_transform_matrix: - 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: +.. _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 **)** Draws a string using a custom font. - .. _class_CanvasItem_draw_style_box: +.. _class_CanvasItem_draw_style_box: - void **draw_style_box** **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** Draws a styled rectangle. - .. _class_CanvasItem_draw_texture: +.. _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 **)** Draws a texture at a given position. - .. _class_CanvasItem_draw_texture_rect: +.. _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 **)** 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: +.. _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 **)** 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: +.. _class_CanvasItem_force_update_transform: - void **force_update_transform** **(** **)** - .. _class_CanvasItem_get_canvas: +.. _class_CanvasItem_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const Return the :ref:`RID` of the :ref:`World2D` canvas where this item is in. - .. _class_CanvasItem_get_canvas_item: +.. _class_CanvasItem_get_canvas_item: - :ref:`RID` **get_canvas_item** **(** **)** const Return the canvas item RID used by :ref:`VisualServer` for this item. - .. _class_CanvasItem_get_canvas_transform: +.. _class_CanvasItem_get_canvas_transform: - :ref:`Transform2D` **get_canvas_transform** **(** **)** const Get the transform matrix of this item's canvas. - .. _class_CanvasItem_get_global_mouse_position: +.. _class_CanvasItem_get_global_mouse_position: - :ref:`Vector2` **get_global_mouse_position** **(** **)** const Get the global position of the mouse. - .. _class_CanvasItem_get_global_transform: +.. _class_CanvasItem_get_global_transform: - :ref:`Transform2D` **get_global_transform** **(** **)** const Get the global transform matrix of this item. - .. _class_CanvasItem_get_global_transform_with_canvas: +.. _class_CanvasItem_get_global_transform_with_canvas: - :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: +.. _class_CanvasItem_get_local_mouse_position: - :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. - .. _class_CanvasItem_get_transform: +.. _class_CanvasItem_get_transform: - :ref:`Transform2D` **get_transform** **(** **)** const Get the transform matrix of this item. - .. _class_CanvasItem_get_viewport_rect: +.. _class_CanvasItem_get_viewport_rect: - :ref:`Rect2` **get_viewport_rect** **(** **)** const Get the viewport's boundaries as a :ref:`Rect2`. - .. _class_CanvasItem_get_viewport_transform: +.. _class_CanvasItem_get_viewport_transform: - :ref:`Transform2D` **get_viewport_transform** **(** **)** const Get this item's transform in relation to the viewport. - .. _class_CanvasItem_get_world_2d: +.. _class_CanvasItem_get_world_2d: - :ref:`World2D` **get_world_2d** **(** **)** const Get the :ref:`World2D` where this item is in. - .. _class_CanvasItem_hide: +.. _class_CanvasItem_hide: - void **hide** **(** **)** Hide the CanvasItem currently visible. - .. _class_CanvasItem_is_local_transform_notification_enabled: +.. _class_CanvasItem_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns ``true`` if local transform notifications are communicated to children. - .. _class_CanvasItem_is_set_as_toplevel: +.. _class_CanvasItem_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const Return if set as toplevel. See :ref:`set_as_toplevel`. - .. _class_CanvasItem_is_transform_notification_enabled: +.. _class_CanvasItem_is_transform_notification_enabled: - :ref:`bool` **is_transform_notification_enabled** **(** **)** const Returns ``true`` if global transform notifications are communicated to children. - .. _class_CanvasItem_is_visible_in_tree: +.. _class_CanvasItem_is_visible_in_tree: - :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``. - .. _class_CanvasItem_make_canvas_position_local: +.. _class_CanvasItem_make_canvas_position_local: - :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: +.. _class_CanvasItem_make_input_local: - :ref:`InputEvent` **make_input_local** **(** :ref:`InputEvent` event **)** const Transformations issued by ``event``'s inputs are applied in local space instead of global space. - .. _class_CanvasItem_set_as_toplevel: +.. _class_CanvasItem_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** Sets as top level. This means that it will not inherit transform from parent canvas items. - .. _class_CanvasItem_set_notify_local_transform: +.. _class_CanvasItem_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with local transform data. - .. _class_CanvasItem_set_notify_transform: +.. _class_CanvasItem_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** If ``enable`` is ``true``, children will be updated with global transform data. - .. _class_CanvasItem_show: +.. _class_CanvasItem_show: - void **show** **(** **)** Show the CanvasItem currently hidden. - .. _class_CanvasItem_update: +.. _class_CanvasItem_update: - void **update** **(** **)** diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index dac0a724f..f3422bd16 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_CanvasItemMaterial_LightMode: +.. _enum_CanvasItemMaterial_LightMode: enum **LightMode**: @@ -36,7 +36,7 @@ enum **LightMode**: - **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light. - **LIGHT_MODE_LIGHT_ONLY** = **2** --- Render the material as if there were only light. - .. _enum_CanvasItemMaterial_BlendMode: +.. _enum_CanvasItemMaterial_BlendMode: enum **BlendMode**: @@ -54,7 +54,7 @@ Description Property Descriptions --------------------- - .. _class_CanvasItemMaterial_blend_mode: +.. _class_CanvasItemMaterial_blend_mode: - :ref:`BlendMode` **blend_mode** @@ -66,7 +66,7 @@ Property Descriptions The manner in which a material's rendering is applied to underlying textures. - .. _class_CanvasItemMaterial_light_mode: +.. _class_CanvasItemMaterial_light_mode: - :ref:`LightMode` **light_mode** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 4aecdc23f..2d6c69324 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -53,11 +53,13 @@ Tutorials --------- - :doc:`../tutorials/2d/2d_transforms` + - :doc:`../tutorials/2d/canvas_layers` + Property Descriptions --------------------- - .. _class_CanvasLayer_custom_viewport: +.. _class_CanvasLayer_custom_viewport: - :ref:`Node` **custom_viewport** @@ -69,7 +71,7 @@ Property Descriptions The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. - .. _class_CanvasLayer_layer: +.. _class_CanvasLayer_layer: - :ref:`int` **layer** @@ -81,7 +83,7 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. Layer index for draw order. Lower values are drawn first. Default value: ``1``. - .. _class_CanvasLayer_offset: +.. _class_CanvasLayer_offset: - :ref:`Vector2` **offset** @@ -93,7 +95,7 @@ Layer index for draw order. Lower values are drawn first. Default value: ``1``. The layer's base offset. - .. _class_CanvasLayer_rotation: +.. _class_CanvasLayer_rotation: - :ref:`float` **rotation** @@ -105,7 +107,7 @@ The layer's base offset. The layer's rotation in radians. - .. _class_CanvasLayer_rotation_degrees: +.. _class_CanvasLayer_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -117,7 +119,7 @@ The layer's rotation in radians. The layer's rotation in degrees. - .. _class_CanvasLayer_scale: +.. _class_CanvasLayer_scale: - :ref:`Vector2` **scale** @@ -129,7 +131,7 @@ The layer's rotation in degrees. The layer's scale. - .. _class_CanvasLayer_transform: +.. _class_CanvasLayer_transform: - :ref:`Transform2D` **transform** @@ -144,7 +146,7 @@ The layer's transform. Method Descriptions ------------------- - .. _class_CanvasLayer_get_canvas: +.. _class_CanvasLayer_get_canvas: - :ref:`RID` **get_canvas** **(** **)** const diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index b2ebf34cb..e91987c74 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -31,7 +31,7 @@ Description Property Descriptions --------------------- - .. _class_CanvasModulate_color: +.. _class_CanvasModulate_color: - :ref:`Color` **color** diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 5aca61853..21b9802a6 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -37,7 +37,7 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh`. Property Descriptions --------------------- - .. _class_CapsuleMesh_mid_height: +.. _class_CapsuleMesh_mid_height: - :ref:`float` **mid_height** @@ -49,7 +49,7 @@ Property Descriptions Height of the capsule mesh from the center point. Defaults to 1.0. - .. _class_CapsuleMesh_radial_segments: +.. _class_CapsuleMesh_radial_segments: - :ref:`int` **radial_segments** @@ -61,7 +61,7 @@ Height of the capsule mesh from the center point. Defaults to 1.0. Number of radial segments on the capsule mesh. Defaults to 64. - .. _class_CapsuleMesh_radius: +.. _class_CapsuleMesh_radius: - :ref:`float` **radius** @@ -73,7 +73,7 @@ Number of radial segments on the capsule mesh. Defaults to 64. Radius of the capsule mesh. Defaults to 1.0. - .. _class_CapsuleMesh_rings: +.. _class_CapsuleMesh_rings: - :ref:`int` **rings** diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 58916f56c..d10bd8485 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -33,7 +33,7 @@ Capsule shape for collisions. Property Descriptions --------------------- - .. _class_CapsuleShape_height: +.. _class_CapsuleShape_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The capsule's height. - .. _class_CapsuleShape_radius: +.. _class_CapsuleShape_radius: - :ref:`float` **radius** diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index e02b1d72b..671041430 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -33,7 +33,7 @@ Capsule shape for 2D collisions. Property Descriptions --------------------- - .. _class_CapsuleShape2D_height: +.. _class_CapsuleShape2D_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The capsule's height. - .. _class_CapsuleShape2D_radius: +.. _class_CapsuleShape2D_radius: - :ref:`float` **radius** diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 6513b46e1..258466839 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -31,7 +31,7 @@ CenterContainer Keeps children controls centered. This container keeps all child Property Descriptions --------------------- - .. _class_CenterContainer_use_top_left: +.. _class_CenterContainer_use_top_left: - :ref:`bool` **use_top_left** diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index bd2def0d0..36e4188e7 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -31,7 +31,7 @@ Circular shape for 2D collisions. This shape is useful for modeling balls or sma Property Descriptions --------------------- - .. _class_CircleShape2D_radius: +.. _class_CircleShape2D_radius: - :ref:`float` **radius** diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index fed423911..5d693719f 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -69,121 +69,121 @@ Provides access to metadata stored for every available class. Method Descriptions ------------------- - .. _class_ClassDB_can_instance: +.. _class_ClassDB_can_instance: - :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: +.. _class_ClassDB_class_exists: - :ref:`bool` **class_exists** **(** :ref:`String` class **)** const Returns whether the specified 'class' is available or not. - .. _class_ClassDB_class_get_category: +.. _class_ClassDB_class_get_category: - :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: +.. _class_ClassDB_class_get_integer_constant: - :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: +.. _class_ClassDB_class_get_integer_constant_list: - :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: +.. _class_ClassDB_class_get_method_list: - :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). - .. _class_ClassDB_class_get_property: +.. _class_ClassDB_class_get_property: - :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: +.. _class_ClassDB_class_get_property_list: - :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: +.. _class_ClassDB_class_get_signal: - :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). - .. _class_ClassDB_class_get_signal_list: +.. _class_ClassDB_class_get_signal_list: - :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`. - .. _class_ClassDB_class_has_integer_constant: +.. _class_ClassDB_class_has_integer_constant: - :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: +.. _class_ClassDB_class_has_method: - :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: +.. _class_ClassDB_class_has_signal: - :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: +.. _class_ClassDB_class_set_property: - :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: +.. _class_ClassDB_get_class_list: - :ref:`PoolStringArray` **get_class_list** **(** **)** const Returns the names of all the classes available. - .. _class_ClassDB_get_inheriters_from_class: +.. _class_ClassDB_get_inheriters_from_class: - :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: +.. _class_ClassDB_get_parent_class: - :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const Returns the parent class of 'class'. - .. _class_ClassDB_instance: +.. _class_ClassDB_instance: - :ref:`Variant` **instance** **(** :ref:`String` class **)** const Creates an instance of 'class'. - .. _class_ClassDB_is_class_enabled: +.. _class_ClassDB_is_class_enabled: - :ref:`bool` **is_class_enabled** **(** :ref:`String` class **)** const Returns whether this class is enabled or not. - .. _class_ClassDB_is_parent_class: +.. _class_ClassDB_is_parent_class: - :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const diff --git a/classes/class_clippedcamera.rst b/classes/class_clippedcamera.rst index 8a15edd60..06f49ce40 100644 --- a/classes/class_clippedcamera.rst +++ b/classes/class_clippedcamera.rst @@ -53,7 +53,7 @@ Methods Enumerations ------------ - .. _enum_ClippedCamera_ProcessMode: +.. _enum_ClippedCamera_ProcessMode: enum **ProcessMode**: @@ -63,7 +63,7 @@ enum **ProcessMode**: Property Descriptions --------------------- - .. _class_ClippedCamera_clip_to_areas: +.. _class_ClippedCamera_clip_to_areas: - :ref:`bool` **clip_to_areas** @@ -73,7 +73,7 @@ Property Descriptions | *Getter* | is_clip_to_areas_enabled() | +----------+----------------------------+ - .. _class_ClippedCamera_clip_to_bodies: +.. _class_ClippedCamera_clip_to_bodies: - :ref:`bool` **clip_to_bodies** @@ -83,7 +83,7 @@ Property Descriptions | *Getter* | is_clip_to_bodies_enabled() | +----------+-----------------------------+ - .. _class_ClippedCamera_collision_mask: +.. _class_ClippedCamera_collision_mask: - :ref:`int` **collision_mask** @@ -93,7 +93,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ - .. _class_ClippedCamera_margin: +.. _class_ClippedCamera_margin: - :ref:`float` **margin** @@ -103,7 +103,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ - .. _class_ClippedCamera_process_mode: +.. _class_ClippedCamera_process_mode: - :ref:`ProcessMode` **process_mode** @@ -116,31 +116,31 @@ Property Descriptions Method Descriptions ------------------- - .. _class_ClippedCamera_add_exception: +.. _class_ClippedCamera_add_exception: - void **add_exception** **(** :ref:`Object` node **)** - .. _class_ClippedCamera_add_exception_rid: +.. _class_ClippedCamera_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** - .. _class_ClippedCamera_clear_exceptions: +.. _class_ClippedCamera_clear_exceptions: - void **clear_exceptions** **(** **)** - .. _class_ClippedCamera_get_collision_mask_bit: +.. _class_ClippedCamera_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const - .. _class_ClippedCamera_remove_exception: +.. _class_ClippedCamera_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** - .. _class_ClippedCamera_remove_exception_rid: +.. _class_ClippedCamera_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** - .. _class_ClippedCamera_set_collision_mask_bit: +.. _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 2a42bfe0f..57103ddae 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -69,19 +69,19 @@ Methods Signals ------- - .. _class_CollisionObject_input_event: +.. _class_CollisionObject_input_event: - **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. - .. _class_CollisionObject_mouse_entered: +.. _class_CollisionObject_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. - .. _class_CollisionObject_mouse_exited: +.. _class_CollisionObject_mouse_exited: - **mouse_exited** **(** **)** @@ -95,7 +95,7 @@ CollisionObject is the base class for physics objects. It can hold any number of Property Descriptions --------------------- - .. _class_CollisionObject_input_capture_on_drag: +.. _class_CollisionObject_input_capture_on_drag: - :ref:`bool` **input_capture_on_drag** @@ -107,7 +107,7 @@ Property Descriptions If ``true`` the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. - .. _class_CollisionObject_input_ray_pickable: +.. _class_CollisionObject_input_ray_pickable: - :ref:`bool` **input_ray_pickable** @@ -122,103 +122,103 @@ If ``true`` the :ref:`CollisionObject`'s shapes will resp Method Descriptions ------------------- - .. _class_CollisionObject__input_event: +.. _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 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: +.. _class_CollisionObject_create_shape_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: +.. _class_CollisionObject_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. - .. _class_CollisionObject_get_shape_owners: +.. _class_CollisionObject_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. - .. _class_CollisionObject_is_shape_owner_disabled: +.. _class_CollisionObject_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true`` the shape owner and its shapes are disabled. - .. _class_CollisionObject_remove_shape_owner: +.. _class_CollisionObject_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. - .. _class_CollisionObject_shape_find_owner: +.. _class_CollisionObject_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. - .. _class_CollisionObject_shape_owner_add_shape: +.. _class_CollisionObject_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** Adds a :ref:`Shape` to the shape owner. - .. _class_CollisionObject_shape_owner_clear_shapes: +.. _class_CollisionObject_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. - .. _class_CollisionObject_shape_owner_get_owner: +.. _class_CollisionObject_shape_owner_get_owner: - :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: +.. _class_CollisionObject_shape_owner_get_shape: - :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. - .. _class_CollisionObject_shape_owner_get_shape_count: +.. _class_CollisionObject_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. - .. _class_CollisionObject_shape_owner_get_shape_index: +.. _class_CollisionObject_shape_owner_get_shape_index: - :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. - .. _class_CollisionObject_shape_owner_get_transform: +.. _class_CollisionObject_shape_owner_get_transform: - :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform`. - .. _class_CollisionObject_shape_owner_remove_shape: +.. _class_CollisionObject_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. - .. _class_CollisionObject_shape_owner_set_disabled: +.. _class_CollisionObject_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true`` disables the given shape owner. - .. _class_CollisionObject_shape_owner_set_transform: +.. _class_CollisionObject_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)** diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index cbfbaf1f0..8ecab7193 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -71,19 +71,19 @@ Methods Signals ------- - .. _class_CollisionObject2D_input_event: +.. _class_CollisionObject2D_input_event: - **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. - .. _class_CollisionObject2D_mouse_entered: +.. _class_CollisionObject2D_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. - .. _class_CollisionObject2D_mouse_exited: +.. _class_CollisionObject2D_mouse_exited: - **mouse_exited** **(** **)** @@ -97,7 +97,7 @@ CollisionObject2D is the base class for 2D physics objects. It can hold any numb Property Descriptions --------------------- - .. _class_CollisionObject2D_input_pickable: +.. _class_CollisionObject2D_input_pickable: - :ref:`bool` **input_pickable** @@ -112,115 +112,115 @@ If ``true`` this object is pickable. A pickable object can detect the mouse poin Method Descriptions ------------------- - .. _class_CollisionObject2D__input_event: +.. _class_CollisionObject2D__input_event: - 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. - .. _class_CollisionObject2D_create_shape_owner: +.. _class_CollisionObject2D_create_shape_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: +.. _class_CollisionObject2D_get_rid: - :ref:`RID` **get_rid** **(** **)** const Returns the object's :ref:`RID`. - .. _class_CollisionObject2D_get_shape_owners: +.. _class_CollisionObject2D_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. - .. _class_CollisionObject2D_is_shape_owner_disabled: +.. _class_CollisionObject2D_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const If ``true`` the shape owner and its shapes are disabled. - .. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: +.. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: - :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** const Returns ``true`` if collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. - .. _class_CollisionObject2D_remove_shape_owner: +.. _class_CollisionObject2D_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. - .. _class_CollisionObject2D_shape_find_owner: +.. _class_CollisionObject2D_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const Returns the ``owner_id`` of the given shape. - .. _class_CollisionObject2D_shape_owner_add_shape: +.. _class_CollisionObject2D_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** Adds a :ref:`Shape2D` to the shape owner. - .. _class_CollisionObject2D_shape_owner_clear_shapes: +.. _class_CollisionObject2D_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. - .. _class_CollisionObject2D_shape_owner_get_owner: +.. _class_CollisionObject2D_shape_owner_get_owner: - :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: +.. _class_CollisionObject2D_shape_owner_get_shape: - :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. - .. _class_CollisionObject2D_shape_owner_get_shape_count: +.. _class_CollisionObject2D_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns the number of shapes the given shape owner contains. - .. _class_CollisionObject2D_shape_owner_get_shape_index: +.. _class_CollisionObject2D_shape_owner_get_shape_index: - :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. - .. _class_CollisionObject2D_shape_owner_get_transform: +.. _class_CollisionObject2D_shape_owner_get_transform: - :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Returns the shape owner's :ref:`Transform2D`. - .. _class_CollisionObject2D_shape_owner_remove_shape: +.. _class_CollisionObject2D_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. - .. _class_CollisionObject2D_shape_owner_set_disabled: +.. _class_CollisionObject2D_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true`` disables the given shape owner. - .. _class_CollisionObject2D_shape_owner_set_one_way_collision: +.. _class_CollisionObject2D_shape_owner_set_one_way_collision: - void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** If ``enable`` is ``true``, collisions for the shape owner originating from this ``CollisionObject2D`` will not be reported to collided with ``CollisionObject2D``\ s. - .. _class_CollisionObject2D_shape_owner_set_transform: +.. _class_CollisionObject2D_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index d4c60046f..a94737564 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -35,7 +35,7 @@ Allows editing a collision polygon's vertices on a selected plane. Can also set Property Descriptions --------------------- - .. _class_CollisionPolygon_depth: +.. _class_CollisionPolygon_depth: - :ref:`float` **depth** @@ -47,7 +47,7 @@ Property Descriptions Length that the resulting collision extends in either direction perpendicular to its polygon. - .. _class_CollisionPolygon_disabled: +.. _class_CollisionPolygon_disabled: - :ref:`bool` **disabled** @@ -59,7 +59,7 @@ Length that the resulting collision extends in either direction perpendicular to If true, no collision will be produced. - .. _class_CollisionPolygon_polygon: +.. _class_CollisionPolygon_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 5a0b612f6..bcbe97155 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -32,7 +32,7 @@ Properties Enumerations ------------ - .. _enum_CollisionPolygon2D_BuildMode: +.. _enum_CollisionPolygon2D_BuildMode: enum **BuildMode**: @@ -47,7 +47,7 @@ Provides a 2D collision polygon to a :ref:`CollisionObject2D` **build_mode** @@ -59,7 +59,7 @@ Property Descriptions Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUILD_SOLIDS``. - .. _class_CollisionPolygon2D_disabled: +.. _class_CollisionPolygon2D_disabled: - :ref:`bool` **disabled** @@ -71,7 +71,7 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUI If ``true`` no collisions will be detected. - .. _class_CollisionPolygon2D_one_way_collision: +.. _class_CollisionPolygon2D_one_way_collision: - :ref:`bool` **one_way_collision** @@ -83,7 +83,7 @@ If ``true`` no collisions will be detected. If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. - .. _class_CollisionPolygon2D_polygon: +.. _class_CollisionPolygon2D_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 87403916f..fa5863578 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -43,10 +43,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_CollisionShape_disabled: +.. _class_CollisionShape_disabled: - :ref:`bool` **disabled** @@ -58,7 +59,7 @@ Property Descriptions A disabled collision shape has no effect in the world. - .. _class_CollisionShape_shape: +.. _class_CollisionShape_shape: - :ref:`Shape` **shape** @@ -73,13 +74,13 @@ The actual shape owned by this collision shape. Method Descriptions ------------------- - .. _class_CollisionShape_make_convex_from_brothers: +.. _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. - .. _class_CollisionShape_resource_changed: +.. _class_CollisionShape_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index bb1cf1201..c95e374d1 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -36,10 +36,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_CollisionShape2D_disabled: +.. _class_CollisionShape2D_disabled: - :ref:`bool` **disabled** @@ -51,7 +52,7 @@ Property Descriptions A disabled collision shape has no effect in the world. - .. _class_CollisionShape2D_one_way_collision: +.. _class_CollisionShape2D_one_way_collision: - :ref:`bool` **one_way_collision** @@ -63,7 +64,7 @@ A disabled collision shape has no effect in the world. Sets whether this collision shape should only detect collision on one side (top or bottom). - .. _class_CollisionShape2D_shape: +.. _class_CollisionShape2D_shape: - :ref:`Shape2D` **shape** diff --git a/classes/class_color.rst b/classes/class_color.rst index 24397cc9c..21bbc35f5 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -232,6 +232,7 @@ Constants - **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** - **yellow** = **Color( 1, 1, 0, 1 )** - **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** + Description ----------- @@ -242,67 +243,67 @@ You can also create a color from standardised color names with Color.ColorN (e.g Property Descriptions --------------------- - .. _class_Color_a: +.. _class_Color_a: - :ref:`float` **a** Alpha (0 to 1) - .. _class_Color_a8: +.. _class_Color_a8: - :ref:`int` **a8** Alpha (0 to 255) - .. _class_Color_b: +.. _class_Color_b: - :ref:`float` **b** Blue (0 to 1) - .. _class_Color_b8: +.. _class_Color_b8: - :ref:`int` **b8** Blue (0 to 255) - .. _class_Color_g: +.. _class_Color_g: - :ref:`float` **g** Green (0 to 1) - .. _class_Color_g8: +.. _class_Color_g8: - :ref:`int` **g8** Green (0 to 255) - .. _class_Color_h: +.. _class_Color_h: - :ref:`float` **h** Hue (0 to 1) - .. _class_Color_r: +.. _class_Color_r: - :ref:`float` **r** Red (0 to 1) - .. _class_Color_r8: +.. _class_Color_r8: - :ref:`int` **r8** Red (0 to 255) - .. _class_Color_s: +.. _class_Color_s: - :ref:`float` **s** Saturation (0 to 1) - .. _class_Color_v: +.. _class_Color_v: - :ref:`float` **v** @@ -311,7 +312,7 @@ Value (0 to 1) Method Descriptions ------------------- - .. _class_Color_Color: +.. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`String` from **)** @@ -335,7 +336,7 @@ The following string formats are supported: var c3 = Color("#b2d90a") # RGB format with '#' var c4 = Color("b2d90a") # RGB format - .. _class_Color_Color: +.. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`int` from **)** @@ -345,7 +346,7 @@ Constructs a color from a 32-bit integer (each byte represents a component of th var c = Color(274) # a color of an RGBA(0, 0, 1, 18) - .. _class_Color_Color: +.. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** @@ -355,7 +356,7 @@ Constructs a color from an RGB profile using values between 0 and 1 (float). Alp var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) - .. _class_Color_Color: +.. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** @@ -365,7 +366,7 @@ Constructs a color from an RGBA profile using values between 0 and 1 (float). var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) - .. _class_Color_blend: +.. _class_Color_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** @@ -377,7 +378,7 @@ Returns a new color resulting from blending this color over another color. If th var fg = Color(1.0, 0.0, 0.0, .5) # Red with alpha of 50% var blendedColor = bg.blend(fg) # Brown with alpha of 75% - .. _class_Color_contrasted: +.. _class_Color_contrasted: - :ref:`Color` **contrasted** **(** **)** @@ -388,7 +389,7 @@ Returns the most contrasting color. var c = Color(.3, .4, .9) var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255) - .. _class_Color_darkened: +.. _class_Color_darkened: - :ref:`Color` **darkened** **(** :ref:`float` amount **)** @@ -399,7 +400,7 @@ Returns a new color resulting from making this color darker by the specified per var green = Color(0.0, 1.0, 0.0) var darkgreen = green.darkened(0.2) # 20% darker than regular green - .. _class_Color_from_hsv: +.. _class_Color_from_hsv: - :ref:`Color` **from_hsv** **(** :ref:`float` h, :ref:`float` s, :ref:`float` v, :ref:`float` a=1 **)** @@ -409,7 +410,7 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8) - .. _class_Color_gray: +.. _class_Color_gray: - :ref:`float` **gray** **(** **)** @@ -422,7 +423,7 @@ The gray is calculated by (r + g + b) / 3. var c = Color(0.2, 0.45, 0.82) var gray = c.gray() # a value of 0.466667 - .. _class_Color_inverted: +.. _class_Color_inverted: - :ref:`Color` **inverted** **(** **)** @@ -433,7 +434,7 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a). var c = Color(.3, .4, .9) var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255) - .. _class_Color_lightened: +.. _class_Color_lightened: - :ref:`Color` **lightened** **(** :ref:`float` amount **)** @@ -444,7 +445,7 @@ Returns a new color resulting from making this color lighter by the specified pe var green = Color(0.0, 1.0, 0.0) var lightgreen = green.lightened(0.2) # 20% lighter than regular green - .. _class_Color_linear_interpolate: +.. _class_Color_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** @@ -456,7 +457,7 @@ Returns the color of the linear interpolation with another color. The value t is var c2 = Color(0.0, 1.0, 0.0) var li_c = c1.linear_interpolate(c2, 0.5) # a color of an RGBA(128, 128, 0, 255) - .. _class_Color_to_abgr32: +.. _class_Color_to_abgr32: - :ref:`int` **to_abgr32** **(** **)** @@ -467,7 +468,7 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_abgr32()) # Prints 4281565439 - .. _class_Color_to_abgr64: +.. _class_Color_to_abgr64: - :ref:`int` **to_abgr64** **(** **)** @@ -478,7 +479,7 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon var c = Color(1, .5, .2) print(c.to_abgr64()) # Prints -225178692812801 - .. _class_Color_to_argb32: +.. _class_Color_to_argb32: - :ref:`int` **to_argb32** **(** **)** @@ -489,7 +490,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_argb32()) # Prints 4294934323 - .. _class_Color_to_argb64: +.. _class_Color_to_argb64: - :ref:`int` **to_argb64** **(** **)** @@ -500,7 +501,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon var c = Color(1, .5, .2) print(c.to_argb64()) # Prints -2147470541 - .. _class_Color_to_html: +.. _class_Color_to_html: - :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** @@ -514,7 +515,7 @@ Optionally flag 'false' to not include alpha in hexadecimal string. var s1 = c.to_html() # Results "7fffffff" var s2 = c.to_html(false) # Results 'ffffff' - .. _class_Color_to_rgba32: +.. _class_Color_to_rgba32: - :ref:`int` **to_rgba32** **(** **)** @@ -525,7 +526,7 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon var c = Color(1, .5, .2) print(c.to_rgba32()) # Prints 4286526463 - .. _class_Color_to_rgba64: +.. _class_Color_to_rgba64: - :ref:`int` **to_rgba64** **(** **)** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 8a7730aeb..e8f241439 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -64,7 +64,7 @@ Theme Properties Signals ------- - .. _class_ColorPicker_color_changed: +.. _class_ColorPicker_color_changed: - **color_changed** **(** :ref:`Color` color **)** @@ -78,7 +78,7 @@ Description Property Descriptions --------------------- - .. _class_ColorPicker_color: +.. _class_ColorPicker_color: - :ref:`Color` **color** @@ -90,7 +90,7 @@ Property Descriptions The currently selected color. - .. _class_ColorPicker_deferred_mode: +.. _class_ColorPicker_deferred_mode: - :ref:`bool` **deferred_mode** @@ -102,7 +102,7 @@ The currently selected color. If ``true`` the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). - .. _class_ColorPicker_edit_alpha: +.. _class_ColorPicker_edit_alpha: - :ref:`bool` **edit_alpha** @@ -114,7 +114,7 @@ If ``true`` the color will apply only after the user releases the mouse button, If ``true`` shows an alpha channel slider (transparency). - .. _class_ColorPicker_raw_mode: +.. _class_ColorPicker_raw_mode: - :ref:`bool` **raw_mode** @@ -129,7 +129,7 @@ If ``true`` allows the color R, G, B component values to go beyond 1.0, which ca Method Descriptions ------------------- - .. _class_ColorPicker_add_preset: +.. _class_ColorPicker_add_preset: - void **add_preset** **(** :ref:`Color` color **)** diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index b40ffd69a..8693cd76f 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -66,13 +66,13 @@ Theme Properties Signals ------- - .. _class_ColorPickerButton_color_changed: +.. _class_ColorPickerButton_color_changed: - **color_changed** **(** :ref:`Color` color **)** Emitted when the color changes. - .. _class_ColorPickerButton_popup_closed: +.. _class_ColorPickerButton_popup_closed: - **popup_closed** **(** **)** @@ -84,7 +84,7 @@ Encapsulates a :ref:`ColorPicker` making it accessible by pre Property Descriptions --------------------- - .. _class_ColorPickerButton_color: +.. _class_ColorPickerButton_color: - :ref:`Color` **color** @@ -96,7 +96,7 @@ Property Descriptions The currently selected color. - .. _class_ColorPickerButton_edit_alpha: +.. _class_ColorPickerButton_edit_alpha: - :ref:`bool` **edit_alpha** @@ -111,13 +111,13 @@ If ``true`` the alpha channel in the displayed :ref:`ColorPicker` **get_picker** **(** **)** Returns the :ref:`ColorPicker` that this node toggles. - .. _class_ColorPickerButton_get_popup: +.. _class_ColorPickerButton_get_popup: - :ref:`PopupPanel` **get_popup** **(** **)** diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 77d2833a9..946e7b155 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -31,7 +31,7 @@ Displays a colored rectangle. Property Descriptions --------------------- - .. _class_ColorRect_color: +.. _class_ColorRect_color: - :ref:`Color` **color** diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 2cc2bcffe..dfb1c6bf9 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -33,13 +33,13 @@ Concave polygon shape resource, which can be set into a :ref:`PhysicsBody` **get_faces** **(** **)** const Return the faces (an array of triangles). - .. _class_ConcavePolygonShape_set_faces: +.. _class_ConcavePolygonShape_set_faces: - void **set_faces** **(** :ref:`PoolVector3Array` faces **)** diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 2d9e447cc..aea8f13fd 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -33,7 +33,7 @@ The main difference between a :ref:`ConvexPolygonShape2D` **segments** diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 964af42f8..9acd9eb5a 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -34,7 +34,7 @@ Properties Enumerations ------------ - .. _enum_ConeTwistJoint_Param: +.. _enum_ConeTwistJoint_Param: enum **Param**: @@ -67,7 +67,7 @@ Once the Bodies swing, the twist axis is calculated as the middle of the x-axes Property Descriptions --------------------- - .. _class_ConeTwistJoint_bias: +.. _class_ConeTwistJoint_bias: - :ref:`float` **bias** @@ -81,7 +81,7 @@ The speed with which the swing or twist will take place. The higher, the faster. - .. _class_ConeTwistJoint_relaxation: +.. _class_ConeTwistJoint_relaxation: - :ref:`float` **relaxation** @@ -93,7 +93,7 @@ The higher, the faster. Defines, how fast the swing- and twist-speed-difference on both sides gets synced. - .. _class_ConeTwistJoint_softness: +.. _class_ConeTwistJoint_softness: - :ref:`float` **softness** @@ -105,7 +105,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synce The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. - .. _class_ConeTwistJoint_swing_span: +.. _class_ConeTwistJoint_swing_span: - :ref:`float` **swing_span** @@ -117,7 +117,7 @@ Could be defined as looseness in the ``ConeTwistJoint``. If below 0.05, this behaviour is locked. Default value: ``PI/4``. - .. _class_ConeTwistJoint_twist_span: +.. _class_ConeTwistJoint_twist_span: - :ref:`float` **twist_span** diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 7b4a4cdc0..6ddb8f605 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -61,7 +61,7 @@ The following example shows how to parse an INI-style file from the system, read var err = config.load("user://settings.cfg") if err == OK: # if not, something went wrong with the file loading # Look for the display/width pair, and default to 1024 if missing - var screen_width = get_value("display", "width", 1024) + var screen_width = config.get_value("display", "width", 1024) # Store a variable if and only if it hasn't been defined yet if not config.has_section_key("audio", "mute"): config.set_value("audio", "mute", false) @@ -71,55 +71,55 @@ The following example shows how to parse an INI-style file from the system, read Method Descriptions ------------------- - .. _class_ConfigFile_erase_section: +.. _class_ConfigFile_erase_section: - void **erase_section** **(** :ref:`String` section **)** Deletes the specified section along with all the key-value pairs inside. - .. _class_ConfigFile_get_section_keys: +.. _class_ConfigFile_get_section_keys: - :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: +.. _class_ConfigFile_get_sections: - :ref:`PoolStringArray` **get_sections** **(** **)** const Returns an array of all defined section identifiers. - .. _class_ConfigFile_get_value: +.. _class_ConfigFile_get_value: - :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: +.. _class_ConfigFile_has_section: - :ref:`bool` **has_section** **(** :ref:`String` section **)** const Returns ``true`` if the specified section exists. - .. _class_ConfigFile_has_section_key: +.. _class_ConfigFile_has_section_key: - :ref:`bool` **has_section_key** **(** :ref:`String` section, :ref:`String` key **)** const Returns ``true`` if the specified section-key pair exists. - .. _class_ConfigFile_load: +.. _class_ConfigFile_load: - :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``. - .. _class_ConfigFile_save: +.. _class_ConfigFile_save: - :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``. - .. _class_ConfigFile_set_value: +.. _class_ConfigFile_set_value: - void **set_value** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` value **)** diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 821a184f2..e2318d41a 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -33,7 +33,7 @@ Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog Method Descriptions ------------------- - .. _class_ConfirmationDialog_get_cancel: +.. _class_ConfirmationDialog_get_cancel: - :ref:`Button` **get_cancel** **(** **)** diff --git a/classes/class_container.rst b/classes/class_container.rst index 933eafe22..c44068c1c 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -30,7 +30,7 @@ Methods Signals ------- - .. _class_Container_sort_children: +.. _class_Container_sort_children: - **sort_children** **(** **)** @@ -40,6 +40,7 @@ Constants --------- - **NOTIFICATION_SORT_CHILDREN** = **50** --- Notification for when sorting the children, it must be obeyed immediately. + Description ----------- @@ -50,13 +51,13 @@ A Control can inherit this to create custom container classes. Method Descriptions ------------------- - .. _class_Container_fit_child_in_rect: +.. _class_Container_fit_child_in_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. - .. _class_Container_queue_sort: +.. _class_Container_queue_sort: - void **queue_sort** **(** **)** diff --git a/classes/class_control.rst b/classes/class_control.rst index 8432603ea..020581f66 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -217,55 +217,55 @@ Methods Signals ------- - .. _class_Control_focus_entered: +.. _class_Control_focus_entered: - **focus_entered** **(** **)** Emitted when the node gains keyboard focus. - .. _class_Control_focus_exited: +.. _class_Control_focus_exited: - **focus_exited** **(** **)** Emitted when the node loses keyboard focus. - .. _class_Control_gui_input: +.. _class_Control_gui_input: - **gui_input** **(** :ref:`InputEvent` event **)** Emitted when the node receives an :ref:`InputEvent`. - .. _class_Control_minimum_size_changed: +.. _class_Control_minimum_size_changed: - **minimum_size_changed** **(** **)** Emitted when the node's minimum size changes. - .. _class_Control_modal_closed: +.. _class_Control_modal_closed: - **modal_closed** **(** **)** Emitted when a modal ``Control`` is closed. See :ref:`show_modal`. - .. _class_Control_mouse_entered: +.. _class_Control_mouse_entered: - **mouse_entered** **(** **)** Emitted when the mouse enters the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. - .. _class_Control_mouse_exited: +.. _class_Control_mouse_exited: - **mouse_exited** **(** **)** Emitted when the mouse leaves the control's ``Rect`` area, provided its :ref:`mouse_filter` lets the event reach it. - .. _class_Control_resized: +.. _class_Control_resized: - **resized** **(** **)** Emitted when the control changes size. - .. _class_Control_size_flags_changed: +.. _class_Control_size_flags_changed: - **size_flags_changed** **(** **)** @@ -274,7 +274,7 @@ Emitted when one of the size flags changes. See :ref:`size_flags_horizontal` 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: +.. _enum_Control_CursorShape: enum **CursorShape**: @@ -306,7 +306,7 @@ enum **CursorShape**: - **CURSOR_HSPLIT** = **15** --- Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as ``CURSOR_HSIZE``. - **CURSOR_HELP** = **16** --- Show the system's help mouse cursor when the user hovers the node, a question mark. - .. _enum_Control_FocusMode: +.. _enum_Control_FocusMode: enum **FocusMode**: @@ -314,7 +314,7 @@ enum **FocusMode**: - **FOCUS_CLICK** = **1** --- The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. - **FOCUS_ALL** = **2** --- The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with :ref:`focus_mode`. - .. _enum_Control_GrowDirection: +.. _enum_Control_GrowDirection: enum **GrowDirection**: @@ -322,7 +322,7 @@ enum **GrowDirection**: - **GROW_DIRECTION_END** = **1** - **GROW_DIRECTION_BOTH** = **2** - .. _enum_Control_LayoutPresetMode: +.. _enum_Control_LayoutPresetMode: enum **LayoutPresetMode**: @@ -331,7 +331,7 @@ enum **LayoutPresetMode**: - **PRESET_MODE_KEEP_HEIGHT** = **2** - **PRESET_MODE_KEEP_SIZE** = **3** - .. _enum_Control_LayoutPreset: +.. _enum_Control_LayoutPreset: enum **LayoutPreset**: @@ -352,7 +352,7 @@ enum **LayoutPreset**: - **PRESET_HCENTER_WIDE** = **14** --- Snap all 4 anchors to a horizontal line that cuts the parent container in half. Use with :ref:`set_anchors_preset`. - **PRESET_WIDE** = **15** --- Snap all 4 anchors to the respective corners of the parent container. Set all 4 margins to 0 after you applied this preset and the ``Control`` will fit its parent container. Use with :ref:`set_anchors_preset`. - .. _enum_Control_MouseFilter: +.. _enum_Control_MouseFilter: enum **MouseFilter**: @@ -360,7 +360,7 @@ enum **MouseFilter**: - **MOUSE_FILTER_PASS** = **1** --- The control will receive mouse button input events through :ref:`_gui_input` if clicked on. If this control does not handle the event, the parent control (if any) will be considered for a mouse click, and so on until there is no more parent control to potentially handle it. Even if no control handled it at all, the event will still be handled automatically. - **MOUSE_FILTER_IGNORE** = **2** --- The control will not receive mouse button input events through :ref:`_gui_input` and will not block other controls from receiving these events. These events will also not be handled automatically. - .. _enum_Control_Anchor: +.. _enum_Control_Anchor: enum **Anchor**: @@ -379,6 +379,7 @@ Constants - **NOTIFICATION_MODAL_CLOSE** = **46** --- Sent when an open modal dialog closes. See :ref:`show_modal`. - **NOTIFICATION_SCROLL_BEGIN** = **47** - **NOTIFICATION_SCROLL_END** = **48** + Description ----------- @@ -400,11 +401,13 @@ Tutorials --------- - :doc:`../tutorials/gui/index` + - :doc:`../tutorials/2d/custom_drawing_in_2d` + Property Descriptions --------------------- - .. _class_Control_anchor_bottom: +.. _class_Control_anchor_bottom: - :ref:`float` **anchor_bottom** @@ -414,7 +417,7 @@ Property Descriptions 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: +.. _class_Control_anchor_left: - :ref:`float` **anchor_left** @@ -424,7 +427,7 @@ Anchors the bottom edge of the node to the origin, the center, or the end of its 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: +.. _class_Control_anchor_right: - :ref:`float` **anchor_right** @@ -434,7 +437,7 @@ Anchors the left edge of the node to the origin, the center or the end of its pa 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: +.. _class_Control_anchor_top: - :ref:`float` **anchor_top** @@ -444,7 +447,7 @@ Anchors the right edge of the node to the origin, the center or the end of its p 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: +.. _class_Control_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -456,7 +459,7 @@ Anchors the top edge of the node to the origin, the center or the end of its par 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: +.. _class_Control_focus_neighbour_bottom: - :ref:`NodePath` **focus_neighbour_bottom** @@ -470,7 +473,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Tab, 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: +.. _class_Control_focus_neighbour_left: - :ref:`NodePath` **focus_neighbour_left** @@ -482,7 +485,7 @@ If the user presses Tab, Godot will give focus to the closest node to the right 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: +.. _class_Control_focus_neighbour_right: - :ref:`NodePath` **focus_neighbour_right** @@ -494,7 +497,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif 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: +.. _class_Control_focus_neighbour_top: - :ref:`NodePath` **focus_neighbour_top** @@ -506,7 +509,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Tab, 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: +.. _class_Control_focus_next: - :ref:`NodePath` **focus_next** @@ -516,7 +519,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif | *Getter* | get_focus_next() | +----------+-----------------------+ - .. _class_Control_focus_previous: +.. _class_Control_focus_previous: - :ref:`NodePath` **focus_previous** @@ -526,7 +529,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif | *Getter* | get_focus_previous() | +----------+---------------------------+ - .. _class_Control_grow_horizontal: +.. _class_Control_grow_horizontal: - :ref:`GrowDirection` **grow_horizontal** @@ -536,7 +539,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif | *Getter* | get_h_grow_direction() | +----------+-----------------------------+ - .. _class_Control_grow_vertical: +.. _class_Control_grow_vertical: - :ref:`GrowDirection` **grow_vertical** @@ -546,7 +549,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif | *Getter* | get_v_grow_direction() | +----------+-----------------------------+ - .. _class_Control_hint_tooltip: +.. _class_Control_hint_tooltip: - :ref:`String` **hint_tooltip** @@ -556,7 +559,7 @@ Tells Godot which node it should give keyboard focus to if the user presses Shif 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: +.. _class_Control_margin_bottom: - :ref:`float` **margin_bottom** @@ -570,7 +573,7 @@ Distance between the node's bottom edge and its parent container, based on :ref: 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: +.. _class_Control_margin_left: - :ref:`float` **margin_left** @@ -582,7 +585,7 @@ Margins are often controlled by one or multiple parent :ref:`Container`. - .. _class_Control_margin_right: +.. _class_Control_margin_right: - :ref:`float` **margin_right** @@ -594,7 +597,7 @@ Distance between the node's left edge and its parent container, based on :ref:`a Distance between the node's right edge and its parent container, based on :ref:`anchor_right`. - .. _class_Control_margin_top: +.. _class_Control_margin_top: - :ref:`float` **margin_top** @@ -606,7 +609,7 @@ Distance between the node's right edge and its parent container, based on :ref:` Distance between the node's top edge and its parent container, based on :ref:`anchor_top`. - .. _class_Control_mouse_default_cursor_shape: +.. _class_Control_mouse_default_cursor_shape: - :ref:`CursorShape` **mouse_default_cursor_shape** @@ -620,7 +623,7 @@ The default cursor shape for this control. Useful for Godot plugins and applicat **Note:** On Linux, shapes may vary depending on the cursor theme of the system. - .. _class_Control_mouse_filter: +.. _class_Control_mouse_filter: - :ref:`MouseFilter` **mouse_filter** @@ -632,7 +635,7 @@ The default cursor shape for this control. Useful for Godot plugins and applicat 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: +.. _class_Control_rect_clip_content: - :ref:`bool` **rect_clip_content** @@ -642,7 +645,7 @@ Controls whether the control will be able to receive mouse button input events t | *Getter* | is_clipping_contents() | +----------+--------------------------+ - .. _class_Control_rect_global_position: +.. _class_Control_rect_global_position: - :ref:`Vector2` **rect_global_position** @@ -654,7 +657,7 @@ Controls whether the control will be able to receive mouse button input events t The node's global position, relative to the world (usually to the top-left corner of the window). - .. _class_Control_rect_min_size: +.. _class_Control_rect_min_size: - :ref:`Vector2` **rect_min_size** @@ -666,7 +669,7 @@ The node's global position, relative to the world (usually to the top-left corne 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: +.. _class_Control_rect_pivot_offset: - :ref:`Vector2` **rect_pivot_offset** @@ -678,7 +681,7 @@ The minimum size of the node's bounding rectangle. If you set it to a value grea 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: +.. _class_Control_rect_position: - :ref:`Vector2` **rect_position** @@ -690,7 +693,7 @@ By default, the node's pivot is its top-left corner. When you change its :ref:`r 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: +.. _class_Control_rect_rotation: - :ref:`float` **rect_rotation** @@ -702,7 +705,7 @@ The node's position, relative to its parent. It corresponds to the rectangle's t The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset` to change the pivot's position. - .. _class_Control_rect_scale: +.. _class_Control_rect_scale: - :ref:`Vector2` **rect_scale** @@ -714,7 +717,7 @@ The node's rotation around its pivot, in degrees. See :ref:`rect_pivot_offset`. Change this property to scale the node around its :ref:`rect_pivot_offset`. - .. _class_Control_rect_size: +.. _class_Control_rect_size: - :ref:`Vector2` **rect_size** @@ -726,7 +729,7 @@ The node's scale, relative to its :ref:`rect_size`. Cha The size of the node's bounding rectangle, in pixels. :ref:`Container` nodes update this property automatically. - .. _class_Control_size_flags_horizontal: +.. _class_Control_size_flags_horizontal: - :ref:`int` **size_flags_horizontal** @@ -738,7 +741,7 @@ The size of the node's bounding rectangle, in pixels. :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: +.. _class_Control_size_flags_stretch_ratio: - :ref:`float` **size_flags_stretch_ratio** @@ -750,7 +753,7 @@ Tells the parent :ref:`Container` nodes how they should resize 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: +.. _class_Control_size_flags_vertical: - :ref:`int` **size_flags_vertical** @@ -762,7 +765,7 @@ If the node and at least one of its neighbours uses the ``SIZE_EXPAND`` size fla 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: +.. _class_Control_theme: - :ref:`Theme` **theme** @@ -777,17 +780,17 @@ Changing this property replaces the current :ref:`Theme` resource t Method Descriptions ------------------- - .. _class_Control__clips_input: +.. _class_Control__clips_input: - :ref:`bool` **_clips_input** **(** **)** virtual - .. _class_Control__get_minimum_size: +.. _class_Control__get_minimum_size: - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual Returns the minimum size for this control. See :ref:`rect_min_size`. - .. _class_Control__gui_input: +.. _class_Control__gui_input: - void **_gui_input** **(** :ref:`InputEvent` event **)** virtual @@ -795,53 +798,53 @@ Use this method to process and accept inputs on UI elements. See :ref:`accept_ev Replaces Godot 2's ``_input_event``. - .. _class_Control__make_custom_tooltip: +.. _class_Control__make_custom_tooltip: - :ref:`Object` **_make_custom_tooltip** **(** :ref:`String` for_text **)** virtual - .. _class_Control_accept_event: +.. _class_Control_accept_event: - void **accept_event** **(** **)** Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. - .. _class_Control_add_color_override: +.. _class_Control_add_color_override: - 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: +.. _class_Control_add_constant_override: - 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: +.. _class_Control_add_font_override: - 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: +.. _class_Control_add_icon_override: - 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: +.. _class_Control_add_shader_override: - 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: +.. _class_Control_add_stylebox_override: - 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: +.. _class_Control_can_drop_data: - :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -858,7 +861,7 @@ This method should only be used to test the data. Process the data in :ref:`drop # otherwise just check data return typeof(data) == TYPE_DICTIONARY and data.has('expected') - .. _class_Control_drop_data: +.. _class_Control_drop_data: - void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual @@ -874,7 +877,7 @@ Godot calls this method to pass you the ``data`` from a control's :ref:`get_drag func drop_data(position, data): color = data['color'] - .. _class_Control_force_drag: +.. _class_Control_force_drag: - void **force_drag** **(** :ref:`Variant` data, :ref:`Control` preview **)** @@ -882,31 +885,31 @@ Forces drag and bypasses :ref:`get_drag_data` and : The methods :ref:`can_drop_data` and :ref:`drop_data` must be implemented on controls that want to receive drop data. - .. _class_Control_get_begin: +.. _class_Control_get_begin: - :ref:`Vector2` **get_begin** **(** **)** const Returns :ref:`margin_left` and :ref:`margin_top`. See also :ref:`rect_position`. - .. _class_Control_get_color: +.. _class_Control_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_get_combined_minimum_size: +.. _class_Control_get_combined_minimum_size: - :ref:`Vector2` **get_combined_minimum_size** **(** **)** const - .. _class_Control_get_constant: +.. _class_Control_get_constant: - :ref:`int` **get_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_get_cursor_shape: +.. _class_Control_get_cursor_shape: - :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`. - .. _class_Control_get_drag_data: +.. _class_Control_get_drag_data: - :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual @@ -923,169 +926,169 @@ A preview that will follow the mouse that should represent the data can be set w set_drag_preview(make_preview(mydata)) return mydata - .. _class_Control_get_end: +.. _class_Control_get_end: - :ref:`Vector2` **get_end** **(** **)** const Returns :ref:`margin_right` and :ref:`margin_bottom`. - .. _class_Control_get_focus_owner: +.. _class_Control_get_focus_owner: - :ref:`Control` **get_focus_owner** **(** **)** const Returns the control that has the keyboard focus or ``null`` if none. - .. _class_Control_get_font: +.. _class_Control_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_get_global_rect: +.. _class_Control_get_global_rect: - :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: +.. _class_Control_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_get_minimum_size: +.. _class_Control_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Returns the minimum size for this control. See :ref:`rect_min_size`. - .. _class_Control_get_parent_area_size: +.. _class_Control_get_parent_area_size: - :ref:`Vector2` **get_parent_area_size** **(** **)** const Returns the width/height occupied in the parent control. - .. _class_Control_get_parent_control: +.. _class_Control_get_parent_control: - :ref:`Control` **get_parent_control** **(** **)** const Returns the parent control node. - .. _class_Control_get_rect: +.. _class_Control_get_rect: - :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`. - .. _class_Control_get_rotation: +.. _class_Control_get_rotation: - :ref:`float` **get_rotation** **(** **)** const Returns the rotation (in radians). - .. _class_Control_get_stylebox: +.. _class_Control_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_get_tooltip: +.. _class_Control_get_tooltip: - :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. - .. _class_Control_grab_click_focus: +.. _class_Control_grab_click_focus: - void **grab_click_focus** **(** **)** - .. _class_Control_grab_focus: +.. _class_Control_grab_focus: - void **grab_focus** **(** **)** Steal the focus from another control and become the focused control (see :ref:`set_focus_mode`). - .. _class_Control_has_color: +.. _class_Control_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_has_color_override: +.. _class_Control_has_color_override: - :ref:`bool` **has_color_override** **(** :ref:`String` name **)** const - .. _class_Control_has_constant: +.. _class_Control_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_has_constant_override: +.. _class_Control_has_constant_override: - :ref:`bool` **has_constant_override** **(** :ref:`String` name **)** const - .. _class_Control_has_focus: +.. _class_Control_has_focus: - :ref:`bool` **has_focus** **(** **)** const Returns ``true`` if this is the current focused control. See :ref:`focus_mode`. - .. _class_Control_has_font: +.. _class_Control_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_has_font_override: +.. _class_Control_has_font_override: - :ref:`bool` **has_font_override** **(** :ref:`String` name **)** const - .. _class_Control_has_icon: +.. _class_Control_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_has_icon_override: +.. _class_Control_has_icon_override: - :ref:`bool` **has_icon_override** **(** :ref:`String` name **)** const - .. _class_Control_has_point: +.. _class_Control_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** virtual - .. _class_Control_has_shader_override: +.. _class_Control_has_shader_override: - :ref:`bool` **has_shader_override** **(** :ref:`String` name **)** const - .. _class_Control_has_stylebox: +.. _class_Control_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type="" **)** const - .. _class_Control_has_stylebox_override: +.. _class_Control_has_stylebox_override: - :ref:`bool` **has_stylebox_override** **(** :ref:`String` name **)** const - .. _class_Control_minimum_size_changed: +.. _class_Control_minimum_size_changed: - void **minimum_size_changed** **(** **)** - .. _class_Control_release_focus: +.. _class_Control_release_focus: - void **release_focus** **(** **)** Give up the focus. No other control will be able to receive keyboard input. - .. _class_Control_set_anchor: +.. _class_Control_set_anchor: - 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: +.. _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 **)** - .. _class_Control_set_anchors_and_margins_preset: +.. _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 **)** - .. _class_Control_set_anchors_preset: +.. _class_Control_set_anchors_preset: - void **set_anchors_preset** **(** :ref:`LayoutPreset` preset, :ref:`bool` keep_margin=false **)** - .. _class_Control_set_begin: +.. _class_Control_set_begin: - void **set_begin** **(** :ref:`Vector2` position **)** Sets :ref:`margin_left` and :ref:`margin_top` at the same time. - .. _class_Control_set_drag_forwarding: +.. _class_Control_set_drag_forwarding: - void **set_drag_forwarding** **(** :ref:`Control` target **)** @@ -1116,35 +1119,35 @@ Forwarding can be implemented in the target control similar to the methods :ref: set_drag_preview(my_preview) return my_data() - .. _class_Control_set_drag_preview: +.. _class_Control_set_drag_preview: - 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: +.. _class_Control_set_end: - void **set_end** **(** :ref:`Vector2` position **)** Sets :ref:`margin_right` and :ref:`margin_bottom` at the same time. - .. _class_Control_set_margins_preset: +.. _class_Control_set_margins_preset: - void **set_margins_preset** **(** :ref:`LayoutPreset` preset, :ref:`LayoutPresetMode` resize_mode=0, :ref:`int` margin=0 **)** - .. _class_Control_set_rotation: +.. _class_Control_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** Sets the rotation (in radians). - .. _class_Control_show_modal: +.. _class_Control_show_modal: - void **show_modal** **(** :ref:`bool` exclusive=false **)** Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. - .. _class_Control_warp_mouse: +.. _class_Control_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index b24a35b66..5faad0172 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -31,7 +31,7 @@ Convex polygon shape resource, which can be added to a :ref:`PhysicsBody` **points** diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 95beb184e..32b4ab817 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -40,7 +40,7 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo Property Descriptions --------------------- - .. _class_ConvexPolygonShape2D_points: +.. _class_ConvexPolygonShape2D_points: - :ref:`PoolVector2Array` **points** @@ -55,7 +55,7 @@ The polygon's list of vertices. Can be in either clockwise or counterclockwise o Method Descriptions ------------------- - .. _class_ConvexPolygonShape2D_set_point_cloud: +.. _class_ConvexPolygonShape2D_set_point_cloud: - void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** diff --git a/classes/class_cpuparticles.rst b/classes/class_cpuparticles.rst index 8100ec7a4..be8e019eb 100644 --- a/classes/class_cpuparticles.rst +++ b/classes/class_cpuparticles.rst @@ -153,7 +153,7 @@ Methods Enumerations ------------ - .. _enum_CPUParticles_Flags: +.. _enum_CPUParticles_Flags: enum **Flags**: @@ -161,7 +161,7 @@ enum **Flags**: - **FLAG_ROTATE_Y** = **1** - **FLAG_MAX** = **4** - .. _enum_CPUParticles_Parameter: +.. _enum_CPUParticles_Parameter: enum **Parameter**: @@ -178,7 +178,7 @@ enum **Parameter**: - **PARAM_ANIM_OFFSET** = **10** - **PARAM_MAX** = **11** - .. _enum_CPUParticles_EmissionShape: +.. _enum_CPUParticles_EmissionShape: enum **EmissionShape**: @@ -188,7 +188,7 @@ enum **EmissionShape**: - **EMISSION_SHAPE_POINTS** = **3** - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** - .. _enum_CPUParticles_DrawOrder: +.. _enum_CPUParticles_DrawOrder: enum **DrawOrder**: @@ -199,7 +199,7 @@ enum **DrawOrder**: Property Descriptions --------------------- - .. _class_CPUParticles_amount: +.. _class_CPUParticles_amount: - :ref:`int` **amount** @@ -209,7 +209,7 @@ Property Descriptions | *Getter* | get_amount() | +----------+-------------------+ - .. _class_CPUParticles_angle: +.. _class_CPUParticles_angle: - :ref:`float` **angle** @@ -219,7 +219,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_angle_curve: +.. _class_CPUParticles_angle_curve: - :ref:`Curve` **angle_curve** @@ -229,7 +229,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_angle_random: +.. _class_CPUParticles_angle_random: - :ref:`float` **angle_random** @@ -239,7 +239,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_angular_velocity: +.. _class_CPUParticles_angular_velocity: - :ref:`float` **angular_velocity** @@ -249,7 +249,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_angular_velocity_curve: +.. _class_CPUParticles_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -259,7 +259,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_angular_velocity_random: +.. _class_CPUParticles_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -269,7 +269,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_anim_loop: +.. _class_CPUParticles_anim_loop: - :ref:`bool` **anim_loop** @@ -279,7 +279,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles_anim_offset: +.. _class_CPUParticles_anim_offset: - :ref:`float` **anim_offset** @@ -289,7 +289,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_anim_offset_curve: +.. _class_CPUParticles_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -299,7 +299,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_anim_offset_random: +.. _class_CPUParticles_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -309,7 +309,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_anim_speed: +.. _class_CPUParticles_anim_speed: - :ref:`float` **anim_speed** @@ -319,7 +319,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_anim_speed_curve: +.. _class_CPUParticles_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -329,7 +329,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_anim_speed_random: +.. _class_CPUParticles_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -339,7 +339,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_color: +.. _class_CPUParticles_color: - :ref:`Color` **color** @@ -349,7 +349,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ - .. _class_CPUParticles_color_ramp: +.. _class_CPUParticles_color_ramp: - :ref:`Gradient` **color_ramp** @@ -359,7 +359,7 @@ Property Descriptions | *Getter* | get_color_ramp() | +----------+-----------------------+ - .. _class_CPUParticles_damping: +.. _class_CPUParticles_damping: - :ref:`float` **damping** @@ -369,7 +369,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_damping_curve: +.. _class_CPUParticles_damping_curve: - :ref:`Curve` **damping_curve** @@ -379,7 +379,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_damping_random: +.. _class_CPUParticles_damping_random: - :ref:`float` **damping_random** @@ -389,7 +389,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_draw_order: +.. _class_CPUParticles_draw_order: - :ref:`DrawOrder` **draw_order** @@ -399,7 +399,7 @@ Property Descriptions | *Getter* | get_draw_order() | +----------+-----------------------+ - .. _class_CPUParticles_emission_box_extents: +.. _class_CPUParticles_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -409,7 +409,7 @@ Property Descriptions | *Getter* | get_emission_box_extents() | +----------+---------------------------------+ - .. _class_CPUParticles_emission_colors: +.. _class_CPUParticles_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -419,7 +419,7 @@ Property Descriptions | *Getter* | get_emission_colors() | +----------+----------------------------+ - .. _class_CPUParticles_emission_normals: +.. _class_CPUParticles_emission_normals: - :ref:`PoolVector3Array` **emission_normals** @@ -429,7 +429,7 @@ Property Descriptions | *Getter* | get_emission_normals() | +----------+-----------------------------+ - .. _class_CPUParticles_emission_points: +.. _class_CPUParticles_emission_points: - :ref:`PoolVector3Array` **emission_points** @@ -439,7 +439,7 @@ Property Descriptions | *Getter* | get_emission_points() | +----------+----------------------------+ - .. _class_CPUParticles_emission_shape: +.. _class_CPUParticles_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -449,7 +449,7 @@ Property Descriptions | *Getter* | get_emission_shape() | +----------+---------------------------+ - .. _class_CPUParticles_emission_sphere_radius: +.. _class_CPUParticles_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -459,7 +459,7 @@ Property Descriptions | *Getter* | get_emission_sphere_radius() | +----------+-----------------------------------+ - .. _class_CPUParticles_emitting: +.. _class_CPUParticles_emitting: - :ref:`bool` **emitting** @@ -469,7 +469,7 @@ Property Descriptions | *Getter* | is_emitting() | +----------+---------------------+ - .. _class_CPUParticles_explosiveness: +.. _class_CPUParticles_explosiveness: - :ref:`float` **explosiveness** @@ -479,7 +479,7 @@ Property Descriptions | *Getter* | get_explosiveness_ratio() | +----------+--------------------------------+ - .. _class_CPUParticles_fixed_fps: +.. _class_CPUParticles_fixed_fps: - :ref:`int` **fixed_fps** @@ -489,7 +489,7 @@ Property Descriptions | *Getter* | get_fixed_fps() | +----------+----------------------+ - .. _class_CPUParticles_flag_align_y: +.. _class_CPUParticles_flag_align_y: - :ref:`bool` **flag_align_y** @@ -499,7 +499,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles_flag_disable_z: +.. _class_CPUParticles_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -509,7 +509,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles_flag_rotate_y: +.. _class_CPUParticles_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -519,7 +519,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles_flatness: +.. _class_CPUParticles_flatness: - :ref:`float` **flatness** @@ -529,7 +529,7 @@ Property Descriptions | *Getter* | get_flatness() | +----------+---------------------+ - .. _class_CPUParticles_fract_delta: +.. _class_CPUParticles_fract_delta: - :ref:`bool` **fract_delta** @@ -539,7 +539,7 @@ Property Descriptions | *Getter* | get_fractional_delta() | +----------+-----------------------------+ - .. _class_CPUParticles_gravity: +.. _class_CPUParticles_gravity: - :ref:`Vector3` **gravity** @@ -549,7 +549,7 @@ Property Descriptions | *Getter* | get_gravity() | +----------+--------------------+ - .. _class_CPUParticles_hue_variation: +.. _class_CPUParticles_hue_variation: - :ref:`float` **hue_variation** @@ -559,7 +559,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_hue_variation_curve: +.. _class_CPUParticles_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -569,7 +569,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_hue_variation_random: +.. _class_CPUParticles_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -579,7 +579,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_initial_velocity: +.. _class_CPUParticles_initial_velocity: - :ref:`float` **initial_velocity** @@ -589,7 +589,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_initial_velocity_random: +.. _class_CPUParticles_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -599,7 +599,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_lifetime: +.. _class_CPUParticles_lifetime: - :ref:`float` **lifetime** @@ -609,7 +609,7 @@ Property Descriptions | *Getter* | get_lifetime() | +----------+---------------------+ - .. _class_CPUParticles_linear_accel: +.. _class_CPUParticles_linear_accel: - :ref:`float` **linear_accel** @@ -619,7 +619,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_linear_accel_curve: +.. _class_CPUParticles_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -629,7 +629,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_linear_accel_random: +.. _class_CPUParticles_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -639,7 +639,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_local_coords: +.. _class_CPUParticles_local_coords: - :ref:`bool` **local_coords** @@ -649,7 +649,7 @@ Property Descriptions | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ - .. _class_CPUParticles_mesh: +.. _class_CPUParticles_mesh: - :ref:`Mesh` **mesh** @@ -659,7 +659,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ - .. _class_CPUParticles_one_shot: +.. _class_CPUParticles_one_shot: - :ref:`bool` **one_shot** @@ -669,7 +669,7 @@ Property Descriptions | *Getter* | get_one_shot() | +----------+---------------------+ - .. _class_CPUParticles_preprocess: +.. _class_CPUParticles_preprocess: - :ref:`float` **preprocess** @@ -679,7 +679,7 @@ Property Descriptions | *Getter* | get_pre_process_time() | +----------+-----------------------------+ - .. _class_CPUParticles_radial_accel: +.. _class_CPUParticles_radial_accel: - :ref:`float` **radial_accel** @@ -689,7 +689,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_radial_accel_curve: +.. _class_CPUParticles_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -699,7 +699,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_radial_accel_random: +.. _class_CPUParticles_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -709,7 +709,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_randomness: +.. _class_CPUParticles_randomness: - :ref:`float` **randomness** @@ -719,7 +719,7 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ - .. _class_CPUParticles_scale: +.. _class_CPUParticles_scale: - :ref:`float` **scale** @@ -729,7 +729,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_scale_curve: +.. _class_CPUParticles_scale_curve: - :ref:`Curve` **scale_curve** @@ -739,7 +739,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_scale_random: +.. _class_CPUParticles_scale_random: - :ref:`float` **scale_random** @@ -749,7 +749,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles_speed_scale: +.. _class_CPUParticles_speed_scale: - :ref:`float` **speed_scale** @@ -759,7 +759,7 @@ Property Descriptions | *Getter* | get_speed_scale() | +----------+------------------------+ - .. _class_CPUParticles_spread: +.. _class_CPUParticles_spread: - :ref:`float` **spread** @@ -769,7 +769,7 @@ Property Descriptions | *Getter* | get_spread() | +----------+-------------------+ - .. _class_CPUParticles_tangential_accel: +.. _class_CPUParticles_tangential_accel: - :ref:`float` **tangential_accel** @@ -779,7 +779,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles_tangential_accel_curve: +.. _class_CPUParticles_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -789,7 +789,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles_tangential_accel_random: +.. _class_CPUParticles_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -802,11 +802,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_CPUParticles_convert_from_particles: +.. _class_CPUParticles_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** - .. _class_CPUParticles_restart: +.. _class_CPUParticles_restart: - void **restart** **(** **)** diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index bc898d362..b5cbf519d 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -151,14 +151,14 @@ Methods Enumerations ------------ - .. _enum_CPUParticles2D_Flags: +.. _enum_CPUParticles2D_Flags: enum **Flags**: - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** - **FLAG_MAX** = **2** - .. _enum_CPUParticles2D_Parameter: +.. _enum_CPUParticles2D_Parameter: enum **Parameter**: @@ -176,7 +176,7 @@ enum **Parameter**: - **PARAM_ANIM_OFFSET** = **11** - **PARAM_MAX** = **12** - .. _enum_CPUParticles2D_EmissionShape: +.. _enum_CPUParticles2D_EmissionShape: enum **EmissionShape**: @@ -186,7 +186,7 @@ enum **EmissionShape**: - **EMISSION_SHAPE_POINTS** = **3** - **EMISSION_SHAPE_DIRECTED_POINTS** = **4** - .. _enum_CPUParticles2D_DrawOrder: +.. _enum_CPUParticles2D_DrawOrder: enum **DrawOrder**: @@ -196,7 +196,7 @@ enum **DrawOrder**: Property Descriptions --------------------- - .. _class_CPUParticles2D_amount: +.. _class_CPUParticles2D_amount: - :ref:`int` **amount** @@ -206,7 +206,7 @@ Property Descriptions | *Getter* | get_amount() | +----------+-------------------+ - .. _class_CPUParticles2D_angle: +.. _class_CPUParticles2D_angle: - :ref:`float` **angle** @@ -216,7 +216,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_angle_curve: +.. _class_CPUParticles2D_angle_curve: - :ref:`Curve` **angle_curve** @@ -226,7 +226,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_angle_random: +.. _class_CPUParticles2D_angle_random: - :ref:`float` **angle_random** @@ -236,7 +236,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_angular_velocity: +.. _class_CPUParticles2D_angular_velocity: - :ref:`float` **angular_velocity** @@ -246,7 +246,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_angular_velocity_curve: +.. _class_CPUParticles2D_angular_velocity_curve: - :ref:`Curve` **angular_velocity_curve** @@ -256,7 +256,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_angular_velocity_random: +.. _class_CPUParticles2D_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -266,7 +266,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_anim_loop: +.. _class_CPUParticles2D_anim_loop: - :ref:`bool` **anim_loop** @@ -276,7 +276,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles2D_anim_offset: +.. _class_CPUParticles2D_anim_offset: - :ref:`float` **anim_offset** @@ -286,7 +286,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_anim_offset_curve: +.. _class_CPUParticles2D_anim_offset_curve: - :ref:`Curve` **anim_offset_curve** @@ -296,7 +296,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_anim_offset_random: +.. _class_CPUParticles2D_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -306,7 +306,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_anim_speed: +.. _class_CPUParticles2D_anim_speed: - :ref:`float` **anim_speed** @@ -316,7 +316,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_anim_speed_curve: +.. _class_CPUParticles2D_anim_speed_curve: - :ref:`Curve` **anim_speed_curve** @@ -326,7 +326,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_anim_speed_random: +.. _class_CPUParticles2D_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -336,7 +336,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_color: +.. _class_CPUParticles2D_color: - :ref:`Color` **color** @@ -346,7 +346,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ - .. _class_CPUParticles2D_color_ramp: +.. _class_CPUParticles2D_color_ramp: - :ref:`Gradient` **color_ramp** @@ -356,7 +356,7 @@ Property Descriptions | *Getter* | get_color_ramp() | +----------+-----------------------+ - .. _class_CPUParticles2D_damping: +.. _class_CPUParticles2D_damping: - :ref:`float` **damping** @@ -366,7 +366,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_damping_curve: +.. _class_CPUParticles2D_damping_curve: - :ref:`Curve` **damping_curve** @@ -376,7 +376,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_damping_random: +.. _class_CPUParticles2D_damping_random: - :ref:`float` **damping_random** @@ -386,7 +386,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_draw_order: +.. _class_CPUParticles2D_draw_order: - :ref:`DrawOrder` **draw_order** @@ -396,7 +396,7 @@ Property Descriptions | *Getter* | get_draw_order() | +----------+-----------------------+ - .. _class_CPUParticles2D_emission_colors: +.. _class_CPUParticles2D_emission_colors: - :ref:`PoolColorArray` **emission_colors** @@ -406,7 +406,7 @@ Property Descriptions | *Getter* | get_emission_colors() | +----------+----------------------------+ - .. _class_CPUParticles2D_emission_normals: +.. _class_CPUParticles2D_emission_normals: - :ref:`PoolVector2Array` **emission_normals** @@ -416,7 +416,7 @@ Property Descriptions | *Getter* | get_emission_normals() | +----------+-----------------------------+ - .. _class_CPUParticles2D_emission_points: +.. _class_CPUParticles2D_emission_points: - :ref:`PoolVector2Array` **emission_points** @@ -426,7 +426,7 @@ Property Descriptions | *Getter* | get_emission_points() | +----------+----------------------------+ - .. _class_CPUParticles2D_emission_rect_extents: +.. _class_CPUParticles2D_emission_rect_extents: - :ref:`Vector2` **emission_rect_extents** @@ -436,7 +436,7 @@ Property Descriptions | *Getter* | get_emission_rect_extents() | +----------+----------------------------------+ - .. _class_CPUParticles2D_emission_shape: +.. _class_CPUParticles2D_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -446,7 +446,7 @@ Property Descriptions | *Getter* | get_emission_shape() | +----------+---------------------------+ - .. _class_CPUParticles2D_emission_sphere_radius: +.. _class_CPUParticles2D_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -456,7 +456,7 @@ Property Descriptions | *Getter* | get_emission_sphere_radius() | +----------+-----------------------------------+ - .. _class_CPUParticles2D_emitting: +.. _class_CPUParticles2D_emitting: - :ref:`bool` **emitting** @@ -466,7 +466,7 @@ Property Descriptions | *Getter* | is_emitting() | +----------+---------------------+ - .. _class_CPUParticles2D_explosiveness: +.. _class_CPUParticles2D_explosiveness: - :ref:`float` **explosiveness** @@ -476,7 +476,7 @@ Property Descriptions | *Getter* | get_explosiveness_ratio() | +----------+--------------------------------+ - .. _class_CPUParticles2D_fixed_fps: +.. _class_CPUParticles2D_fixed_fps: - :ref:`int` **fixed_fps** @@ -486,7 +486,7 @@ Property Descriptions | *Getter* | get_fixed_fps() | +----------+----------------------+ - .. _class_CPUParticles2D_flag_align_y: +.. _class_CPUParticles2D_flag_align_y: - :ref:`bool` **flag_align_y** @@ -496,7 +496,7 @@ Property Descriptions | *Getter* | get_particle_flag() | +----------+--------------------------+ - .. _class_CPUParticles2D_flatness: +.. _class_CPUParticles2D_flatness: - :ref:`float` **flatness** @@ -506,7 +506,7 @@ Property Descriptions | *Getter* | get_flatness() | +----------+---------------------+ - .. _class_CPUParticles2D_fract_delta: +.. _class_CPUParticles2D_fract_delta: - :ref:`bool` **fract_delta** @@ -516,7 +516,7 @@ Property Descriptions | *Getter* | get_fractional_delta() | +----------+-----------------------------+ - .. _class_CPUParticles2D_gravity: +.. _class_CPUParticles2D_gravity: - :ref:`Vector2` **gravity** @@ -526,7 +526,7 @@ Property Descriptions | *Getter* | get_gravity() | +----------+--------------------+ - .. _class_CPUParticles2D_hue_variation: +.. _class_CPUParticles2D_hue_variation: - :ref:`float` **hue_variation** @@ -536,7 +536,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_hue_variation_curve: +.. _class_CPUParticles2D_hue_variation_curve: - :ref:`Curve` **hue_variation_curve** @@ -546,7 +546,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_hue_variation_random: +.. _class_CPUParticles2D_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -556,7 +556,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_initial_velocity: +.. _class_CPUParticles2D_initial_velocity: - :ref:`float` **initial_velocity** @@ -566,7 +566,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_initial_velocity_random: +.. _class_CPUParticles2D_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -576,7 +576,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_lifetime: +.. _class_CPUParticles2D_lifetime: - :ref:`float` **lifetime** @@ -586,7 +586,7 @@ Property Descriptions | *Getter* | get_lifetime() | +----------+---------------------+ - .. _class_CPUParticles2D_linear_accel: +.. _class_CPUParticles2D_linear_accel: - :ref:`float` **linear_accel** @@ -596,7 +596,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_linear_accel_curve: +.. _class_CPUParticles2D_linear_accel_curve: - :ref:`Curve` **linear_accel_curve** @@ -606,7 +606,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_linear_accel_random: +.. _class_CPUParticles2D_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -616,7 +616,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_local_coords: +.. _class_CPUParticles2D_local_coords: - :ref:`bool` **local_coords** @@ -626,7 +626,7 @@ Property Descriptions | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ - .. _class_CPUParticles2D_normalmap: +.. _class_CPUParticles2D_normalmap: - :ref:`Texture` **normalmap** @@ -636,7 +636,7 @@ Property Descriptions | *Getter* | get_normalmap() | +----------+----------------------+ - .. _class_CPUParticles2D_one_shot: +.. _class_CPUParticles2D_one_shot: - :ref:`bool` **one_shot** @@ -646,7 +646,7 @@ Property Descriptions | *Getter* | get_one_shot() | +----------+---------------------+ - .. _class_CPUParticles2D_preprocess: +.. _class_CPUParticles2D_preprocess: - :ref:`float` **preprocess** @@ -656,7 +656,7 @@ Property Descriptions | *Getter* | get_pre_process_time() | +----------+-----------------------------+ - .. _class_CPUParticles2D_radial_accel: +.. _class_CPUParticles2D_radial_accel: - :ref:`float` **radial_accel** @@ -666,7 +666,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_radial_accel_curve: +.. _class_CPUParticles2D_radial_accel_curve: - :ref:`Curve` **radial_accel_curve** @@ -676,7 +676,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_radial_accel_random: +.. _class_CPUParticles2D_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -686,7 +686,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_randomness: +.. _class_CPUParticles2D_randomness: - :ref:`float` **randomness** @@ -696,7 +696,7 @@ Property Descriptions | *Getter* | get_randomness_ratio() | +----------+-----------------------------+ - .. _class_CPUParticles2D_scale: +.. _class_CPUParticles2D_scale: - :ref:`float` **scale** @@ -706,7 +706,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_scale_curve: +.. _class_CPUParticles2D_scale_curve: - :ref:`Curve` **scale_curve** @@ -716,7 +716,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_scale_random: +.. _class_CPUParticles2D_scale_random: - :ref:`float` **scale_random** @@ -726,7 +726,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_speed_scale: +.. _class_CPUParticles2D_speed_scale: - :ref:`float` **speed_scale** @@ -736,7 +736,7 @@ Property Descriptions | *Getter* | get_speed_scale() | +----------+------------------------+ - .. _class_CPUParticles2D_spread: +.. _class_CPUParticles2D_spread: - :ref:`float` **spread** @@ -746,7 +746,7 @@ Property Descriptions | *Getter* | get_spread() | +----------+-------------------+ - .. _class_CPUParticles2D_tangential_accel: +.. _class_CPUParticles2D_tangential_accel: - :ref:`float` **tangential_accel** @@ -756,7 +756,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_CPUParticles2D_tangential_accel_curve: +.. _class_CPUParticles2D_tangential_accel_curve: - :ref:`Curve` **tangential_accel_curve** @@ -766,7 +766,7 @@ Property Descriptions | *Getter* | get_param_curve() | +----------+------------------------+ - .. _class_CPUParticles2D_tangential_accel_random: +.. _class_CPUParticles2D_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -776,7 +776,7 @@ Property Descriptions | *Getter* | get_param_randomness() | +----------+-----------------------------+ - .. _class_CPUParticles2D_texture: +.. _class_CPUParticles2D_texture: - :ref:`Texture` **texture** @@ -789,11 +789,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_CPUParticles2D_convert_from_particles: +.. _class_CPUParticles2D_convert_from_particles: - void **convert_from_particles** **(** :ref:`Node` particles **)** - .. _class_CPUParticles2D_restart: +.. _class_CPUParticles2D_restart: - void **restart** **(** **)** diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 8001b719d..1a92816ab 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -37,7 +37,7 @@ This node allows you to create a box for use with the CSG system. Property Descriptions --------------------- - .. _class_CSGBox_depth: +.. _class_CSGBox_depth: - :ref:`float` **depth** @@ -49,7 +49,7 @@ Property Descriptions Depth of the box measured from the center of the box. - .. _class_CSGBox_height: +.. _class_CSGBox_height: - :ref:`float` **height** @@ -61,7 +61,7 @@ Depth of the box measured from the center of the box. Height of the box measured from the center of the box. - .. _class_CSGBox_material: +.. _class_CSGBox_material: - :ref:`Material` **material** @@ -73,7 +73,7 @@ Height of the box measured from the center of the box. The material used to render the box. - .. _class_CSGBox_width: +.. _class_CSGBox_width: - :ref:`float` **width** diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index faaa22c10..5337609a0 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -41,7 +41,7 @@ This node allows you to create a cylinder (or cone) for use with the CSG system. Property Descriptions --------------------- - .. _class_CSGCylinder_cone: +.. _class_CSGCylinder_cone: - :ref:`bool` **cone** @@ -53,7 +53,7 @@ Property Descriptions If true a cone is created, the :ref:`radius` will only apply to one side. - .. _class_CSGCylinder_height: +.. _class_CSGCylinder_height: - :ref:`float` **height** @@ -65,7 +65,7 @@ If true a cone is created, the :ref:`radius` will only The height of the cylinder. - .. _class_CSGCylinder_material: +.. _class_CSGCylinder_material: - :ref:`Material` **material** @@ -77,7 +77,7 @@ The height of the cylinder. The material used to render the cylinder. - .. _class_CSGCylinder_radius: +.. _class_CSGCylinder_radius: - :ref:`float` **radius** @@ -89,7 +89,7 @@ The material used to render the cylinder. The radius of the cylinder. - .. _class_CSGCylinder_sides: +.. _class_CSGCylinder_sides: - :ref:`int` **sides** @@ -101,7 +101,7 @@ The radius of the cylinder. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder. - .. _class_CSGCylinder_smooth_faces: +.. _class_CSGCylinder_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 621dd3d2f..e923aa8d4 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -31,7 +31,7 @@ This CSG node allows you to use any mesh resource as a CSG shape provided it is Property Descriptions --------------------- - .. _class_CSGMesh_mesh: +.. _class_CSGMesh_mesh: - :ref:`Mesh` **mesh** diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 6c0a967a6..56046a269 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -50,7 +50,7 @@ Properties Enumerations ------------ - .. _enum_CSGPolygon_Mode: +.. _enum_CSGPolygon_Mode: enum **Mode**: @@ -58,7 +58,7 @@ enum **Mode**: - **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_CSGPolygon_PathRotation: enum **PathRotation**: @@ -74,7 +74,7 @@ This node takes a 2D polygon shape and extrudes it to create a 3D mesh. Property Descriptions --------------------- - .. _class_CSGPolygon_depth: +.. _class_CSGPolygon_depth: - :ref:`float` **depth** @@ -86,7 +86,7 @@ Property Descriptions Extrusion depth when :ref:`mode` is constant MODE_DEPTH. - .. _class_CSGPolygon_material: +.. _class_CSGPolygon_material: - :ref:`Material` **material** @@ -98,7 +98,7 @@ Extrusion depth when :ref:`mode` is constant MODE_DEPTH. Material to use for the resulting mesh. - .. _class_CSGPolygon_mode: +.. _class_CSGPolygon_mode: - :ref:`Mode` **mode** @@ -110,7 +110,7 @@ Material to use for the resulting mesh. Extrusion mode. - .. _class_CSGPolygon_path_continuous_u: +.. _class_CSGPolygon_path_continuous_u: - :ref:`bool` **path_continuous_u** @@ -122,7 +122,7 @@ Extrusion mode. If true the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_path_interval: +.. _class_CSGPolygon_path_interval: - :ref:`float` **path_interval** @@ -134,7 +134,7 @@ If true the u component of our uv will continuously increase in unison with the Interval at which a new extrusion slice is added along the path when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_path_joined: +.. _class_CSGPolygon_path_joined: - :ref:`bool` **path_joined** @@ -146,7 +146,7 @@ Interval at which a new extrusion slice is added along the path when :ref:`mode< If true the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_path_local: +.. _class_CSGPolygon_path_local: - :ref:`bool` **path_local** @@ -158,7 +158,7 @@ If true the start and end of our path are joined together ensuring there is no s If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_path_node: +.. _class_CSGPolygon_path_node: - :ref:`NodePath` **path_node** @@ -170,7 +170,7 @@ If false we extrude centered on our path, if true we extrude in relation to the The :ref:`Shape` object containing the path along which we extrude when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_path_rotation: +.. _class_CSGPolygon_path_rotation: - :ref:`PathRotation` **path_rotation** @@ -182,7 +182,7 @@ The :ref:`Shape` object containing the path along which we extrude The method by which each slice is rotated along the path when :ref:`mode` is constant MODE_PATH. - .. _class_CSGPolygon_polygon: +.. _class_CSGPolygon_polygon: - :ref:`PoolVector2Array` **polygon** @@ -194,7 +194,7 @@ The method by which each slice is rotated along the path when :ref:`mode` **smooth_faces** @@ -206,7 +206,7 @@ Point array that defines the shape that we'll extrude. Generates smooth normals so smooth shading is applied to our mesh. - .. _class_CSGPolygon_spin_degrees: +.. _class_CSGPolygon_spin_degrees: - :ref:`float` **spin_degrees** @@ -218,7 +218,7 @@ Generates smooth normals so smooth shading is applied to our mesh. Degrees to rotate our extrusion for each slice when :ref:`mode` is constant MODE_SPIN. - .. _class_CSGPolygon_spin_sides: +.. _class_CSGPolygon_spin_sides: - :ref:`int` **spin_sides** diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index 9b3ddc8ee..d09d4fbfc 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_CSGPrimitive_invert_faces: +.. _class_CSGPrimitive_invert_faces: - :ref:`bool` **invert_faces** diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index 40f0a52be..239718e02 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -39,7 +39,7 @@ Methods Enumerations ------------ - .. _enum_CSGShape_Operation: +.. _enum_CSGShape_Operation: enum **Operation**: @@ -55,7 +55,7 @@ This is the CSG base class that provides CSG operation support to the various CS Property Descriptions --------------------- - .. _class_CSGShape_operation: +.. _class_CSGShape_operation: - :ref:`Operation` **operation** @@ -67,7 +67,7 @@ Property Descriptions 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: +.. _class_CSGShape_snap: - :ref:`float` **snap** @@ -77,7 +77,7 @@ The operation that is performed on this shape. This is ignored for the first CSG | *Getter* | get_snap() | +----------+-----------------+ - .. _class_CSGShape_use_collision: +.. _class_CSGShape_use_collision: - :ref:`bool` **use_collision** @@ -92,7 +92,7 @@ Adds a collision shape to the physics engine for our CSG shape. This will always Method Descriptions ------------------- - .. _class_CSGShape_is_root_shape: +.. _class_CSGShape_is_root_shape: - :ref:`bool` **is_root_shape** **(** **)** const diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index 9748da8ea..0f0751d13 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -39,7 +39,7 @@ This node allows you to create a sphere for use with the CSG system. Property Descriptions --------------------- - .. _class_CSGSphere_material: +.. _class_CSGSphere_material: - :ref:`Material` **material** @@ -51,7 +51,7 @@ Property Descriptions The material used to render the sphere. - .. _class_CSGSphere_radial_segments: +.. _class_CSGSphere_radial_segments: - :ref:`int` **radial_segments** @@ -63,7 +63,7 @@ The material used to render the sphere. Number of vertical slices for the sphere. - .. _class_CSGSphere_radius: +.. _class_CSGSphere_radius: - :ref:`float` **radius** @@ -75,7 +75,7 @@ Number of vertical slices for the sphere. Radius of the sphere. - .. _class_CSGSphere_rings: +.. _class_CSGSphere_rings: - :ref:`int` **rings** @@ -87,7 +87,7 @@ Radius of the sphere. Number of horizontal slices for the sphere. - .. _class_CSGSphere_smooth_faces: +.. _class_CSGSphere_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index cdd932558..dc9db8f27 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -41,7 +41,7 @@ This node allows you to create a torus for use with the CSG system. Property Descriptions --------------------- - .. _class_CSGTorus_inner_radius: +.. _class_CSGTorus_inner_radius: - :ref:`float` **inner_radius** @@ -53,7 +53,7 @@ Property Descriptions The inner radius of the torus. - .. _class_CSGTorus_material: +.. _class_CSGTorus_material: - :ref:`Material` **material** @@ -65,7 +65,7 @@ The inner radius of the torus. The material used to render the torus. - .. _class_CSGTorus_outer_radius: +.. _class_CSGTorus_outer_radius: - :ref:`float` **outer_radius** @@ -77,7 +77,7 @@ The material used to render the torus. The outer radius of the torus. - .. _class_CSGTorus_ring_sides: +.. _class_CSGTorus_ring_sides: - :ref:`int` **ring_sides** @@ -89,7 +89,7 @@ The outer radius of the torus. The number of edges each ring of the torus is constructed of. - .. _class_CSGTorus_sides: +.. _class_CSGTorus_sides: - :ref:`int` **sides** @@ -101,7 +101,7 @@ The number of edges each ring of the torus is constructed of. The number of slices the torus is constructed of. - .. _class_CSGTorus_smooth_faces: +.. _class_CSGTorus_smooth_faces: - :ref:`bool` **smooth_faces** diff --git a/classes/class_csharpscript.rst b/classes/class_csharpscript.rst index 7536ec0c0..55411ef94 100644 --- a/classes/class_csharpscript.rst +++ b/classes/class_csharpscript.rst @@ -26,7 +26,7 @@ Methods Method Descriptions ------------------- - .. _class_CSharpScript_new: +.. _class_CSharpScript_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index a5697384d..4c873e752 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -43,7 +43,7 @@ Methods Enumerations ------------ - .. _enum_CubeMap_Flags: +.. _enum_CubeMap_Flags: enum **Flags**: @@ -52,7 +52,7 @@ enum **Flags**: - **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture. - **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. - .. _enum_CubeMap_Storage: +.. _enum_CubeMap_Storage: enum **Storage**: @@ -60,7 +60,7 @@ enum **Storage**: - **STORAGE_COMPRESS_LOSSY** = **1** --- Store the ``CubeMap`` with strong compression that reduces image quality. - **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality. - .. _enum_CubeMap_Side: +.. _enum_CubeMap_Side: enum **Side**: @@ -79,7 +79,7 @@ A 6-sided 3D texture typically used for faking reflections. It can be used to ma Property Descriptions --------------------- - .. _class_CubeMap_flags: +.. _class_CubeMap_flags: - :ref:`int` **flags** @@ -91,7 +91,7 @@ Property Descriptions The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. - .. _class_CubeMap_lossy_storage_quality: +.. _class_CubeMap_lossy_storage_quality: - :ref:`float` **lossy_storage_quality** @@ -103,7 +103,7 @@ The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details. The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY. - .. _class_CubeMap_storage_mode: +.. _class_CubeMap_storage_mode: - :ref:`Storage` **storage_mode** @@ -118,25 +118,25 @@ The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants. Method Descriptions ------------------- - .. _class_CubeMap_get_height: +.. _class_CubeMap_get_height: - :ref:`int` **get_height** **(** **)** const Returns the ``CubeMap``'s height. - .. _class_CubeMap_get_side: +.. _class_CubeMap_get_side: - :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. - .. _class_CubeMap_get_width: +.. _class_CubeMap_get_width: - :ref:`int` **get_width** **(** **)** const Returns the ``CubeMap``'s width. - .. _class_CubeMap_set_side: +.. _class_CubeMap_set_side: - void **set_side** **(** :ref:`Side` side, :ref:`Image` image **)** diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index 6773c6812..5665e1eaa 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -37,7 +37,7 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Property Descriptions --------------------- - .. _class_CubeMesh_size: +.. _class_CubeMesh_size: - :ref:`Vector3` **size** @@ -49,7 +49,7 @@ Property Descriptions Size of the cuboid mesh. Defaults to (2, 2, 2). - .. _class_CubeMesh_subdivide_depth: +.. _class_CubeMesh_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -61,7 +61,7 @@ Size of the cuboid mesh. Defaults to (2, 2, 2). Number of extra edge loops inserted along the z-axis. Defaults to 0. - .. _class_CubeMesh_subdivide_height: +.. _class_CubeMesh_subdivide_height: - :ref:`int` **subdivide_height** @@ -73,7 +73,7 @@ Number of extra edge loops inserted along the z-axis. Defaults to 0. Number of extra edge loops inserted along the y-axis. Defaults to 0. - .. _class_CubeMesh_subdivide_width: +.. _class_CubeMesh_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 8e3f37524..efbf38426 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -73,7 +73,7 @@ Methods Signals ------- - .. _class_Curve_range_changed: +.. _class_Curve_range_changed: - **range_changed** **(** **)** @@ -82,7 +82,7 @@ Emitted when :ref:`max_value` or :ref:`min_value` **bake_resolution** @@ -110,7 +110,7 @@ Property Descriptions The number of points to include in the baked (i.e. cached) curve data. - .. _class_Curve_max_value: +.. _class_Curve_max_value: - :ref:`float` **max_value** @@ -122,7 +122,7 @@ The number of points to include in the baked (i.e. cached) curve data. The maximum value the curve can reach. Default value: ``1``. - .. _class_Curve_min_value: +.. _class_Curve_min_value: - :ref:`float` **min_value** @@ -137,115 +137,115 @@ The minimum value the curve can reach. Default value: ``0``. Method Descriptions ------------------- - .. _class_Curve_add_point: +.. _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 **)** 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``. - .. _class_Curve_bake: +.. _class_Curve_bake: - void **bake** **(** **)** Recomputes the baked cache of points for the curve. - .. _class_Curve_clean_dupes: +.. _class_Curve_clean_dupes: - void **clean_dupes** **(** **)** Removes points that are closer than ``CMP_EPSILON`` (0.00001) units to their neighbor on the curve. - .. _class_Curve_clear_points: +.. _class_Curve_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. - .. _class_Curve_get_point_count: +.. _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: +.. _class_Curve_get_point_left_mode: - :ref:`TangentMode` **get_point_left_mode** **(** :ref:`int` index **)** const Returns the left ``TangentMode`` for the point at ``index``. - .. _class_Curve_get_point_left_tangent: +.. _class_Curve_get_point_left_tangent: - :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const Returns the left tangent angle (in degrees) for the point at ``index``. - .. _class_Curve_get_point_position: +.. _class_Curve_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const Returns the curve coordinates for the point at ``index``. - .. _class_Curve_get_point_right_mode: +.. _class_Curve_get_point_right_mode: - :ref:`TangentMode` **get_point_right_mode** **(** :ref:`int` index **)** const Returns the right ``TangentMode`` for the point at ``index``. - .. _class_Curve_get_point_right_tangent: +.. _class_Curve_get_point_right_tangent: - :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const Returns the right tangent angle (in degrees) for the point at ``index``. - .. _class_Curve_interpolate: +.. _class_Curve_interpolate: - :ref:`float` **interpolate** **(** :ref:`float` offset **)** const Returns the y value for the point that would exist at x-position ``offset`` along the curve. - .. _class_Curve_interpolate_baked: +.. _class_Curve_interpolate_baked: - :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** Returns the y value for the point that would exist at x-position ``offset`` along the curve using the baked cache. Bakes the curve's points if not already baked. - .. _class_Curve_remove_point: +.. _class_Curve_remove_point: - void **remove_point** **(** :ref:`int` index **)** Removes the point at ``index`` from the curve. - .. _class_Curve_set_point_left_mode: +.. _class_Curve_set_point_left_mode: - void **set_point_left_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the left ``TangentMode`` for the point at ``index`` to ``mode``. - .. _class_Curve_set_point_left_tangent: +.. _class_Curve_set_point_left_tangent: - void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the left tangent angle for the point at ``index`` to ``tangent``. - .. _class_Curve_set_point_offset: +.. _class_Curve_set_point_offset: - :ref:`int` **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** Sets the offset from ``0.5`` - .. _class_Curve_set_point_right_mode: +.. _class_Curve_set_point_right_mode: - void **set_point_right_mode** **(** :ref:`int` index, :ref:`TangentMode` mode **)** Sets the right ``TangentMode`` for the point at ``index`` to ``mode``. - .. _class_Curve_set_point_right_tangent: +.. _class_Curve_set_point_right_tangent: - void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** Sets the right tangent angle for the point at ``index`` to ``tangent``. - .. _class_Curve_set_point_value: +.. _class_Curve_set_point_value: - void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index 2dd272383..73a8bf31f 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -74,7 +74,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu Property Descriptions --------------------- - .. _class_Curve2D_bake_interval: +.. _class_Curve2D_bake_interval: - :ref:`float` **bake_interval** @@ -89,7 +89,7 @@ The distance in pixels between two adjacent cached points. Changing it forces th Method Descriptions ------------------- - .. _class_Curve2D_add_point: +.. _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 **)** @@ -97,25 +97,25 @@ Adds a point to a curve, at "position", with control points "in" and "out". If "at_position" is given, the point is inserted before the point number "at_position", moving that point (and every point after) after the inserted point. If "at_position" is not given, or is an illegal value (at_position <0 or at_position >= :ref:`get_point_count`), the point will be appended at the end of the point list. - .. _class_Curve2D_clear_points: +.. _class_Curve2D_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. - .. _class_Curve2D_get_baked_length: +.. _class_Curve2D_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. - .. _class_Curve2D_get_baked_points: +.. _class_Curve2D_get_baked_points: - :ref:`PoolVector2Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector2Array`. - .. _class_Curve2D_get_closest_offset: +.. _class_Curve2D_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector2` to_point **)** const @@ -123,7 +123,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in : ``to_point`` must be in this curve's local space. - .. _class_Curve2D_get_closest_point: +.. _class_Curve2D_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` to_point **)** const @@ -131,31 +131,31 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. - .. _class_Curve2D_get_point_count: +.. _class_Curve2D_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. - .. _class_Curve2D_get_point_in: +.. _class_Curve2D_get_point_in: - :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: +.. _class_Curve2D_get_point_out: - :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: +.. _class_Curve2D_get_point_position: - :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: +.. _class_Curve2D_interpolate: - :ref:`Vector2` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -163,7 +163,7 @@ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0). - .. _class_Curve2D_interpolate_baked: +.. _class_Curve2D_interpolate_baked: - :ref:`Vector2` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -173,37 +173,37 @@ To do that, it finds the two cached points where the "offset" lies between, then Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). - .. _class_Curve2D_interpolatef: +.. _class_Curve2D_interpolatef: - :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". - .. _class_Curve2D_remove_point: +.. _class_Curve2D_remove_point: - void **remove_point** **(** :ref:`int` idx **)** Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. - .. _class_Curve2D_set_point_in: +.. _class_Curve2D_set_point_in: - 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: +.. _class_Curve2D_set_point_out: - 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: +.. _class_Curve2D_set_point_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: +.. _class_Curve2D_tessellate: - :ref:`PoolVector2Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 9c90f64b2..ee9ad0744 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -86,7 +86,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu Property Descriptions --------------------- - .. _class_Curve3D_bake_interval: +.. _class_Curve3D_bake_interval: - :ref:`float` **bake_interval** @@ -98,7 +98,7 @@ Property Descriptions The distance in meters 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. - .. _class_Curve3D_up_vector_enabled: +.. _class_Curve3D_up_vector_enabled: - :ref:`bool` **up_vector_enabled** @@ -113,7 +113,7 @@ If ``true``, the curve will bake up vectors used for orientation. See :ref:`Orie Method Descriptions ------------------- - .. _class_Curve3D_add_point: +.. _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 **)** @@ -121,31 +121,31 @@ Adds a point to a curve, at "position", with control points "in" and "out". If "at_position" is given, the point is inserted before the point number "at_position", moving that point (and every point after) after the inserted point. If "at_position" is not given, or is an illegal value (at_position <0 or at_position >= :ref:`get_point_count`), the point will be appended at the end of the point list. - .. _class_Curve3D_clear_points: +.. _class_Curve3D_clear_points: - void **clear_points** **(** **)** Removes all points from the curve. - .. _class_Curve3D_get_baked_length: +.. _class_Curve3D_get_baked_length: - :ref:`float` **get_baked_length** **(** **)** const Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval`), it should be approximate enough. - .. _class_Curve3D_get_baked_points: +.. _class_Curve3D_get_baked_points: - :ref:`PoolVector3Array` **get_baked_points** **(** **)** const Returns the cache of points as a :ref:`PoolVector3Array`. - .. _class_Curve3D_get_baked_tilts: +.. _class_Curve3D_get_baked_tilts: - :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const Returns the cache of tilts as a RealArray. - .. _class_Curve3D_get_baked_up_vectors: +.. _class_Curve3D_get_baked_up_vectors: - :ref:`PoolVector3Array` **get_baked_up_vectors** **(** **)** const @@ -153,7 +153,7 @@ Returns the cache of up vectors as a :ref:`PoolVector3Array` is ``false``, the cache will be empty. - .. _class_Curve3D_get_closest_offset: +.. _class_Curve3D_get_closest_offset: - :ref:`float` **get_closest_offset** **(** :ref:`Vector3` to_point **)** const @@ -161,7 +161,7 @@ Returns the closest offset to ``to_point``. This offset is meant to be used in o ``to_point`` must be in this curve's local space. - .. _class_Curve3D_get_closest_point: +.. _class_Curve3D_get_closest_point: - :ref:`Vector3` **get_closest_point** **(** :ref:`Vector3` to_point **)** const @@ -169,37 +169,37 @@ Returns the closest point (in curve's local space) to ``to_point``. ``to_point`` must be in this curve's local space. - .. _class_Curve3D_get_point_count: +.. _class_Curve3D_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of points describing the curve. - .. _class_Curve3D_get_point_in: +.. _class_Curve3D_get_point_in: - :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: +.. _class_Curve3D_get_point_out: - :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: +.. _class_Curve3D_get_point_position: - :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). - .. _class_Curve3D_get_point_tilt: +.. _class_Curve3D_get_point_tilt: - :ref:`float` **get_point_tilt** **(** :ref:`int` idx **)** const Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. - .. _class_Curve3D_interpolate: +.. _class_Curve3D_interpolate: - :ref:`Vector3` **interpolate** **(** :ref:`int` idx, :ref:`float` t **)** const @@ -207,7 +207,7 @@ Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0). - .. _class_Curve3D_interpolate_baked: +.. _class_Curve3D_interpolate_baked: - :ref:`Vector3` **interpolate_baked** **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const @@ -217,7 +217,7 @@ To do that, it finds the two cached points where the "offset" lies between, then Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). - .. _class_Curve3D_interpolate_baked_up_vector: +.. _class_Curve3D_interpolate_baked_up_vector: - :ref:`Vector3` **interpolate_baked_up_vector** **(** :ref:`float` offset, :ref:`bool` apply_tilt=false **)** const @@ -227,37 +227,37 @@ To do that, it finds the two cached up vectors where the ``offset`` lies between If the curve has no up vectors, the function sends an error to the console, and returns (0, 1, 0). - .. _class_Curve3D_interpolatef: +.. _class_Curve3D_interpolatef: - :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". - .. _class_Curve3D_remove_point: +.. _class_Curve3D_remove_point: - void **remove_point** **(** :ref:`int` idx **)** Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. - .. _class_Curve3D_set_point_in: +.. _class_Curve3D_set_point_in: - 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: +.. _class_Curve3D_set_point_out: - 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: +.. _class_Curve3D_set_point_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. - .. _class_Curve3D_set_point_tilt: +.. _class_Curve3D_set_point_tilt: - void **set_point_tilt** **(** :ref:`int` idx, :ref:`float` tilt **)** @@ -265,7 +265,7 @@ Sets the tilt angle in radians for the point "idx". If the index is out of bound 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: +.. _class_Curve3D_tessellate: - :ref:`PoolVector3Array` **tessellate** **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 5d8aafd00..7a09e1259 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -33,7 +33,7 @@ Renders a given :ref:`Curve` provided to it. Simplifies the task of Property Descriptions --------------------- - .. _class_CurveTexture_curve: +.. _class_CurveTexture_curve: - :ref:`Curve` **curve** @@ -45,7 +45,7 @@ Property Descriptions The ``curve`` rendered onto the texture. - .. _class_CurveTexture_width: +.. _class_CurveTexture_width: - :ref:`int` **width** diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 0d5634120..579f7d300 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -39,7 +39,7 @@ Class representing a cylindrical :ref:`PrimitiveMesh`. Property Descriptions --------------------- - .. _class_CylinderMesh_bottom_radius: +.. _class_CylinderMesh_bottom_radius: - :ref:`float` **bottom_radius** @@ -51,7 +51,7 @@ Property Descriptions Bottom radius of the cylinder. Defaults to 1.0. - .. _class_CylinderMesh_height: +.. _class_CylinderMesh_height: - :ref:`float` **height** @@ -63,7 +63,7 @@ Bottom radius of the cylinder. Defaults to 1.0. Full height of the cylinder. Defaults to 2.0. - .. _class_CylinderMesh_radial_segments: +.. _class_CylinderMesh_radial_segments: - :ref:`int` **radial_segments** @@ -75,7 +75,7 @@ Full height of the cylinder. Defaults to 2.0. Number of radial segments on the cylinder. Defaults to 64. - .. _class_CylinderMesh_rings: +.. _class_CylinderMesh_rings: - :ref:`int` **rings** @@ -87,7 +87,7 @@ Number of radial segments on the cylinder. Defaults to 64. Number of edge rings along the height of the cylinder. Defaults to 4. - .. _class_CylinderMesh_top_radius: +.. _class_CylinderMesh_top_radius: - :ref:`float` **top_radius** diff --git a/classes/class_cylindershape.rst b/classes/class_cylindershape.rst index 9a1ba2c10..8c73795a7 100644 --- a/classes/class_cylindershape.rst +++ b/classes/class_cylindershape.rst @@ -33,7 +33,7 @@ Cylinder shape for collisions. Property Descriptions --------------------- - .. _class_CylinderShape_height: +.. _class_CylinderShape_height: - :ref:`float` **height** @@ -45,7 +45,7 @@ Property Descriptions The cylinder's height. - .. _class_CylinderShape_radius: +.. _class_CylinderShape_radius: - :ref:`float` **radius** diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index 4b256df45..8d04032e0 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -37,7 +37,7 @@ Damped spring constraint for 2D physics. This resembles a spring joint that alwa Property Descriptions --------------------- - .. _class_DampedSpringJoint2D_damping: +.. _class_DampedSpringJoint2D_damping: - :ref:`float` **damping** @@ -49,7 +49,7 @@ Property Descriptions The spring joint's damping ratio. A value between ``0`` and ``1``. When the two bodies move into different directions the system tries to align them to the spring axis again. A high ``damping`` value forces the attached bodies to align faster. Default value: ``1`` - .. _class_DampedSpringJoint2D_length: +.. _class_DampedSpringJoint2D_length: - :ref:`float` **length** @@ -61,7 +61,7 @@ The spring joint's damping ratio. A value between ``0`` and ``1``. When the two The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: ``50`` - .. _class_DampedSpringJoint2D_rest_length: +.. _class_DampedSpringJoint2D_rest_length: - :ref:`float` **rest_length** @@ -73,7 +73,7 @@ The spring joint's maximum length. The two attached bodies cannot stretch it pas When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: ``0`` - .. _class_DampedSpringJoint2D_stiffness: +.. _class_DampedSpringJoint2D_stiffness: - :ref:`float` **stiffness** diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index c60c123d9..964f7a20d 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -47,61 +47,61 @@ Dictionary type. Associative container which contains values referenced by uniqu Method Descriptions ------------------- - .. _class_Dictionary_clear: +.. _class_Dictionary_clear: - void **clear** **(** **)** Clear the dictionary, removing all key/value pairs. - .. _class_Dictionary_duplicate: +.. _class_Dictionary_duplicate: - :ref:`Dictionary` **duplicate** **(** :ref:`bool` deep=False **)** Creates a copy of the dictionary, and returns it. - .. _class_Dictionary_empty: +.. _class_Dictionary_empty: - :ref:`bool` **empty** **(** **)** Return true if the dictionary is empty. - .. _class_Dictionary_erase: +.. _class_Dictionary_erase: - :ref:`bool` **erase** **(** :ref:`Variant` key **)** Erase a dictionary key/value pair by key. - .. _class_Dictionary_has: +.. _class_Dictionary_has: - :ref:`bool` **has** **(** :ref:`Variant` key **)** Return true if the dictionary has a given key. - .. _class_Dictionary_has_all: +.. _class_Dictionary_has_all: - :ref:`bool` **has_all** **(** :ref:`Array` keys **)** Return true if the dictionary has all of the keys in the given array. - .. _class_Dictionary_hash: +.. _class_Dictionary_hash: - :ref:`int` **hash** **(** **)** Return a hashed integer value representing the dictionary contents. - .. _class_Dictionary_keys: +.. _class_Dictionary_keys: - :ref:`Array` **keys** **(** **)** Return the list of keys in the ``Dictionary``. - .. _class_Dictionary_size: +.. _class_Dictionary_size: - :ref:`int` **size** **(** **)** Return the size of the dictionary (in pairs). - .. _class_Dictionary_values: +.. _class_Dictionary_values: - :ref:`Array` **values** **(** **)** diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index de1e9331f..69c2b10dd 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -42,14 +42,14 @@ Properties Enumerations ------------ - .. _enum_DirectionalLight_ShadowDepthRange: +.. _enum_DirectionalLight_ShadowDepthRange: enum **ShadowDepthRange**: - **SHADOW_DEPTH_RANGE_STABLE** = **0** --- Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. - **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** --- Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. - .. _enum_DirectionalLight_ShadowMode: +.. _enum_DirectionalLight_ShadowMode: enum **ShadowMode**: @@ -66,10 +66,11 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` + Property Descriptions --------------------- - .. _class_DirectionalLight_directional_shadow_bias_split_scale: +.. _class_DirectionalLight_directional_shadow_bias_split_scale: - :ref:`float` **directional_shadow_bias_split_scale** @@ -81,7 +82,7 @@ Property Descriptions 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: +.. _class_DirectionalLight_directional_shadow_blend_splits: - :ref:`bool` **directional_shadow_blend_splits** @@ -93,7 +94,7 @@ Amount of extra bias for shadow splits that are far away. If self shadowing occu If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. - .. _class_DirectionalLight_directional_shadow_depth_range: +.. _class_DirectionalLight_directional_shadow_depth_range: - :ref:`ShadowDepthRange` **directional_shadow_depth_range** @@ -105,7 +106,7 @@ If ``true`` shadow detail is sacrificed in exchange for smoother transitions bet Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRange`. - .. _class_DirectionalLight_directional_shadow_max_distance: +.. _class_DirectionalLight_directional_shadow_max_distance: - :ref:`float` **directional_shadow_max_distance** @@ -117,7 +118,7 @@ Optimizes shadow rendering for detail versus movement. See :ref:`ShadowDepthRang The maximum distance for shadow splits. - .. _class_DirectionalLight_directional_shadow_mode: +.. _class_DirectionalLight_directional_shadow_mode: - :ref:`ShadowMode` **directional_shadow_mode** @@ -129,7 +130,7 @@ The maximum distance for shadow splits. The light's shadow rendering algorithm. See :ref:`ShadowMode`. - .. _class_DirectionalLight_directional_shadow_normal_bias: +.. _class_DirectionalLight_directional_shadow_normal_bias: - :ref:`float` **directional_shadow_normal_bias** @@ -141,7 +142,7 @@ The light's shadow rendering algorithm. See :ref:`ShadowMode` **directional_shadow_split_1** @@ -153,7 +154,7 @@ Can be used to fix special cases of self shadowing when objects are perpendicula 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: +.. _class_DirectionalLight_directional_shadow_split_2: - :ref:`float` **directional_shadow_split_2** @@ -165,7 +166,7 @@ The distance from camera to shadow split 1. Relative to :ref:`directional_shadow 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: +.. _class_DirectionalLight_directional_shadow_split_3: - :ref:`float` **directional_shadow_split_3** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 96d8d7103..807d3022f 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -84,10 +84,11 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/filesystem` + Method Descriptions ------------------- - .. _class_Directory_change_dir: +.. _class_Directory_change_dir: - :ref:`Error` **change_dir** **(** :ref:`String` todir **)** @@ -95,7 +96,7 @@ Change the currently opened directory to the one passed as an argument. The argu The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). - .. _class_Directory_copy: +.. _class_Directory_copy: - :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to **)** @@ -103,49 +104,49 @@ Copy the *from* file to the *to* destination. Both arguments should be paths to Returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). - .. _class_Directory_current_is_dir: +.. _class_Directory_current_is_dir: - :ref:`bool` **current_is_dir** **(** **)** const Return whether the current item processed with the last :ref:`get_next` call is a directory (``.`` and ``..`` are considered directories). - .. _class_Directory_dir_exists: +.. _class_Directory_dir_exists: - :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: +.. _class_Directory_file_exists: - :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: +.. _class_Directory_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``). - .. _class_Directory_get_current_drive: +.. _class_Directory_get_current_drive: - :ref:`int` **get_current_drive** **(** **)** Returns the currently opened directory's drive index. See :ref:`get_drive` to convert returned index to the name of the drive. - .. _class_Directory_get_drive: +.. _class_Directory_get_drive: - :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. - .. _class_Directory_get_drive_count: +.. _class_Directory_get_drive_count: - :ref:`int` **get_drive_count** **(** **)** On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. - .. _class_Directory_get_next: +.. _class_Directory_get_next: - :ref:`String` **get_next** **(** **)** @@ -153,13 +154,13 @@ Return the next element (file or directory) in the current directory (including The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end` would not be mandatory in such a case). - .. _class_Directory_get_space_left: +.. _class_Directory_get_space_left: - :ref:`int` **get_space_left** **(** **)** On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. - .. _class_Directory_list_dir_begin: +.. _class_Directory_list_dir_begin: - :ref:`Error` **list_dir_begin** **(** :ref:`bool` skip_navigational=false, :ref:`bool` skip_hidden=false **)** @@ -169,13 +170,13 @@ If you pass ``skip_navigational``, then ``.`` and ``..`` would be filtered out. If you pass ``skip_hidden``, then hidden files would be filtered out. - .. _class_Directory_list_dir_end: +.. _class_Directory_list_dir_end: - void **list_dir_end** **(** **)** Close the current stream opened with :ref:`list_dir_begin` (whether it has been fully processed with :ref:`get_next` or not does not matter). - .. _class_Directory_make_dir: +.. _class_Directory_make_dir: - :ref:`Error` **make_dir** **(** :ref:`String` path **)** @@ -183,7 +184,7 @@ Create a directory. The argument can be relative to the current directory, or an The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). - .. _class_Directory_make_dir_recursive: +.. _class_Directory_make_dir_recursive: - :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** @@ -191,7 +192,7 @@ Create a target directory and all necessary intermediate directories in its path Return one of the error code constants defined in :ref:`@GlobalScope` (OK, FAILED or ERR\_\*). - .. _class_Directory_open: +.. _class_Directory_open: - :ref:`Error` **open** **(** :ref:`String` path **)** @@ -199,7 +200,7 @@ Open an existing directory of the filesystem. The *path* argument can be within The method returns one of the error code constants defined in :ref:`@GlobalScope` (OK or ERR\_\*). - .. _class_Directory_remove: +.. _class_Directory_remove: - :ref:`Error` **remove** **(** :ref:`String` path **)** @@ -207,7 +208,7 @@ Delete the target file or an empty directory. The argument can be relative to th Return one of the error code constants defined in :ref:`@GlobalScope` (OK or FAILED). - .. _class_Directory_rename: +.. _class_Directory_rename: - :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index b539a3321..ec893c75c 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -59,7 +59,7 @@ Methods Enumerations ------------ - .. _enum_DynamicFont_SpacingType: +.. _enum_DynamicFont_SpacingType: enum **SpacingType**: @@ -76,7 +76,7 @@ DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtim Property Descriptions --------------------- - .. _class_DynamicFont_extra_spacing_bottom: +.. _class_DynamicFont_extra_spacing_bottom: - :ref:`int` **extra_spacing_bottom** @@ -88,7 +88,7 @@ Property Descriptions Extra spacing at the bottom in pixels. - .. _class_DynamicFont_extra_spacing_char: +.. _class_DynamicFont_extra_spacing_char: - :ref:`int` **extra_spacing_char** @@ -100,7 +100,7 @@ Extra spacing at the bottom in pixels. Extra character spacing in pixels. - .. _class_DynamicFont_extra_spacing_space: +.. _class_DynamicFont_extra_spacing_space: - :ref:`int` **extra_spacing_space** @@ -112,7 +112,7 @@ Extra character spacing in pixels. Extra space spacing in pixels. - .. _class_DynamicFont_extra_spacing_top: +.. _class_DynamicFont_extra_spacing_top: - :ref:`int` **extra_spacing_top** @@ -124,7 +124,7 @@ Extra space spacing in pixels. Extra spacing at the top in pixels. - .. _class_DynamicFont_font_data: +.. _class_DynamicFont_font_data: - :ref:`DynamicFontData` **font_data** @@ -136,7 +136,7 @@ Extra spacing at the top in pixels. The font data. - .. _class_DynamicFont_outline_color: +.. _class_DynamicFont_outline_color: - :ref:`Color` **outline_color** @@ -146,7 +146,7 @@ The font data. | *Getter* | get_outline_color() | +----------+--------------------------+ - .. _class_DynamicFont_outline_size: +.. _class_DynamicFont_outline_size: - :ref:`int` **outline_size** @@ -156,7 +156,7 @@ The font data. | *Getter* | get_outline_size() | +----------+-------------------------+ - .. _class_DynamicFont_size: +.. _class_DynamicFont_size: - :ref:`int` **size** @@ -168,7 +168,7 @@ The font data. The font size. - .. _class_DynamicFont_use_filter: +.. _class_DynamicFont_use_filter: - :ref:`bool` **use_filter** @@ -180,7 +180,7 @@ The font size. If ``true`` filtering is used. - .. _class_DynamicFont_use_mipmaps: +.. _class_DynamicFont_use_mipmaps: - :ref:`bool` **use_mipmaps** @@ -195,31 +195,31 @@ If ``true`` mipmapping is used. Method Descriptions ------------------- - .. _class_DynamicFont_add_fallback: +.. _class_DynamicFont_add_fallback: - void **add_fallback** **(** :ref:`DynamicFontData` data **)** Adds a fallback font. - .. _class_DynamicFont_get_fallback: +.. _class_DynamicFont_get_fallback: - :ref:`DynamicFontData` **get_fallback** **(** :ref:`int` idx **)** const Returns the fallback font at index ``idx``. - .. _class_DynamicFont_get_fallback_count: +.. _class_DynamicFont_get_fallback_count: - :ref:`int` **get_fallback_count** **(** **)** const Returns the number of fallback fonts. - .. _class_DynamicFont_remove_fallback: +.. _class_DynamicFont_remove_fallback: - void **remove_fallback** **(** :ref:`int` idx **)** Removes the fallback font at index ``idx``. - .. _class_DynamicFont_set_fallback: +.. _class_DynamicFont_set_fallback: - void **set_fallback** **(** :ref:`int` idx, :ref:`DynamicFontData` data **)** diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 22629a46c..309636f31 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_DynamicFontData_Hinting: +.. _enum_DynamicFontData_Hinting: enum **Hinting**: @@ -44,7 +44,7 @@ Used with :ref:`DynamicFont` to describe the location of a ve Property Descriptions --------------------- - .. _class_DynamicFontData_font_path: +.. _class_DynamicFontData_font_path: - :ref:`String` **font_path** @@ -56,7 +56,7 @@ Property Descriptions The path to the vector font file. - .. _class_DynamicFontData_hinting: +.. _class_DynamicFontData_hinting: - :ref:`Hinting` **hinting** diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index f4bc8c5bf..9c760bbd2 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -44,43 +44,43 @@ Methods Method Descriptions ------------------- - .. _class_EditorExportPlugin__export_begin: +.. _class_EditorExportPlugin__export_begin: - void **_export_begin** **(** :ref:`PoolStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** virtual - .. _class_EditorExportPlugin__export_file: +.. _class_EditorExportPlugin__export_file: - void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual - .. _class_EditorExportPlugin_add_file: +.. _class_EditorExportPlugin_add_file: - void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** - .. _class_EditorExportPlugin_add_ios_bundle_file: +.. _class_EditorExportPlugin_add_ios_bundle_file: - void **add_ios_bundle_file** **(** :ref:`String` path **)** - .. _class_EditorExportPlugin_add_ios_cpp_code: +.. _class_EditorExportPlugin_add_ios_cpp_code: - void **add_ios_cpp_code** **(** :ref:`String` code **)** - .. _class_EditorExportPlugin_add_ios_framework: +.. _class_EditorExportPlugin_add_ios_framework: - void **add_ios_framework** **(** :ref:`String` path **)** - .. _class_EditorExportPlugin_add_ios_linker_flags: +.. _class_EditorExportPlugin_add_ios_linker_flags: - void **add_ios_linker_flags** **(** :ref:`String` flags **)** - .. _class_EditorExportPlugin_add_ios_plist_content: +.. _class_EditorExportPlugin_add_ios_plist_content: - void **add_ios_plist_content** **(** :ref:`String` plist_content **)** - .. _class_EditorExportPlugin_add_shared_object: +.. _class_EditorExportPlugin_add_shared_object: - void **add_shared_object** **(** :ref:`String` path, :ref:`PoolStringArray` tags **)** - .. _class_EditorExportPlugin_skip: +.. _class_EditorExportPlugin_skip: - void **skip** **(** **)** diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index a0934a3fe..935521a74 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -53,19 +53,19 @@ Methods Signals ------- - .. _class_EditorFileDialog_dir_selected: +.. _class_EditorFileDialog_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Emitted when a directory is selected. - .. _class_EditorFileDialog_file_selected: +.. _class_EditorFileDialog_file_selected: - **file_selected** **(** :ref:`String` path **)** Emitted when a file is selected. - .. _class_EditorFileDialog_files_selected: +.. _class_EditorFileDialog_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -74,7 +74,7 @@ Emitted when multiple files are selected. Enumerations ------------ - .. _enum_EditorFileDialog_Access: +.. _enum_EditorFileDialog_Access: enum **Access**: @@ -82,14 +82,14 @@ enum **Access**: - **ACCESS_USERDATA** = **1** --- The ``EditorFileDialog`` can only view ``user://`` directory contents. - **ACCESS_FILESYSTEM** = **2** --- The ``EditorFileDialog`` can view the entire local file system. - .. _enum_EditorFileDialog_DisplayMode: +.. _enum_EditorFileDialog_DisplayMode: enum **DisplayMode**: - **DISPLAY_THUMBNAILS** = **0** --- The ``EditorFileDialog`` displays resources as thumbnails. - **DISPLAY_LIST** = **1** --- The ``EditorFileDialog`` displays resources as a list of filenames. - .. _enum_EditorFileDialog_Mode: +.. _enum_EditorFileDialog_Mode: enum **Mode**: @@ -102,7 +102,7 @@ enum **Mode**: Property Descriptions --------------------- - .. _class_EditorFileDialog_access: +.. _class_EditorFileDialog_access: - :ref:`Access` **access** @@ -114,7 +114,7 @@ Property Descriptions The location from which the user may select a file, including ``res://``, ``user://``, and the local file system. - .. _class_EditorFileDialog_current_dir: +.. _class_EditorFileDialog_current_dir: - :ref:`String` **current_dir** @@ -126,7 +126,7 @@ The location from which the user may select a file, including ``res://``, ``user The currently occupied directory. - .. _class_EditorFileDialog_current_file: +.. _class_EditorFileDialog_current_file: - :ref:`String` **current_file** @@ -138,7 +138,7 @@ The currently occupied directory. The currently selected file. - .. _class_EditorFileDialog_current_path: +.. _class_EditorFileDialog_current_path: - :ref:`String` **current_path** @@ -150,7 +150,7 @@ The currently selected file. The file system path in the address bar. - .. _class_EditorFileDialog_disable_overwrite_warning: +.. _class_EditorFileDialog_disable_overwrite_warning: - :ref:`bool` **disable_overwrite_warning** @@ -162,7 +162,7 @@ The file system path in the address bar. If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. - .. _class_EditorFileDialog_display_mode: +.. _class_EditorFileDialog_display_mode: - :ref:`DisplayMode` **display_mode** @@ -174,7 +174,7 @@ If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting f The view format in which the ``EditorFileDialog`` displays resources to the user. - .. _class_EditorFileDialog_mode: +.. _class_EditorFileDialog_mode: - :ref:`Mode` **mode** @@ -186,7 +186,7 @@ The view format in which the ``EditorFileDialog`` displays resources to the user The purpose of the ``EditorFileDialog``. Changes allowed behaviors. - .. _class_EditorFileDialog_show_hidden_files: +.. _class_EditorFileDialog_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -201,7 +201,7 @@ If ``true`` hidden files and directories will be visible in the ``EditorFileDial Method Descriptions ------------------- - .. _class_EditorFileDialog_add_filter: +.. _class_EditorFileDialog_add_filter: - void **add_filter** **(** :ref:`String` filter **)** @@ -209,19 +209,19 @@ Adds a comma-delimited file extension filter option to the ``EditorFileDialog`` Example: "\*.tscn, \*.scn; Scenes", results in filter text "Scenes (\*.tscn, \*.scn)". - .. _class_EditorFileDialog_clear_filters: +.. _class_EditorFileDialog_clear_filters: - void **clear_filters** **(** **)** Removes all filters except for "All Files (\*)". - .. _class_EditorFileDialog_get_vbox: +.. _class_EditorFileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Returns the ``VBoxContainer`` used to display the file system. - .. _class_EditorFileDialog_invalidate: +.. _class_EditorFileDialog_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 0a6d889b0..a4b0a6076 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -42,23 +42,19 @@ Methods Signals ------- - .. _class_EditorFileSystem_filesystem_changed: +.. _class_EditorFileSystem_filesystem_changed: - **filesystem_changed** **(** **)** Emitted if the filesystem changed. - .. _class_EditorFileSystem_resources_reimported: +.. _class_EditorFileSystem_resources_reimported: - **resources_reimported** **(** :ref:`PoolStringArray` resources **)** Remitted if a resource is reimported. - .. _class_EditorFileSystem_script_classes_updated: - -- **script_classes_updated** **(** **)** - - .. _class_EditorFileSystem_sources_changed: +.. _class_EditorFileSystem_sources_changed: - **sources_changed** **(** :ref:`bool` exist **)** @@ -72,55 +68,55 @@ This object holds information of all resources in the filesystem, their types, e Method Descriptions ------------------- - .. _class_EditorFileSystem_get_file_type: +.. _class_EditorFileSystem_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`String` path **)** const Get the type of the file, given the full path. - .. _class_EditorFileSystem_get_filesystem: +.. _class_EditorFileSystem_get_filesystem: - :ref:`EditorFileSystemDirectory` **get_filesystem** **(** **)** Get the root directory object. - .. _class_EditorFileSystem_get_filesystem_path: +.. _class_EditorFileSystem_get_filesystem_path: - :ref:`EditorFileSystemDirectory` **get_filesystem_path** **(** :ref:`String` path **)** Returns a view into the filesystem at ``path``. - .. _class_EditorFileSystem_get_scanning_progress: +.. _class_EditorFileSystem_get_scanning_progress: - :ref:`float` **get_scanning_progress** **(** **)** const Return the scan progress for 0 to 1 if the FS is being scanned. - .. _class_EditorFileSystem_is_scanning: +.. _class_EditorFileSystem_is_scanning: - :ref:`bool` **is_scanning** **(** **)** const Return true of the filesystem is being scanned. - .. _class_EditorFileSystem_scan: +.. _class_EditorFileSystem_scan: - void **scan** **(** **)** Scan the filesystem for changes. - .. _class_EditorFileSystem_scan_sources: +.. _class_EditorFileSystem_scan_sources: - void **scan_sources** **(** **)** Check if the source of any imported resource changed. - .. _class_EditorFileSystem_update_file: +.. _class_EditorFileSystem_update_file: - void **update_file** **(** :ref:`String` path **)** Update a file information. Call this if an external program (not Godot) modified the file. - .. _class_EditorFileSystem_update_script_classes: +.. _class_EditorFileSystem_update_script_classes: - void **update_script_classes** **(** **)** diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index c13df422f..b67e591a6 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -57,81 +57,81 @@ A more generalized, low-level variation of the directory concept. Method Descriptions ------------------- - .. _class_EditorFileSystemDirectory_find_dir_index: +.. _class_EditorFileSystemDirectory_find_dir_index: - :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: +.. _class_EditorFileSystemDirectory_find_file_index: - :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: +.. _class_EditorFileSystemDirectory_get_file: - :ref:`String` **get_file** **(** :ref:`int` idx **)** const Returns the name of the file at index ``idx``. - .. _class_EditorFileSystemDirectory_get_file_count: +.. _class_EditorFileSystemDirectory_get_file_count: - :ref:`int` **get_file_count** **(** **)** const Returns the number of files in this directory. - .. _class_EditorFileSystemDirectory_get_file_import_is_valid: +.. _class_EditorFileSystemDirectory_get_file_import_is_valid: - :ref:`bool` **get_file_import_is_valid** **(** :ref:`int` idx **)** const Returns ``true`` if the file at index ``idx`` imported properly. - .. _class_EditorFileSystemDirectory_get_file_path: +.. _class_EditorFileSystemDirectory_get_file_path: - :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: +.. _class_EditorFileSystemDirectory_get_file_script_class_extends: - :ref:`String` **get_file_script_class_extends** **(** :ref:`int` idx **)** const - .. _class_EditorFileSystemDirectory_get_file_script_class_name: +.. _class_EditorFileSystemDirectory_get_file_script_class_name: - :ref:`String` **get_file_script_class_name** **(** :ref:`int` idx **)** const - .. _class_EditorFileSystemDirectory_get_file_type: +.. _class_EditorFileSystemDirectory_get_file_type: - :ref:`String` **get_file_type** **(** :ref:`int` idx **)** const Returns the file extension of the file at index ``idx``. - .. _class_EditorFileSystemDirectory_get_name: +.. _class_EditorFileSystemDirectory_get_name: - :ref:`String` **get_name** **(** **)** Returns the name of this directory. - .. _class_EditorFileSystemDirectory_get_parent: +.. _class_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: +.. _class_EditorFileSystemDirectory_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path to this directory. - .. _class_EditorFileSystemDirectory_get_subdir: +.. _class_EditorFileSystemDirectory_get_subdir: - :ref:`EditorFileSystemDirectory` **get_subdir** **(** :ref:`int` idx **)** Returns the subdirectory at index ``idx``. - .. _class_EditorFileSystemDirectory_get_subdir_count: +.. _class_EditorFileSystemDirectory_get_subdir_count: - :ref:`int` **get_subdir_count** **(** **)** const diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 19bd2855f..9a02a53a6 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -98,74 +98,75 @@ Tutorials --------- - :doc:`../tutorials/plugins/editor/import_plugins` + Method Descriptions ------------------- - .. _class_EditorImportPlugin_get_import_options: +.. _class_EditorImportPlugin_get_import_options: - :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). - .. _class_EditorImportPlugin_get_import_order: +.. _class_EditorImportPlugin_get_import_order: - :ref:`int` **get_import_order** **(** **)** virtual Get the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. - .. _class_EditorImportPlugin_get_importer_name: +.. _class_EditorImportPlugin_get_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual Get the unique name of the importer. - .. _class_EditorImportPlugin_get_option_visibility: +.. _class_EditorImportPlugin_get_option_visibility: - :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual - .. _class_EditorImportPlugin_get_preset_count: +.. _class_EditorImportPlugin_get_preset_count: - :ref:`int` **get_preset_count** **(** **)** virtual Get the number of initial presets defined by the plugin. Use :ref:`get_import_options` to get the default options for the preset and :ref:`get_preset_name` to get the name of the preset. - .. _class_EditorImportPlugin_get_preset_name: +.. _class_EditorImportPlugin_get_preset_name: - :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual Get the name of the options preset at this index. - .. _class_EditorImportPlugin_get_priority: +.. _class_EditorImportPlugin_get_priority: - :ref:`float` **get_priority** **(** **)** virtual Get the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. Default value is 1.0. - .. _class_EditorImportPlugin_get_recognized_extensions: +.. _class_EditorImportPlugin_get_recognized_extensions: - :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: +.. _class_EditorImportPlugin_get_resource_type: - :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: +.. _class_EditorImportPlugin_get_save_extension: - :ref:`String` **get_save_extension** **(** **)** virtual Get the extension used to save this resource in the ``.import`` directory. - .. _class_EditorImportPlugin_get_visible_name: +.. _class_EditorImportPlugin_get_visible_name: - :ref:`String` **get_visible_name** **(** **)** virtual Get the name to display in the import window. - .. _class_EditorImportPlugin_import: +.. _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 diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 63067d776..7b2292ecf 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -26,34 +26,34 @@ Methods Signals ------- - .. _class_EditorInspector_object_id_selected: +.. _class_EditorInspector_object_id_selected: - **object_id_selected** **(** :ref:`int` id **)** - .. _class_EditorInspector_property_edited: +.. _class_EditorInspector_property_edited: - **property_edited** **(** :ref:`String` property **)** - .. _class_EditorInspector_property_keyed: +.. _class_EditorInspector_property_keyed: - **property_keyed** **(** :ref:`String` property **)** - .. _class_EditorInspector_property_selected: +.. _class_EditorInspector_property_selected: - **property_selected** **(** :ref:`String` property **)** - .. _class_EditorInspector_resource_selected: +.. _class_EditorInspector_resource_selected: - **resource_selected** **(** :ref:`Object` res, :ref:`String` prop **)** - .. _class_EditorInspector_restart_requested: +.. _class_EditorInspector_restart_requested: - **restart_requested** **(** **)** Method Descriptions ------------------- - .. _class_EditorInspector_refresh: +.. _class_EditorInspector_refresh: - void **refresh** **(** **)** diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index fbb837708..82d5daad8 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -40,35 +40,35 @@ Methods Method Descriptions ------------------- - .. _class_EditorInspectorPlugin_add_custom_control: +.. _class_EditorInspectorPlugin_add_custom_control: - void **add_custom_control** **(** :ref:`Control` control **)** - .. _class_EditorInspectorPlugin_add_property_editor: +.. _class_EditorInspectorPlugin_add_property_editor: - void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** - .. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties: +.. _class_EditorInspectorPlugin_add_property_editor_for_multiple_properties: - void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** - .. _class_EditorInspectorPlugin_can_handle: +.. _class_EditorInspectorPlugin_can_handle: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual - .. _class_EditorInspectorPlugin_parse_begin: +.. _class_EditorInspectorPlugin_parse_begin: - void **parse_begin** **(** :ref:`Object` object **)** virtual - .. _class_EditorInspectorPlugin_parse_category: +.. _class_EditorInspectorPlugin_parse_category: - void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual - .. _class_EditorInspectorPlugin_parse_end: +.. _class_EditorInspectorPlugin_parse_end: - void **parse_end** **(** **)** virtual - .. _class_EditorInspectorPlugin_parse_property: +.. _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 diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index ba598f3f8..a8feac08b 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -69,117 +69,117 @@ Editor interface. Allows saving and (re-)loading scenes, rendering mesh previews Method Descriptions ------------------- - .. _class_EditorInterface_edit_resource: +.. _class_EditorInterface_edit_resource: - void **edit_resource** **(** :ref:`Resource` resource **)** Edits the given :ref:`Resource`. - .. _class_EditorInterface_get_base_control: +.. _class_EditorInterface_get_base_control: - :ref:`Control` **get_base_control** **(** **)** -Returns the base :ref:`Control`. +Returns the main container of Godot's editor window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. - .. _class_EditorInterface_get_edited_scene_root: +.. _class_EditorInterface_get_edited_scene_root: - :ref:`Node` **get_edited_scene_root** **(** **)** Returns the edited scene's root :ref:`Node`. - .. _class_EditorInterface_get_editor_settings: +.. _class_EditorInterface_get_editor_settings: - :ref:`EditorSettings` **get_editor_settings** **(** **)** Returns the :ref:`EditorSettings`. - .. _class_EditorInterface_get_editor_viewport: +.. _class_EditorInterface_get_editor_viewport: - :ref:`Control` **get_editor_viewport** **(** **)** Returns the editor :ref:`Viewport`. - .. _class_EditorInterface_get_open_scenes: +.. _class_EditorInterface_get_open_scenes: - :ref:`Array` **get_open_scenes** **(** **)** const Returns an :ref:`Array` of the currently opened scenes. - .. _class_EditorInterface_get_resource_filesystem: +.. _class_EditorInterface_get_resource_filesystem: - :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** Returns the :ref:`EditorFileSystem`. - .. _class_EditorInterface_get_resource_previewer: +.. _class_EditorInterface_get_resource_previewer: - :ref:`EditorResourcePreview` **get_resource_previewer** **(** **)** Returns the :ref:`EditorResourcePreview`\ er. - .. _class_EditorInterface_get_script_editor: +.. _class_EditorInterface_get_script_editor: - :ref:`ScriptEditor` **get_script_editor** **(** **)** Returns the :ref:`ScriptEditor`. - .. _class_EditorInterface_get_selected_path: +.. _class_EditorInterface_get_selected_path: - :ref:`String` **get_selected_path** **(** **)** const - .. _class_EditorInterface_get_selection: +.. _class_EditorInterface_get_selection: - :ref:`EditorSelection` **get_selection** **(** **)** Returns the :ref:`EditorSelection`. - .. _class_EditorInterface_inspect_object: +.. _class_EditorInterface_inspect_object: - 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: +.. _class_EditorInterface_is_plugin_enabled: - :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: +.. _class_EditorInterface_make_mesh_previews: - :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. - .. _class_EditorInterface_open_scene_from_path: +.. _class_EditorInterface_open_scene_from_path: - void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** Opens the scene at the given path. - .. _class_EditorInterface_reload_scene_from_path: +.. _class_EditorInterface_reload_scene_from_path: - void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** Reloads the scene at the given path. - .. _class_EditorInterface_save_scene: +.. _class_EditorInterface_save_scene: - :ref:`Error` **save_scene** **(** **)** Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope` constants. - .. _class_EditorInterface_save_scene_as: +.. _class_EditorInterface_save_scene_as: - void **save_scene_as** **(** :ref:`String` path, :ref:`bool` with_preview=true **)** Saves the scene as a file at ``path``. - .. _class_EditorInterface_select_file: +.. _class_EditorInterface_select_file: - void **select_file** **(** :ref:`String` p_file **)** - .. _class_EditorInterface_set_plugin_enabled: +.. _class_EditorInterface_set_plugin_enabled: - void **set_plugin_enabled** **(** :ref:`String` plugin, :ref:`bool` enabled **)** diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 4afff643f..736bea93e 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -50,12 +50,12 @@ Methods +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_canvas_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`forward_canvas_force_draw_over_viewport` **(** :ref:`Control` overlay **)** 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_force_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | -+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`forward_spatial_gui_input` **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_breakpoints` **(** **)** virtual | @@ -122,23 +122,23 @@ Methods Signals ------- - .. _class_EditorPlugin_main_screen_changed: +.. _class_EditorPlugin_main_screen_changed: - **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: +.. _class_EditorPlugin_resource_saved: - **resource_saved** **(** :ref:`Resource` resource **)** - .. _class_EditorPlugin_scene_changed: +.. _class_EditorPlugin_scene_changed: - **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: +.. _class_EditorPlugin_scene_closed: - **scene_closed** **(** :ref:`String` filepath **)** @@ -147,7 +147,7 @@ Emitted when user close scene. The argument is file path to a closed scene. Enumerations ------------ - .. _enum_EditorPlugin_DockSlot: +.. _enum_EditorPlugin_DockSlot: enum **DockSlot**: @@ -161,7 +161,7 @@ enum **DockSlot**: - **DOCK_SLOT_RIGHT_BR** = **7** - **DOCK_SLOT_MAX** = **8** - .. _enum_EditorPlugin_CustomControlContainer: +.. _enum_EditorPlugin_CustomControlContainer: enum **CustomControlContainer**: @@ -185,22 +185,23 @@ Tutorials --------- - :doc:`../development/plugins/index` + Method Descriptions ------------------- - .. _class_EditorPlugin_add_autoload_singleton: +.. _class_EditorPlugin_add_autoload_singleton: - 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: +.. _class_EditorPlugin_add_control_to_bottom_panel: - :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: +.. _class_EditorPlugin_add_control_to_container: - void **add_control_to_container** **(** :ref:`CustomControlContainer` container, :ref:`Control` control **)** @@ -210,7 +211,7 @@ Please remember that you have to manage the visibility of your custom controls y If your plugin is being removed, also make sure to remove your custom controls too. - .. _class_EditorPlugin_add_control_to_dock: +.. _class_EditorPlugin_add_control_to_dock: - void **add_control_to_dock** **(** :ref:`DockSlot` slot, :ref:`Control` control **)** @@ -220,7 +221,7 @@ If the dock is repositioned and as long as the plugin is active, the editor will If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_docks`. - .. _class_EditorPlugin_add_custom_type: +.. _class_EditorPlugin_add_custom_type: - void **add_custom_type** **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** @@ -232,33 +233,33 @@ You can use the :ref:`EditorPlugin.handles` to check During run-time, this will be a simple object with a script so this function does not need to be called then. - .. _class_EditorPlugin_add_export_plugin: +.. _class_EditorPlugin_add_export_plugin: - void **add_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** - .. _class_EditorPlugin_add_import_plugin: +.. _class_EditorPlugin_add_import_plugin: - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** - .. _class_EditorPlugin_add_inspector_plugin: +.. _class_EditorPlugin_add_inspector_plugin: - void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** - .. _class_EditorPlugin_add_scene_import_plugin: +.. _class_EditorPlugin_add_scene_import_plugin: - void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** - .. _class_EditorPlugin_add_tool_menu_item: +.. _class_EditorPlugin_add_tool_menu_item: - 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: +.. _class_EditorPlugin_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`Object` submenu **)** - .. _class_EditorPlugin_apply_changes: +.. _class_EditorPlugin_apply_changes: - void **apply_changes** **(** **)** virtual @@ -266,35 +267,35 @@ This method is called when the editor is about to save the project, switch to an This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. - .. _class_EditorPlugin_build: +.. _class_EditorPlugin_build: - :ref:`bool` **build** **(** **)** virtual - .. _class_EditorPlugin_clear: +.. _class_EditorPlugin_clear: - void **clear** **(** **)** virtual Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. - .. _class_EditorPlugin_edit: +.. _class_EditorPlugin_edit: - 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: +.. _class_EditorPlugin_forward_canvas_draw_over_viewport: + +- void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual + +.. _class_EditorPlugin_forward_canvas_force_draw_over_viewport: + +- void **forward_canvas_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual + +.. _class_EditorPlugin_forward_canvas_gui_input: - :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 - - .. _class_EditorPlugin_forward_force_draw_over_viewport: - -- void **forward_force_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual - - .. _class_EditorPlugin_forward_spatial_gui_input: +.. _class_EditorPlugin_forward_spatial_gui_input: - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual @@ -302,69 +303,69 @@ Implement this function if you are interested in 3D view screen input events. It If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled`. - .. _class_EditorPlugin_get_breakpoints: +.. _class_EditorPlugin_get_breakpoints: - :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: +.. _class_EditorPlugin_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** - .. _class_EditorPlugin_get_plugin_icon: +.. _class_EditorPlugin_get_plugin_icon: - :ref:`Object` **get_plugin_icon** **(** **)** virtual - .. _class_EditorPlugin_get_plugin_name: +.. _class_EditorPlugin_get_plugin_name: - :ref:`String` **get_plugin_name** **(** **)** virtual - .. _class_EditorPlugin_get_script_create_dialog: +.. _class_EditorPlugin_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: +.. _class_EditorPlugin_get_state: - :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: +.. _class_EditorPlugin_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: +.. _class_EditorPlugin_get_window_layout: - 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: +.. _class_EditorPlugin_handles: - :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. - .. _class_EditorPlugin_has_main_screen: +.. _class_EditorPlugin_has_main_screen: - :ref:`bool` **has_main_screen** **(** **)** virtual Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script). - .. _class_EditorPlugin_hide_bottom_panel: +.. _class_EditorPlugin_hide_bottom_panel: - void **hide_bottom_panel** **(** **)** - .. _class_EditorPlugin_make_bottom_panel_item_visible: +.. _class_EditorPlugin_make_bottom_panel_item_visible: - void **make_bottom_panel_item_visible** **(** :ref:`Control` item **)** - .. _class_EditorPlugin_make_visible: +.. _class_EditorPlugin_make_visible: - void **make_visible** **(** :ref:`bool` visible **)** virtual @@ -372,93 +373,93 @@ This function will be called when the editor is requested to become visible. It Remember that you have to manage the visibility of all your editor controls manually. - .. _class_EditorPlugin_queue_save_layout: +.. _class_EditorPlugin_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. - .. _class_EditorPlugin_remove_autoload_singleton: +.. _class_EditorPlugin_remove_autoload_singleton: - void **remove_autoload_singleton** **(** :ref:`String` name **)** Remove an Autoload ``name`` from the list. - .. _class_EditorPlugin_remove_control_from_bottom_panel: +.. _class_EditorPlugin_remove_control_from_bottom_panel: - 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: +.. _class_EditorPlugin_remove_control_from_container: - 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: +.. _class_EditorPlugin_remove_control_from_docks: - 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: +.. _class_EditorPlugin_remove_custom_type: - void **remove_custom_type** **(** :ref:`String` type **)** Remove a custom type added by :ref:`EditorPlugin.add_custom_type` - .. _class_EditorPlugin_remove_export_plugin: +.. _class_EditorPlugin_remove_export_plugin: - void **remove_export_plugin** **(** :ref:`EditorExportPlugin` plugin **)** - .. _class_EditorPlugin_remove_import_plugin: +.. _class_EditorPlugin_remove_import_plugin: - void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** - .. _class_EditorPlugin_remove_inspector_plugin: +.. _class_EditorPlugin_remove_inspector_plugin: - void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin` plugin **)** - .. _class_EditorPlugin_remove_scene_import_plugin: +.. _class_EditorPlugin_remove_scene_import_plugin: - void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter` scene_importer **)** - .. _class_EditorPlugin_remove_tool_menu_item: +.. _class_EditorPlugin_remove_tool_menu_item: - void **remove_tool_menu_item** **(** :ref:`String` name **)** Removes a menu ``name`` from 'Project > Tools'. - .. _class_EditorPlugin_save_external_data: +.. _class_EditorPlugin_save_external_data: - void **save_external_data** **(** **)** virtual This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. - .. _class_EditorPlugin_set_force_draw_over_forwarding_enabled: +.. _class_EditorPlugin_set_force_draw_over_forwarding_enabled: - void **set_force_draw_over_forwarding_enabled** **(** **)** - .. _class_EditorPlugin_set_input_event_forwarding_always_enabled: +.. _class_EditorPlugin_set_input_event_forwarding_always_enabled: - void **set_input_event_forwarding_always_enabled** **(** **)** Use this method if you always want to receive inputs from 3D view screen inside :ref:`forward_spatial_gui_input`. It might be especially usable if your plugin will want to use raycast in the scene. - .. _class_EditorPlugin_set_state: +.. _class_EditorPlugin_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual Restore the state saved by :ref:`EditorPlugin.get_state`. - .. _class_EditorPlugin_set_window_layout: +.. _class_EditorPlugin_set_window_layout: - void **set_window_layout** **(** :ref:`ConfigFile` layout **)** virtual Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. - .. _class_EditorPlugin_update_overlays: +.. _class_EditorPlugin_update_overlays: - :ref:`int` **update_overlays** **(** **)** const diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index aec8d4360..88d022fa3 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -49,42 +49,42 @@ Methods Signals ------- - .. _class_EditorProperty_multiple_properties_changed: +.. _class_EditorProperty_multiple_properties_changed: - **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** - .. _class_EditorProperty_object_id_selected: +.. _class_EditorProperty_object_id_selected: - **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** - .. _class_EditorProperty_property_changed: +.. _class_EditorProperty_property_changed: - **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** - .. _class_EditorProperty_property_checked: +.. _class_EditorProperty_property_checked: - **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** - .. _class_EditorProperty_property_keyed: +.. _class_EditorProperty_property_keyed: - **property_keyed** **(** :ref:`String` property **)** - .. _class_EditorProperty_property_keyed_with_value: +.. _class_EditorProperty_property_keyed_with_value: - **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** - .. _class_EditorProperty_resource_selected: +.. _class_EditorProperty_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** - .. _class_EditorProperty_selected: +.. _class_EditorProperty_selected: - **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** Property Descriptions --------------------- - .. _class_EditorProperty_checkable: +.. _class_EditorProperty_checkable: - :ref:`bool` **checkable** @@ -94,7 +94,7 @@ Property Descriptions | *Getter* | is_checkable() | +----------+----------------------+ - .. _class_EditorProperty_checked: +.. _class_EditorProperty_checked: - :ref:`bool` **checked** @@ -104,7 +104,7 @@ Property Descriptions | *Getter* | is_checked() | +----------+--------------------+ - .. _class_EditorProperty_draw_red: +.. _class_EditorProperty_draw_red: - :ref:`bool` **draw_red** @@ -114,7 +114,7 @@ Property Descriptions | *Getter* | is_draw_red() | +----------+---------------------+ - .. _class_EditorProperty_keying: +.. _class_EditorProperty_keying: - :ref:`bool` **keying** @@ -124,7 +124,7 @@ Property Descriptions | *Getter* | is_keying() | +----------+-------------------+ - .. _class_EditorProperty_label: +.. _class_EditorProperty_label: - :ref:`String` **label** @@ -134,7 +134,7 @@ Property Descriptions | *Getter* | get_label() | +----------+------------------+ - .. _class_EditorProperty_read_only: +.. _class_EditorProperty_read_only: - :ref:`bool` **read_only** @@ -147,19 +147,19 @@ Property Descriptions Method Descriptions ------------------- - .. _class_EditorProperty_get_edited_object: +.. _class_EditorProperty_get_edited_object: - :ref:`Object` **get_edited_object** **(** **)** - .. _class_EditorProperty_get_edited_property: +.. _class_EditorProperty_get_edited_property: - :ref:`String` **get_edited_property** **(** **)** - .. _class_EditorProperty_get_tooltip_text: +.. _class_EditorProperty_get_tooltip_text: - :ref:`String` **get_tooltip_text** **(** **)** const - .. _class_EditorProperty_update_property: +.. _class_EditorProperty_update_property: - void **update_property** **(** **)** virtual diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index 1897d8ef0..1b84f8fcb 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -28,11 +28,11 @@ Methods Method Descriptions ------------------- - .. _class_EditorResourceConversionPlugin__convert: +.. _class_EditorResourceConversionPlugin__convert: - :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual - .. _class_EditorResourceConversionPlugin__converts_to: +.. _class_EditorResourceConversionPlugin__converts_to: - :ref:`String` **_converts_to** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index f021f62a2..6743a652e 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -34,7 +34,7 @@ Methods Signals ------- - .. _class_EditorResourcePreview_preview_invalidated: +.. _class_EditorResourcePreview_preview_invalidated: - **preview_invalidated** **(** :ref:`String` path **)** @@ -48,31 +48,31 @@ This object is used to generate previews for resources of files. Method Descriptions ------------------- - .. _class_EditorResourcePreview_add_preview_generator: +.. _class_EditorResourcePreview_add_preview_generator: - void **add_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** Create an own, custom preview generator. - .. _class_EditorResourcePreview_check_for_invalidation: +.. _class_EditorResourcePreview_check_for_invalidation: - 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: +.. _class_EditorResourcePreview_queue_edited_resource_preview: - 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: +.. _class_EditorResourcePreview_queue_resource_preview: - 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: +.. _class_EditorResourcePreview_remove_preview_generator: - void **remove_preview_generator** **(** :ref:`EditorResourcePreviewGenerator` generator **)** diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 5c9627c0d..efdfebc31 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -19,13 +19,13 @@ Custom generator of previews. Methods ------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate` **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`generate_from_path` **(** :ref:`String` path, :ref:`Vector2` size **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles` **(** :ref:`String` type **)** virtual | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -35,27 +35,27 @@ Custom code to generate previews. Please check "file_dialog/thumbnail_size" in E Method Descriptions ------------------- - .. _class_EditorResourcePreviewGenerator_generate: +.. _class_EditorResourcePreviewGenerator_generate: -- :ref:`Texture` **generate** **(** :ref:`Resource` from **)** virtual +- :ref:`Texture` **generate** **(** :ref:`Resource` from, :ref:`Vector2` size **)** virtual -Generate a preview from a given resource. This must be always implemented. +Generate a preview from a given resource with the specified size. This must always be implemented. Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread). - .. _class_EditorResourcePreviewGenerator_generate_from_path: +.. _class_EditorResourcePreviewGenerator_generate_from_path: -- :ref:`Texture` **generate_from_path** **(** :ref:`String` path **)** virtual +- :ref:`Texture` **generate_from_path** **(** :ref:`String` path, :ref:`Vector2` size **)** virtual -Generate a preview directly from a path, implementing this is optional, as default code will load and call generate() +Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call :ref:`generate`. Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread). - .. _class_EditorResourcePreviewGenerator_handles: +.. _class_EditorResourcePreviewGenerator_handles: - :ref:`bool` **handles** **(** :ref:`String` type **)** virtual diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index 9adb3ef26..e135f443d 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -46,30 +46,31 @@ Constants - **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = **512** - **IMPORT_MATERIALS_IN_INSTANCES** = **1024** - **IMPORT_USE_COMPRESSION** = **2048** + Method Descriptions ------------------- - .. _class_EditorSceneImporter__get_extensions: +.. _class_EditorSceneImporter__get_extensions: - :ref:`Array` **_get_extensions** **(** **)** virtual - .. _class_EditorSceneImporter__get_import_flags: +.. _class_EditorSceneImporter__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** virtual - .. _class_EditorSceneImporter__import_animation: +.. _class_EditorSceneImporter__import_animation: - :ref:`Animation` **_import_animation** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual - .. _class_EditorSceneImporter__import_scene: +.. _class_EditorSceneImporter__import_scene: - :ref:`Node` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** virtual - .. _class_EditorSceneImporter_import_animation_from_other_importer: +.. _class_EditorSceneImporter_import_animation_from_other_importer: - :ref:`Animation` **import_animation_from_other_importer** **(** :ref:`String` path, :ref:`int` flags, :ref:`int` bake_fps **)** - .. _class_EditorSceneImporter_import_scene_from_other_importer: +.. _class_EditorSceneImporter_import_scene_from_other_importer: - :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 bf9974302..7cbe1190f 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -36,22 +36,23 @@ Tutorials --------- - `http://docs.godotengine.org/en/latest/learning/workflow/assets/importing_scenes.html?highlight=post%20import `_ + Method Descriptions ------------------- - .. _class_EditorScenePostImport_get_source_file: +.. _class_EditorScenePostImport_get_source_file: - :ref:`String` **get_source_file** **(** **)** const Returns the source-file-path which got imported (e.g. ``res://scene.dae`` ) - .. _class_EditorScenePostImport_get_source_folder: +.. _class_EditorScenePostImport_get_source_folder: - :ref:`String` **get_source_folder** **(** **)** const Returns the resource-folder the imported scene-file is located in - .. _class_EditorScenePostImport_post_import: +.. _class_EditorScenePostImport_post_import: - :ref:`Object` **post_import** **(** :ref:`Object` scene **)** virtual diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index b0f613e8b..b193ee25c 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -49,13 +49,13 @@ Note that the script is run in the Editor context, which means the output is vis Method Descriptions ------------------- - .. _class_EditorScript__run: +.. _class_EditorScript__run: - void **_run** **(** **)** virtual This method is executed by the Editor when ``File -> Run`` is used. - .. _class_EditorScript_add_root_node: +.. _class_EditorScript_add_root_node: - void **add_root_node** **(** :ref:`Node` node **)** @@ -63,13 +63,13 @@ Adds ``node`` as a child of the root node in the editor context. WARNING: The implementation of this method is currently disabled. - .. _class_EditorScript_get_editor_interface: +.. _class_EditorScript_get_editor_interface: - :ref:`EditorInterface` **get_editor_interface** **(** **)** Returns the :ref:`EditorInterface` singleton instance. - .. _class_EditorScript_get_scene: +.. _class_EditorScript_get_scene: - :ref:`Node` **get_scene** **(** **)** diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 38d045ebe..614da794c 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -34,7 +34,7 @@ Methods Signals ------- - .. _class_EditorSelection_selection_changed: +.. _class_EditorSelection_selection_changed: - **selection_changed** **(** **)** @@ -48,31 +48,31 @@ This object manages the SceneTree selection in the editor. Method Descriptions ------------------- - .. _class_EditorSelection_add_node: +.. _class_EditorSelection_add_node: - void **add_node** **(** :ref:`Node` node **)** Add a node to the selection. - .. _class_EditorSelection_clear: +.. _class_EditorSelection_clear: - void **clear** **(** **)** Clear the selection. - .. _class_EditorSelection_get_selected_nodes: +.. _class_EditorSelection_get_selected_nodes: - :ref:`Array` **get_selected_nodes** **(** **)** Get the list of selected nodes. - .. _class_EditorSelection_get_transformable_selected_nodes: +.. _class_EditorSelection_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: +.. _class_EditorSelection_remove_node: - void **remove_node** **(** :ref:`Node` node **)** diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 573d4f5fc..3b39606af 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -24,7 +24,7 @@ Methods +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase` **(** :ref:`String` property **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_favorite_dirs` **(** **)** const | +| :ref:`PoolStringArray` | :ref:`get_favorites` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_project_metadata` **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -42,7 +42,7 @@ Methods +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_favorite_dirs` **(** :ref:`PoolStringArray` dirs **)** | +| void | :ref:`set_favorites` **(** :ref:`PoolStringArray` dirs **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -56,7 +56,7 @@ Methods Signals ------- - .. _class_EditorSettings_settings_changed: +.. _class_EditorSettings_settings_changed: - **settings_changed** **(** **)** @@ -76,7 +76,7 @@ Accessing the settings is done by using the regular :ref:`Object` Method Descriptions ------------------- - .. _class_EditorSettings_add_property_info: +.. _class_EditorSettings_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` info **)** @@ -97,39 +97,39 @@ Example: editor_settings.add_property_info(property_info) - .. _class_EditorSettings_erase: +.. _class_EditorSettings_erase: - void **erase** **(** :ref:`String` property **)** Erase a given setting (pass full property path). - .. _class_EditorSettings_get_favorite_dirs: +.. _class_EditorSettings_get_favorites: -- :ref:`PoolStringArray` **get_favorite_dirs** **(** **)** const +- :ref:`PoolStringArray` **get_favorites** **(** **)** const -Get the list of favorite directories for this project. +Get the list of favorite files and directories for this project. - .. _class_EditorSettings_get_project_metadata: +.. _class_EditorSettings_get_project_metadata: - :ref:`Variant` **get_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` default=null **)** const - .. _class_EditorSettings_get_project_settings_dir: +.. _class_EditorSettings_get_project_settings_dir: - :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: +.. _class_EditorSettings_get_recent_dirs: - :ref:`PoolStringArray` **get_recent_dirs** **(** **)** const Get the list of recently visited folders in the file dialog for this project. - .. _class_EditorSettings_get_setting: +.. _class_EditorSettings_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const - .. _class_EditorSettings_get_settings_dir: +.. _class_EditorSettings_get_settings_dir: - :ref:`String` **get_settings_dir** **(** **)** const @@ -139,39 +139,39 @@ settings/tmp - used for temporary storage of files settings/templates - where export templates are located - .. _class_EditorSettings_has_setting: +.. _class_EditorSettings_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const - .. _class_EditorSettings_property_can_revert: +.. _class_EditorSettings_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** - .. _class_EditorSettings_property_get_revert: +.. _class_EditorSettings_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** - .. _class_EditorSettings_set_favorite_dirs: +.. _class_EditorSettings_set_favorites: -- void **set_favorite_dirs** **(** :ref:`PoolStringArray` dirs **)** +- void **set_favorites** **(** :ref:`PoolStringArray` dirs **)** -Set the list of favorite directories for this project. +Set the list of favorite files and directories for this project. - .. _class_EditorSettings_set_initial_value: +.. _class_EditorSettings_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value, :ref:`bool` update_current **)** - .. _class_EditorSettings_set_project_metadata: +.. _class_EditorSettings_set_project_metadata: - void **set_project_metadata** **(** :ref:`String` section, :ref:`String` key, :ref:`Variant` data **)** - .. _class_EditorSettings_set_recent_dirs: +.. _class_EditorSettings_set_recent_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: +.. _class_EditorSettings_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index a1f702b46..40fd4ece2 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -57,17 +57,17 @@ Custom gizmo that is used for providing custom visualization and editing (handle Method Descriptions ------------------- - .. _class_EditorSpatialGizmo_add_collision_segments: +.. _class_EditorSpatialGizmo_add_collision_segments: - void **add_collision_segments** **(** :ref:`PoolVector3Array` segments **)** - .. _class_EditorSpatialGizmo_add_collision_triangles: +.. _class_EditorSpatialGizmo_add_collision_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`. - .. _class_EditorSpatialGizmo_add_handles: +.. _class_EditorSpatialGizmo_add_handles: - void **add_handles** **(** :ref:`PoolVector3Array` handles, :ref:`Material` material, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** @@ -75,27 +75,27 @@ Add a list of handles (points) which can be used to deform the object being edit There are virtual functions which will be called upon editing of these handles. Call this function during :ref:`redraw`. - .. _class_EditorSpatialGizmo_add_lines: +.. _class_EditorSpatialGizmo_add_lines: - 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: +.. _class_EditorSpatialGizmo_add_mesh: - void **add_mesh** **(** :ref:`ArrayMesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton **)** - .. _class_EditorSpatialGizmo_add_unscaled_billboard: +.. _class_EditorSpatialGizmo_add_unscaled_billboard: - void **add_unscaled_billboard** **(** :ref:`Material` material, :ref:`float` default_scale=1 **)** Add an unscaled billboard for visualization. Call this function during :ref:`redraw`. - .. _class_EditorSpatialGizmo_clear: +.. _class_EditorSpatialGizmo_clear: - void **clear** **(** **)** - .. _class_EditorSpatialGizmo_commit_handle: +.. _class_EditorSpatialGizmo_commit_handle: - void **commit_handle** **(** :ref:`int` index, :ref:`Variant` restore, :ref:`bool` cancel=false **)** virtual @@ -103,7 +103,7 @@ Commit a handle being edited (handles must have been previously added by :ref:`a If the cancel parameter is true, an option to restore the edited value to the original is provided. - .. _class_EditorSpatialGizmo_get_handle_name: +.. _class_EditorSpatialGizmo_get_handle_name: - :ref:`String` **get_handle_name** **(** :ref:`int` index **)** virtual @@ -111,19 +111,19 @@ Get the name of an edited handle (handles must have been previously added by :re Handles can be named for reference to the user when editing. - .. _class_EditorSpatialGizmo_get_handle_value: +.. _class_EditorSpatialGizmo_get_handle_value: - :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` - .. _class_EditorSpatialGizmo_redraw: +.. _class_EditorSpatialGizmo_redraw: - void **redraw** **(** **)** virtual This function is called when the Spatial this gizmo refers to changes (the :ref:`Spatial.update_gizmo` is called). - .. _class_EditorSpatialGizmo_set_handle: +.. _class_EditorSpatialGizmo_set_handle: - void **set_handle** **(** :ref:`int` index, :ref:`Camera` camera, :ref:`Vector2` point **)** virtual @@ -131,11 +131,11 @@ This function is used when the user drags a gizmo handle (previously added with The :ref:`Camera` is also provided so screen coordinates can be converted to raycasts. - .. _class_EditorSpatialGizmo_set_hidden: +.. _class_EditorSpatialGizmo_set_hidden: - void **set_hidden** **(** :ref:`bool` hidden **)** - .. _class_EditorSpatialGizmo_set_spatial_node: +.. _class_EditorSpatialGizmo_set_spatial_node: - void **set_spatial_node** **(** :ref:`Node` node **)** diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index b0921bd71..8e56b9535 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -28,11 +28,11 @@ Methods Method Descriptions ------------------- - .. _class_EncodedObjectAsID_get_object_id: +.. _class_EncodedObjectAsID_get_object_id: - :ref:`int` **get_object_id** **(** **)** const - .. _class_EncodedObjectAsID_set_object_id: +.. _class_EncodedObjectAsID_set_object_id: - void **set_object_id** **(** :ref:`int` id **)** diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 8cd1c84bf..ba31746ea 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -68,7 +68,7 @@ The ``Engine`` class allows you to query and modify the game's run-time paramete Property Descriptions --------------------- - .. _class_Engine_editor_hint: +.. _class_Engine_editor_hint: - :ref:`bool` **editor_hint** @@ -80,7 +80,7 @@ Property Descriptions If ``true``, it is running inside the editor. Useful for tool scripts. - .. _class_Engine_iterations_per_second: +.. _class_Engine_iterations_per_second: - :ref:`int` **iterations_per_second** @@ -92,7 +92,7 @@ If ``true``, it is running inside the editor. Useful for tool scripts. The number of fixed iterations per second (for fixed process and physics). - .. _class_Engine_physics_jitter_fix: +.. _class_Engine_physics_jitter_fix: - :ref:`float` **physics_jitter_fix** @@ -102,7 +102,7 @@ The number of fixed iterations per second (for fixed process and physics). | *Getter* | get_physics_jitter_fix() | +----------+-------------------------------+ - .. _class_Engine_target_fps: +.. _class_Engine_target_fps: - :ref:`int` **target_fps** @@ -114,7 +114,7 @@ The number of fixed iterations per second (for fixed process and physics). The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit. - .. _class_Engine_time_scale: +.. _class_Engine_time_scale: - :ref:`float` **time_scale** @@ -129,7 +129,7 @@ Controls how fast or slow the in-game clock ticks versus the real life one. It d Method Descriptions ------------------- - .. _class_Engine_get_author_info: +.. _class_Engine_get_author_info: - :ref:`Dictionary` **get_author_info** **(** **)** const @@ -143,7 +143,7 @@ Returns engine author information in a Dictionary. "developers" - Array of Strings, developer names - .. _class_Engine_get_copyright_info: +.. _class_Engine_get_copyright_info: - :ref:`Array` **get_copyright_info** **(** **)** const @@ -153,7 +153,7 @@ Returns an Array of copyright information Dictionaries. "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component - .. _class_Engine_get_donor_info: +.. _class_Engine_get_donor_info: - :ref:`Dictionary` **get_donor_info** **(** **)** const @@ -161,41 +161,41 @@ Returns a Dictionary of Arrays of donor names. {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"} - .. _class_Engine_get_frames_drawn: +.. _class_Engine_get_frames_drawn: - :ref:`int` **get_frames_drawn** **(** **)** Returns the total number of frames drawn. - .. _class_Engine_get_frames_per_second: +.. _class_Engine_get_frames_per_second: - :ref:`float` **get_frames_per_second** **(** **)** const Returns the frames per second of the running game. - .. _class_Engine_get_license_info: +.. _class_Engine_get_license_info: - :ref:`Dictionary` **get_license_info** **(** **)** const Returns Dictionary of licenses used by Godot and included third party components. - .. _class_Engine_get_license_text: +.. _class_Engine_get_license_text: - :ref:`String` **get_license_text** **(** **)** const Returns Godot license text. - .. _class_Engine_get_main_loop: +.. _class_Engine_get_main_loop: - :ref:`MainLoop` **get_main_loop** **(** **)** const Returns the main loop object (see :ref:`MainLoop` and :ref:`SceneTree`). - .. _class_Engine_get_singleton: +.. _class_Engine_get_singleton: - :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const - .. _class_Engine_get_version_info: +.. _class_Engine_get_version_info: - :ref:`Dictionary` **get_version_info** **(** **)** const @@ -213,11 +213,11 @@ Returns the current engine version information in a Dictionary. "string" - major + minor + patch + status + build in a single String - .. _class_Engine_has_singleton: +.. _class_Engine_has_singleton: - :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const - .. _class_Engine_is_in_physics_frame: +.. _class_Engine_is_in_physics_frame: - :ref:`bool` **is_in_physics_frame** **(** **)** const diff --git a/classes/class_environment.rst b/classes/class_environment.rst index bf7795966..635eccce1 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -180,7 +180,7 @@ Properties Enumerations ------------ - .. _enum_Environment_BGMode: +.. _enum_Environment_BGMode: enum **BGMode**: @@ -192,7 +192,7 @@ enum **BGMode**: - **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_Environment_DOFBlurQuality: enum **DOFBlurQuality**: @@ -200,7 +200,7 @@ enum **DOFBlurQuality**: - **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_Environment_GlowBlendMode: enum **GlowBlendMode**: @@ -209,7 +209,7 @@ enum **GlowBlendMode**: - **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_Environment_ToneMapper: enum **ToneMapper**: @@ -218,7 +218,7 @@ enum **ToneMapper**: - **TONE_MAPPER_FILMIC** = **2** --- Filmic tonemapper operator. - **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator. - .. _enum_Environment_SSAOBlur: +.. _enum_Environment_SSAOBlur: enum **SSAOBlur**: @@ -227,7 +227,7 @@ enum **SSAOBlur**: - **SSAO_BLUR_2x2** = **2** - **SSAO_BLUR_3x3** = **3** - .. _enum_Environment_SSAOQuality: +.. _enum_Environment_SSAOQuality: enum **SSAOQuality**: @@ -256,11 +256,13 @@ Tutorials --------- - :doc:`../tutorials/3d/environment_and_post_processing` + - :doc:`../tutorials/3d/high_dynamic_range` + Property Descriptions --------------------- - .. _class_Environment_adjustment_brightness: +.. _class_Environment_adjustment_brightness: - :ref:`float` **adjustment_brightness** @@ -272,7 +274,7 @@ Property Descriptions Global brightness value of the rendered scene (default value is 1). - .. _class_Environment_adjustment_color_correction: +.. _class_Environment_adjustment_color_correction: - :ref:`Texture` **adjustment_color_correction** @@ -284,7 +286,7 @@ Global brightness value of the rendered scene (default value is 1). Applies the provided :ref:`Texture` resource to affect the global color aspect of the rendered scene. - .. _class_Environment_adjustment_contrast: +.. _class_Environment_adjustment_contrast: - :ref:`float` **adjustment_contrast** @@ -296,7 +298,7 @@ Applies the provided :ref:`Texture` resource to affect the global Global contrast value of the rendered scene (default value is 1). - .. _class_Environment_adjustment_enabled: +.. _class_Environment_adjustment_enabled: - :ref:`bool` **adjustment_enabled** @@ -308,7 +310,7 @@ Global contrast value of the rendered scene (default value is 1). Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. - .. _class_Environment_adjustment_saturation: +.. _class_Environment_adjustment_saturation: - :ref:`float` **adjustment_saturation** @@ -320,7 +322,7 @@ Enables the adjustment\_\* options provided by this resource. If false, adjustme Global color saturation value of the rendered scene (default value is 1). - .. _class_Environment_ambient_light_color: +.. _class_Environment_ambient_light_color: - :ref:`Color` **ambient_light_color** @@ -332,7 +334,7 @@ Global color saturation value of the rendered scene (default value is 1). :ref:`Color` of the ambient light. - .. _class_Environment_ambient_light_energy: +.. _class_Environment_ambient_light_energy: - :ref:`float` **ambient_light_energy** @@ -344,7 +346,7 @@ Global color saturation value of the rendered scene (default value is 1). Energy of the ambient light. The higher the value, the stronger the light. - .. _class_Environment_ambient_light_sky_contribution: +.. _class_Environment_ambient_light_sky_contribution: - :ref:`float` **ambient_light_sky_contribution** @@ -356,7 +358,7 @@ Energy of the ambient light. The higher the value, the stronger the light. Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. - .. _class_Environment_auto_exposure_enabled: +.. _class_Environment_auto_exposure_enabled: - :ref:`bool` **auto_exposure_enabled** @@ -368,7 +370,7 @@ Defines the amount of light that the sky brings on the scene. A value of 0 means Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light. - .. _class_Environment_auto_exposure_max_luma: +.. _class_Environment_auto_exposure_max_luma: - :ref:`float` **auto_exposure_max_luma** @@ -380,7 +382,7 @@ Enables the tonemapping auto exposure mode of the scene renderer. If activated, Maximum luminance value for the auto exposure. - .. _class_Environment_auto_exposure_min_luma: +.. _class_Environment_auto_exposure_min_luma: - :ref:`float` **auto_exposure_min_luma** @@ -392,7 +394,7 @@ Maximum luminance value for the auto exposure. Minimum luminance value for the auto exposure. - .. _class_Environment_auto_exposure_scale: +.. _class_Environment_auto_exposure_scale: - :ref:`float` **auto_exposure_scale** @@ -404,7 +406,7 @@ Minimum luminance value for the auto exposure. Scale of the auto exposure effect. Affects the intensity of auto exposure. - .. _class_Environment_auto_exposure_speed: +.. _class_Environment_auto_exposure_speed: - :ref:`float` **auto_exposure_speed** @@ -416,7 +418,7 @@ Scale of the auto exposure effect. Affects the intensity of auto exposure. Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. - .. _class_Environment_background_canvas_max_layer: +.. _class_Environment_background_canvas_max_layer: - :ref:`int` **background_canvas_max_layer** @@ -428,7 +430,7 @@ Speed of the auto exposure effect. Affects the time needed for the camera to per Maximum layer id (if using Layer background mode). - .. _class_Environment_background_color: +.. _class_Environment_background_color: - :ref:`Color` **background_color** @@ -440,7 +442,7 @@ Maximum layer id (if using Layer background mode). Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). - .. _class_Environment_background_energy: +.. _class_Environment_background_energy: - :ref:`float` **background_energy** @@ -452,7 +454,7 @@ Color displayed for clear areas of the scene (if using Custom color or Color+Sky Power of light emitted by the background. - .. _class_Environment_background_mode: +.. _class_Environment_background_mode: - :ref:`BGMode` **background_mode** @@ -464,7 +466,7 @@ Power of light emitted by the background. Defines the mode of background. - .. _class_Environment_background_sky: +.. _class_Environment_background_sky: - :ref:`Sky` **background_sky** @@ -476,7 +478,7 @@ Defines the mode of background. :ref:`Sky` resource defined as background. - .. _class_Environment_background_sky_custom_fov: +.. _class_Environment_background_sky_custom_fov: - :ref:`float` **background_sky_custom_fov** @@ -488,7 +490,7 @@ Defines the mode of background. :ref:`Sky` resource's custom field of view. - .. _class_Environment_dof_blur_far_amount: +.. _class_Environment_dof_blur_far_amount: - :ref:`float` **dof_blur_far_amount** @@ -500,7 +502,7 @@ Defines the mode of background. Amount of far blur. - .. _class_Environment_dof_blur_far_distance: +.. _class_Environment_dof_blur_far_distance: - :ref:`float` **dof_blur_far_distance** @@ -512,7 +514,7 @@ Amount of far blur. Distance from the camera where the far blur effect affects the rendering. - .. _class_Environment_dof_blur_far_enabled: +.. _class_Environment_dof_blur_far_enabled: - :ref:`bool` **dof_blur_far_enabled** @@ -524,7 +526,7 @@ Distance from the camera where the far blur effect affects the rendering. Enables the far blur effect. - .. _class_Environment_dof_blur_far_quality: +.. _class_Environment_dof_blur_far_quality: - :ref:`DOFBlurQuality` **dof_blur_far_quality** @@ -536,7 +538,7 @@ Enables the far blur effect. Quality of the far blur quality. - .. _class_Environment_dof_blur_far_transition: +.. _class_Environment_dof_blur_far_transition: - :ref:`float` **dof_blur_far_transition** @@ -548,7 +550,7 @@ Quality of the far blur quality. Transition between no-blur area and far blur. - .. _class_Environment_dof_blur_near_amount: +.. _class_Environment_dof_blur_near_amount: - :ref:`float` **dof_blur_near_amount** @@ -560,7 +562,7 @@ Transition between no-blur area and far blur. Amount of near blur. - .. _class_Environment_dof_blur_near_distance: +.. _class_Environment_dof_blur_near_distance: - :ref:`float` **dof_blur_near_distance** @@ -572,7 +574,7 @@ Amount of near blur. Distance from the camera where the near blur effect affects the rendering. - .. _class_Environment_dof_blur_near_enabled: +.. _class_Environment_dof_blur_near_enabled: - :ref:`bool` **dof_blur_near_enabled** @@ -584,7 +586,7 @@ Distance from the camera where the near blur effect affects the rendering. Enables the near blur effect. - .. _class_Environment_dof_blur_near_quality: +.. _class_Environment_dof_blur_near_quality: - :ref:`DOFBlurQuality` **dof_blur_near_quality** @@ -596,7 +598,7 @@ Enables the near blur effect. Quality of the near blur quality. - .. _class_Environment_dof_blur_near_transition: +.. _class_Environment_dof_blur_near_transition: - :ref:`float` **dof_blur_near_transition** @@ -608,7 +610,7 @@ Quality of the near blur quality. Transition between near blur and no-blur area. - .. _class_Environment_fog_color: +.. _class_Environment_fog_color: - :ref:`Color` **fog_color** @@ -620,7 +622,7 @@ Transition between near blur and no-blur area. Fog's :ref:`Color`. - .. _class_Environment_fog_depth_begin: +.. _class_Environment_fog_depth_begin: - :ref:`float` **fog_depth_begin** @@ -632,7 +634,7 @@ Fog's :ref:`Color`. Fog's depth starting distance from the camera. - .. _class_Environment_fog_depth_curve: +.. _class_Environment_fog_depth_curve: - :ref:`float` **fog_depth_curve** @@ -644,7 +646,7 @@ Fog's depth starting distance from the camera. Value defining the fog depth intensity. - .. _class_Environment_fog_depth_enabled: +.. _class_Environment_fog_depth_enabled: - :ref:`bool` **fog_depth_enabled** @@ -656,7 +658,7 @@ Value defining the fog depth intensity. Enables the fog depth. - .. _class_Environment_fog_enabled: +.. _class_Environment_fog_enabled: - :ref:`bool` **fog_enabled** @@ -668,7 +670,7 @@ Enables the fog depth. Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. - .. _class_Environment_fog_height_curve: +.. _class_Environment_fog_height_curve: - :ref:`float` **fog_height_curve** @@ -680,7 +682,7 @@ Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually d Value defining the fog height intensity. - .. _class_Environment_fog_height_enabled: +.. _class_Environment_fog_height_enabled: - :ref:`bool` **fog_height_enabled** @@ -692,7 +694,7 @@ Value defining the fog height intensity. Enables the fog height. - .. _class_Environment_fog_height_max: +.. _class_Environment_fog_height_max: - :ref:`float` **fog_height_max** @@ -704,7 +706,7 @@ Enables the fog height. Maximum height of fog. - .. _class_Environment_fog_height_min: +.. _class_Environment_fog_height_min: - :ref:`float` **fog_height_min** @@ -716,7 +718,7 @@ Maximum height of fog. Minimum height of fog. - .. _class_Environment_fog_sun_amount: +.. _class_Environment_fog_sun_amount: - :ref:`float` **fog_sun_amount** @@ -728,7 +730,7 @@ Minimum height of fog. Amount of sun that affects the fog rendering. - .. _class_Environment_fog_sun_color: +.. _class_Environment_fog_sun_color: - :ref:`Color` **fog_sun_color** @@ -740,7 +742,7 @@ Amount of sun that affects the fog rendering. Sun :ref:`Color`. - .. _class_Environment_fog_transmit_curve: +.. _class_Environment_fog_transmit_curve: - :ref:`float` **fog_transmit_curve** @@ -752,7 +754,7 @@ Sun :ref:`Color`. Amount of light that the fog transmits. - .. _class_Environment_fog_transmit_enabled: +.. _class_Environment_fog_transmit_enabled: - :ref:`bool` **fog_transmit_enabled** @@ -764,7 +766,7 @@ Amount of light that the fog transmits. Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog. - .. _class_Environment_glow_bicubic_upscale: +.. _class_Environment_glow_bicubic_upscale: - :ref:`bool` **glow_bicubic_upscale** @@ -774,7 +776,7 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans | *Getter* | is_glow_bicubic_upscale_enabled() | +----------+-----------------------------------+ - .. _class_Environment_glow_blend_mode: +.. _class_Environment_glow_blend_mode: - :ref:`GlowBlendMode` **glow_blend_mode** @@ -786,7 +788,7 @@ Enables fog's light transmission. If enabled, lets reflections light to be trans Glow blending mode. - .. _class_Environment_glow_bloom: +.. _class_Environment_glow_bloom: - :ref:`float` **glow_bloom** @@ -798,7 +800,7 @@ Glow blending mode. Bloom value (global glow). - .. _class_Environment_glow_enabled: +.. _class_Environment_glow_enabled: - :ref:`bool` **glow_enabled** @@ -810,7 +812,7 @@ Bloom value (global glow). Enables glow rendering. - .. _class_Environment_glow_hdr_scale: +.. _class_Environment_glow_hdr_scale: - :ref:`float` **glow_hdr_scale** @@ -822,7 +824,7 @@ Enables glow rendering. Bleed scale of the HDR glow. - .. _class_Environment_glow_hdr_threshold: +.. _class_Environment_glow_hdr_threshold: - :ref:`float` **glow_hdr_threshold** @@ -834,7 +836,7 @@ Bleed scale of the HDR glow. Bleed threshold of the HDR glow. - .. _class_Environment_glow_intensity: +.. _class_Environment_glow_intensity: - :ref:`float` **glow_intensity** @@ -846,7 +848,7 @@ Bleed threshold of the HDR glow. Glow intensity. - .. _class_Environment_glow_levels/1: +.. _class_Environment_glow_levels/1: - :ref:`bool` **glow_levels/1** @@ -858,7 +860,7 @@ Glow intensity. First level of glow (most local). - .. _class_Environment_glow_levels/2: +.. _class_Environment_glow_levels/2: - :ref:`bool` **glow_levels/2** @@ -870,7 +872,7 @@ First level of glow (most local). Second level of glow. - .. _class_Environment_glow_levels/3: +.. _class_Environment_glow_levels/3: - :ref:`bool` **glow_levels/3** @@ -882,7 +884,7 @@ Second level of glow. Third level of glow. - .. _class_Environment_glow_levels/4: +.. _class_Environment_glow_levels/4: - :ref:`bool` **glow_levels/4** @@ -894,7 +896,7 @@ Third level of glow. Fourth level of glow. - .. _class_Environment_glow_levels/5: +.. _class_Environment_glow_levels/5: - :ref:`bool` **glow_levels/5** @@ -906,7 +908,7 @@ Fourth level of glow. Fifth level of glow. - .. _class_Environment_glow_levels/6: +.. _class_Environment_glow_levels/6: - :ref:`bool` **glow_levels/6** @@ -918,7 +920,7 @@ Fifth level of glow. Sixth level of glow. - .. _class_Environment_glow_levels/7: +.. _class_Environment_glow_levels/7: - :ref:`bool` **glow_levels/7** @@ -930,7 +932,7 @@ Sixth level of glow. Seventh level of glow (most global). - .. _class_Environment_glow_strength: +.. _class_Environment_glow_strength: - :ref:`float` **glow_strength** @@ -942,7 +944,7 @@ Seventh level of glow (most global). Glow strength. - .. _class_Environment_ss_reflections_depth_tolerance: +.. _class_Environment_ss_reflections_depth_tolerance: - :ref:`float` **ss_reflections_depth_tolerance** @@ -952,7 +954,7 @@ Glow strength. | *Getter* | get_ssr_depth_tolerance() | +----------+--------------------------------+ - .. _class_Environment_ss_reflections_enabled: +.. _class_Environment_ss_reflections_enabled: - :ref:`bool` **ss_reflections_enabled** @@ -962,7 +964,7 @@ Glow strength. | *Getter* | is_ssr_enabled() | +----------+------------------------+ - .. _class_Environment_ss_reflections_fade_in: +.. _class_Environment_ss_reflections_fade_in: - :ref:`float` **ss_reflections_fade_in** @@ -972,7 +974,7 @@ Glow strength. | *Getter* | get_ssr_fade_in() | +----------+------------------------+ - .. _class_Environment_ss_reflections_fade_out: +.. _class_Environment_ss_reflections_fade_out: - :ref:`float` **ss_reflections_fade_out** @@ -982,7 +984,7 @@ Glow strength. | *Getter* | get_ssr_fade_out() | +----------+-------------------------+ - .. _class_Environment_ss_reflections_max_steps: +.. _class_Environment_ss_reflections_max_steps: - :ref:`int` **ss_reflections_max_steps** @@ -992,7 +994,7 @@ Glow strength. | *Getter* | get_ssr_max_steps() | +----------+--------------------------+ - .. _class_Environment_ss_reflections_roughness: +.. _class_Environment_ss_reflections_roughness: - :ref:`bool` **ss_reflections_roughness** @@ -1002,7 +1004,7 @@ Glow strength. | *Getter* | is_ssr_rough() | +----------+----------------------+ - .. _class_Environment_ssao_ao_channel_affect: +.. _class_Environment_ssao_ao_channel_affect: - :ref:`float` **ssao_ao_channel_affect** @@ -1012,7 +1014,7 @@ Glow strength. | *Getter* | get_ssao_ao_channel_affect() | +----------+-----------------------------------+ - .. _class_Environment_ssao_bias: +.. _class_Environment_ssao_bias: - :ref:`float` **ssao_bias** @@ -1022,7 +1024,7 @@ Glow strength. | *Getter* | get_ssao_bias() | +----------+----------------------+ - .. _class_Environment_ssao_blur: +.. _class_Environment_ssao_blur: - :ref:`SSAOBlur` **ssao_blur** @@ -1032,7 +1034,7 @@ Glow strength. | *Getter* | is_ssao_blur_enabled() | +----------+------------------------+ - .. _class_Environment_ssao_color: +.. _class_Environment_ssao_color: - :ref:`Color` **ssao_color** @@ -1042,7 +1044,7 @@ Glow strength. | *Getter* | get_ssao_color() | +----------+-----------------------+ - .. _class_Environment_ssao_edge_sharpness: +.. _class_Environment_ssao_edge_sharpness: - :ref:`float` **ssao_edge_sharpness** @@ -1052,7 +1054,7 @@ Glow strength. | *Getter* | get_ssao_edge_sharpness() | +----------+--------------------------------+ - .. _class_Environment_ssao_enabled: +.. _class_Environment_ssao_enabled: - :ref:`bool` **ssao_enabled** @@ -1062,7 +1064,7 @@ Glow strength. | *Getter* | is_ssao_enabled() | +----------+-------------------------+ - .. _class_Environment_ssao_intensity: +.. _class_Environment_ssao_intensity: - :ref:`float` **ssao_intensity** @@ -1072,7 +1074,7 @@ Glow strength. | *Getter* | get_ssao_intensity() | +----------+---------------------------+ - .. _class_Environment_ssao_intensity2: +.. _class_Environment_ssao_intensity2: - :ref:`float` **ssao_intensity2** @@ -1082,7 +1084,7 @@ Glow strength. | *Getter* | get_ssao_intensity2() | +----------+----------------------------+ - .. _class_Environment_ssao_light_affect: +.. _class_Environment_ssao_light_affect: - :ref:`float` **ssao_light_affect** @@ -1092,7 +1094,7 @@ Glow strength. | *Getter* | get_ssao_direct_light_affect() | +----------+-------------------------------------+ - .. _class_Environment_ssao_quality: +.. _class_Environment_ssao_quality: - :ref:`SSAOQuality` **ssao_quality** @@ -1102,7 +1104,7 @@ Glow strength. | *Getter* | get_ssao_quality() | +----------+-------------------------+ - .. _class_Environment_ssao_radius: +.. _class_Environment_ssao_radius: - :ref:`float` **ssao_radius** @@ -1112,7 +1114,7 @@ Glow strength. | *Getter* | get_ssao_radius() | +----------+------------------------+ - .. _class_Environment_ssao_radius2: +.. _class_Environment_ssao_radius2: - :ref:`float` **ssao_radius2** @@ -1122,7 +1124,7 @@ Glow strength. | *Getter* | get_ssao_radius2() | +----------+-------------------------+ - .. _class_Environment_tonemap_exposure: +.. _class_Environment_tonemap_exposure: - :ref:`float` **tonemap_exposure** @@ -1134,7 +1136,7 @@ Glow strength. Default exposure for tonemap. - .. _class_Environment_tonemap_mode: +.. _class_Environment_tonemap_mode: - :ref:`ToneMapper` **tonemap_mode** @@ -1146,7 +1148,7 @@ Default exposure for tonemap. Tonemapping mode. - .. _class_Environment_tonemap_white: +.. _class_Environment_tonemap_white: - :ref:`float` **tonemap_white** diff --git a/classes/class_expression.rst b/classes/class_expression.rst index 230fb462a..824f25892 100644 --- a/classes/class_expression.rst +++ b/classes/class_expression.rst @@ -32,19 +32,19 @@ Methods Method Descriptions ------------------- - .. _class_Expression_execute: +.. _class_Expression_execute: - :ref:`Variant` **execute** **(** :ref:`Array` inputs=[ ], :ref:`Object` base_instance=null, :ref:`bool` show_error=true **)** - .. _class_Expression_get_error_text: +.. _class_Expression_get_error_text: - :ref:`String` **get_error_text** **(** **)** const - .. _class_Expression_has_execute_failed: +.. _class_Expression_has_execute_failed: - :ref:`bool` **has_execute_failed** **(** **)** const - .. _class_Expression_parse: +.. _class_Expression_parse: - :ref:`Error` **parse** **(** :ref:`String` expression, :ref:`PoolStringArray` input_names=PoolStringArray( ) **)** diff --git a/classes/class_file.rst b/classes/class_file.rst index 99de8ad84..7a309680a 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -117,7 +117,7 @@ Methods Enumerations ------------ - .. _enum_File_CompressionMode: +.. _enum_File_CompressionMode: enum **CompressionMode**: @@ -126,7 +126,7 @@ enum **CompressionMode**: - **COMPRESSION_ZSTD** = **2** --- Uses the Zstd compression method. - **COMPRESSION_GZIP** = **3** --- Uses the gzip compression method. - .. _enum_File_ModeFlags: +.. _enum_File_ModeFlags: enum **ModeFlags**: @@ -161,10 +161,11 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/filesystem` + Property Descriptions --------------------- - .. _class_File_endian_swap: +.. _class_File_endian_swap: - :ref:`bool` **endian_swap** @@ -181,259 +182,259 @@ Note that this is about the file format, not CPU type. This is always reset to ` Method Descriptions ------------------- - .. _class_File_close: +.. _class_File_close: - void **close** **(** **)** Closes the currently opened file. - .. _class_File_eof_reached: +.. _class_File_eof_reached: - :ref:`bool` **eof_reached** **(** **)** const Returns ``true`` if the file cursor has reached the end of the file. - .. _class_File_file_exists: +.. _class_File_file_exists: - :ref:`bool` **file_exists** **(** :ref:`String` path **)** const Returns ``true`` if the file exists in the given path. - .. _class_File_get_16: +.. _class_File_get_16: - :ref:`int` **get_16** **(** **)** const Returns the next 16 bits from the file as an integer. - .. _class_File_get_32: +.. _class_File_get_32: - :ref:`int` **get_32** **(** **)** const Returns the next 32 bits from the file as an integer. - .. _class_File_get_64: +.. _class_File_get_64: - :ref:`int` **get_64** **(** **)** const Returns the next 64 bits from the file as an integer. - .. _class_File_get_8: +.. _class_File_get_8: - :ref:`int` **get_8** **(** **)** const Returns the next 8 bits from the file as an integer. - .. _class_File_get_as_text: +.. _class_File_get_as_text: - :ref:`String` **get_as_text** **(** **)** const Returns the whole file as a :ref:`String`. - .. _class_File_get_buffer: +.. _class_File_get_buffer: - :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const Returns next ``len`` bytes of the file as a :ref:`PoolByteArray`. - .. _class_File_get_csv_line: +.. _class_File_get_csv_line: - :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). - .. _class_File_get_double: +.. _class_File_get_double: - :ref:`float` **get_double** **(** **)** const Returns the next 64 bits from the file as a floating point number. - .. _class_File_get_error: +.. _class_File_get_error: - :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`. - .. _class_File_get_float: +.. _class_File_get_float: - :ref:`float` **get_float** **(** **)** const Returns the next 32 bits from the file as a floating point number. - .. _class_File_get_len: +.. _class_File_get_len: - :ref:`int` **get_len** **(** **)** const Returns the size of the file in bytes. - .. _class_File_get_line: +.. _class_File_get_line: - :ref:`String` **get_line** **(** **)** const Returns the next line of the file as a :ref:`String`. - .. _class_File_get_md5: +.. _class_File_get_md5: - :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. - .. _class_File_get_modified_time: +.. _class_File_get_modified_time: - :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`. - .. _class_File_get_pascal_string: +.. _class_File_get_pascal_string: - :ref:`String` **get_pascal_string** **(** **)** Returns a :ref:`String` saved in Pascal format from the file. - .. _class_File_get_path: +.. _class_File_get_path: - :ref:`String` **get_path** **(** **)** const Returns the path as a :ref:`String` for the current open file. - .. _class_File_get_path_absolute: +.. _class_File_get_path_absolute: - :ref:`String` **get_path_absolute** **(** **)** const Returns the absolute path as a :ref:`String` for the current open file. - .. _class_File_get_position: +.. _class_File_get_position: - :ref:`int` **get_position** **(** **)** const Returns the file cursor's position. - .. _class_File_get_real: +.. _class_File_get_real: - :ref:`float` **get_real** **(** **)** const Returns the next bits from the file as a floating point number. - .. _class_File_get_sha256: +.. _class_File_get_sha256: - :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. - .. _class_File_get_var: +.. _class_File_get_var: - :ref:`Variant` **get_var** **(** **)** const Returns the next :ref:`Variant` value from the file. - .. _class_File_is_open: +.. _class_File_is_open: - :ref:`bool` **is_open** **(** **)** const Returns ``true`` if the file is currently opened. - .. _class_File_open: +.. _class_File_open: - :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** Opens the file for writing or reading, depending on the flags. - .. _class_File_open_compressed: +.. _class_File_open_compressed: - :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: +.. _class_File_open_encrypted: - :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: +.. _class_File_open_encrypted_with_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. - .. _class_File_seek: +.. _class_File_seek: - void **seek** **(** :ref:`int` position **)** Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). - .. _class_File_seek_end: +.. _class_File_seek_end: - void **seek_end** **(** :ref:`int` position=0 **)** Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. - .. _class_File_store_16: +.. _class_File_store_16: - void **store_16** **(** :ref:`int` value **)** Stores an integer as 16 bits in the file. - .. _class_File_store_32: +.. _class_File_store_32: - void **store_32** **(** :ref:`int` value **)** Stores an integer as 32 bits in the file. - .. _class_File_store_64: +.. _class_File_store_64: - void **store_64** **(** :ref:`int` value **)** Stores an integer as 64 bits in the file. - .. _class_File_store_8: +.. _class_File_store_8: - void **store_8** **(** :ref:`int` value **)** Stores an integer as 8 bits in the file. - .. _class_File_store_buffer: +.. _class_File_store_buffer: - void **store_buffer** **(** :ref:`PoolByteArray` buffer **)** Stores the given array of bytes in the file. - .. _class_File_store_double: +.. _class_File_store_double: - void **store_double** **(** :ref:`float` value **)** Stores a floating point number as 64 bits in the file. - .. _class_File_store_float: +.. _class_File_store_float: - void **store_float** **(** :ref:`float` value **)** Stores a floating point number as 32 bits in the file. - .. _class_File_store_line: +.. _class_File_store_line: - void **store_line** **(** :ref:`String` line **)** Stores the given :ref:`String` as a line in the file. - .. _class_File_store_pascal_string: +.. _class_File_store_pascal_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). - .. _class_File_store_real: +.. _class_File_store_real: - void **store_real** **(** :ref:`float` value **)** Stores a floating point number in the file. - .. _class_File_store_string: +.. _class_File_store_string: - void **store_string** **(** :ref:`String` string **)** Stores the given :ref:`String` in the file. - .. _class_File_store_var: +.. _class_File_store_var: - void **store_var** **(** :ref:`Variant` value **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 28d29ea3a..af078c358 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -70,19 +70,19 @@ Theme Properties Signals ------- - .. _class_FileDialog_dir_selected: +.. _class_FileDialog_dir_selected: - **dir_selected** **(** :ref:`String` dir **)** Event emitted when the user selects a directory. - .. _class_FileDialog_file_selected: +.. _class_FileDialog_file_selected: - **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: +.. _class_FileDialog_files_selected: - **files_selected** **(** :ref:`PoolStringArray` paths **)** @@ -91,7 +91,7 @@ Event emitted when the user selects multiple files. Enumerations ------------ - .. _enum_FileDialog_Access: +.. _enum_FileDialog_Access: enum **Access**: @@ -99,7 +99,7 @@ enum **Access**: - **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: +.. _enum_FileDialog_Mode: enum **Mode**: @@ -117,7 +117,7 @@ FileDialog is a preset dialog used to choose files and directories in the filesy Property Descriptions --------------------- - .. _class_FileDialog_access: +.. _class_FileDialog_access: - :ref:`Access` **access** @@ -127,7 +127,7 @@ Property Descriptions | *Getter* | get_access() | +----------+-------------------+ - .. _class_FileDialog_current_dir: +.. _class_FileDialog_current_dir: - :ref:`String` **current_dir** @@ -139,7 +139,7 @@ Property Descriptions The current working directory of the file dialog. - .. _class_FileDialog_current_file: +.. _class_FileDialog_current_file: - :ref:`String` **current_file** @@ -151,7 +151,7 @@ The current working directory of the file dialog. The currently selected file of the file dialog. - .. _class_FileDialog_current_path: +.. _class_FileDialog_current_path: - :ref:`String` **current_path** @@ -163,7 +163,7 @@ The currently selected file of the file dialog. The currently selected file path of the file dialog. - .. _class_FileDialog_filters: +.. _class_FileDialog_filters: - :ref:`PoolStringArray` **filters** @@ -173,7 +173,7 @@ The currently selected file path of the file dialog. | *Getter* | get_filters() | +----------+--------------------+ - .. _class_FileDialog_mode: +.. _class_FileDialog_mode: - :ref:`Mode` **mode** @@ -183,7 +183,7 @@ The currently selected file path of the file dialog. | *Getter* | get_mode() | +----------+-----------------+ - .. _class_FileDialog_mode_overrides_title: +.. _class_FileDialog_mode_overrides_title: - :ref:`bool` **mode_overrides_title** @@ -195,7 +195,7 @@ The currently selected file path of the file dialog. 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: +.. _class_FileDialog_show_hidden_files: - :ref:`bool` **show_hidden_files** @@ -208,33 +208,33 @@ If ``true``, changing the ``mode`` property will set the window title accordingl Method Descriptions ------------------- - .. _class_FileDialog_add_filter: +.. _class_FileDialog_add_filter: - void **add_filter** **(** :ref:`String` filter **)** Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images"); - .. _class_FileDialog_clear_filters: +.. _class_FileDialog_clear_filters: - void **clear_filters** **(** **)** Clear all the added filters in the dialog. - .. _class_FileDialog_deselect_items: +.. _class_FileDialog_deselect_items: - void **deselect_items** **(** **)** - .. _class_FileDialog_get_line_edit: +.. _class_FileDialog_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** - .. _class_FileDialog_get_vbox: +.. _class_FileDialog_get_vbox: - :ref:`VBoxContainer` **get_vbox** **(** **)** Return the vertical box container of the dialog, custom controls can be added to it. - .. _class_FileDialog_invalidate: +.. _class_FileDialog_invalidate: - void **invalidate** **(** **)** diff --git a/classes/class_float.rst b/classes/class_float.rst index 20e6f2993..fe752f641 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -33,19 +33,19 @@ Float built-in type. Method Descriptions ------------------- - .. _class_float_float: +.. _class_float_float: - :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating point value, ``float(true)`` will be equals to 1.0 and ``float(false)`` will be equals to 0.0. - .. _class_float_float: +.. _class_float_float: - :ref:`float` **float** **(** :ref:`int` from **)** Cast an :ref:`int` value to a floating point value, ``float(1)`` will be equals to 1.0. - .. _class_float_float: +.. _class_float_float: - :ref:`float` **float** **(** :ref:`String` from **)** diff --git a/classes/class_font.rst b/classes/class_font.rst index 9d3e1fcd3..b6632b56d 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -49,51 +49,51 @@ Font contains a unicode compatible character set, as well as the ability to draw Method Descriptions ------------------- - .. _class_Font_draw: +.. _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 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: +.. _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 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. - .. _class_Font_get_ascent: +.. _class_Font_get_ascent: - :ref:`float` **get_ascent** **(** **)** const Return the font ascent (number of pixels above the baseline). - .. _class_Font_get_descent: +.. _class_Font_get_descent: - :ref:`float` **get_descent** **(** **)** const Return the font descent (number of pixels below the baseline). - .. _class_Font_get_height: +.. _class_Font_get_height: - :ref:`float` **get_height** **(** **)** const Return the total font height (ascent plus descent) in pixels. - .. _class_Font_get_string_size: +.. _class_Font_get_string_size: - :ref:`Vector2` **get_string_size** **(** :ref:`String` string **)** const Return the size of a string, taking kerning and advance into account. - .. _class_Font_has_outline: +.. _class_Font_has_outline: - :ref:`bool` **has_outline** **(** **)** const - .. _class_Font_is_distance_field_hint: +.. _class_Font_is_distance_field_hint: - :ref:`bool` **is_distance_field_hint** **(** **)** const - .. _class_Font_update_changes: +.. _class_Font_update_changes: - void **update_changes** **(** **)** diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 64dcfd8e1..94b0f7e29 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -37,19 +37,19 @@ However, by creating a ``FuncRef`` using the :ref:`@GDScript.funcref` **call_func** **(** **)** vararg Calls the referenced function previously set by :ref:`set_function` or :ref:`@GDScript.funcref`. - .. _class_FuncRef_set_function: +.. _class_FuncRef_set_function: - 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: +.. _class_FuncRef_set_instance: - void **set_instance** **(** :ref:`Object` instance **)** diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 887196dd3..c33f098e3 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -37,7 +37,7 @@ Methods Property Descriptions --------------------- - .. _class_GDNative_library: +.. _class_GDNative_library: - :ref:`GDNativeLibrary` **library** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- - .. _class_GDNative_call_native: +.. _class_GDNative_call_native: - :ref:`Variant` **call_native** **(** :ref:`String` calling_type, :ref:`String` procedure_name, :ref:`Array` arguments **)** - .. _class_GDNative_initialize: +.. _class_GDNative_initialize: - :ref:`bool` **initialize** **(** **)** - .. _class_GDNative_terminate: +.. _class_GDNative_terminate: - :ref:`bool` **terminate** **(** **)** diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index faf253567..436f68b38 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -43,7 +43,7 @@ Methods Property Descriptions --------------------- - .. _class_GDNativeLibrary_config_file: +.. _class_GDNativeLibrary_config_file: - :ref:`ConfigFile` **config_file** @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | get_config_file() | +----------+------------------------+ - .. _class_GDNativeLibrary_load_once: +.. _class_GDNativeLibrary_load_once: - :ref:`bool` **load_once** @@ -63,7 +63,7 @@ Property Descriptions | *Getter* | should_load_once() | +----------+----------------------+ - .. _class_GDNativeLibrary_reloadable: +.. _class_GDNativeLibrary_reloadable: - :ref:`bool` **reloadable** @@ -73,7 +73,7 @@ Property Descriptions | *Getter* | is_reloadable() | +----------+-----------------------+ - .. _class_GDNativeLibrary_singleton: +.. _class_GDNativeLibrary_singleton: - :ref:`bool` **singleton** @@ -83,7 +83,7 @@ Property Descriptions | *Getter* | is_singleton() | +----------+----------------------+ - .. _class_GDNativeLibrary_symbol_prefix: +.. _class_GDNativeLibrary_symbol_prefix: - :ref:`String` **symbol_prefix** @@ -96,11 +96,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_GDNativeLibrary_get_current_dependencies: +.. _class_GDNativeLibrary_get_current_dependencies: - :ref:`PoolStringArray` **get_current_dependencies** **(** **)** const - .. _class_GDNativeLibrary_get_current_library_path: +.. _class_GDNativeLibrary_get_current_library_path: - :ref:`String` **get_current_library_path** **(** **)** const diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 174043c4f..aebcbc2fa 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -36,16 +36,17 @@ Tutorials --------- - :doc:`../getting_started/scripting/gdscript/index` + Method Descriptions ------------------- - .. _class_GDScript_get_as_byte_code: +.. _class_GDScript_get_as_byte_code: - :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const Returns byte code for the script source code. - .. _class_GDScript_new: +.. _class_GDScript_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_gdscriptfunctionstate.rst b/classes/class_gdscriptfunctionstate.rst index 5b4310a1b..7a5471b0d 100644 --- a/classes/class_gdscriptfunctionstate.rst +++ b/classes/class_gdscriptfunctionstate.rst @@ -28,7 +28,7 @@ Methods Signals ------- - .. _class_GDScriptFunctionState_completed: +.. _class_GDScriptFunctionState_completed: - **completed** **(** :ref:`Nil` result **)** @@ -40,7 +40,7 @@ Calling :ref:`@GDScript.yield` within a function will cau Method Descriptions ------------------- - .. _class_GDScriptFunctionState_is_valid: +.. _class_GDScriptFunctionState_is_valid: - :ref:`bool` **is_valid** **(** :ref:`bool` extended_check=false **)** const @@ -48,7 +48,7 @@ Check whether the function call may be resumed. This is not the case if the func If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDScriptFunctionState.resume`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. - .. _class_GDScriptFunctionState_resume: +.. _class_GDScriptFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Variant` arg=null **)** diff --git a/classes/class_gdscriptnativeclass.rst b/classes/class_gdscriptnativeclass.rst index 159acc89b..f83baaa38 100644 --- a/classes/class_gdscriptnativeclass.rst +++ b/classes/class_gdscriptnativeclass.rst @@ -26,7 +26,7 @@ Methods Method Descriptions ------------------- - .. _class_GDScriptNativeClass_new: +.. _class_GDScriptNativeClass_new: - :ref:`Variant` **new** **(** **)** diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 4c16e365b..9c614cb2b 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -144,7 +144,7 @@ Properties Enumerations ------------ - .. _enum_Generic6DOFJoint_Flag: +.. _enum_Generic6DOFJoint_Flag: enum **Flag**: @@ -154,7 +154,7 @@ enum **Flag**: - **FLAG_ENABLE_LINEAR_MOTOR** = **3** - **FLAG_MAX** = **4** --- End flag of FLAG\_\* constants, used internally. - .. _enum_Generic6DOFJoint_Param: +.. _enum_Generic6DOFJoint_Param: enum **Param**: @@ -184,7 +184,7 @@ The first 3 DOF axes are linear axes, which represent translation of Bodies, and Property Descriptions --------------------- - .. _class_Generic6DOFJoint_angular_limit_x/damping: +.. _class_Generic6DOFJoint_angular_limit_x/damping: - :ref:`float` **angular_limit_x/damping** @@ -198,7 +198,7 @@ The amount of rotational damping across the x-axis. The lower, the longer an impulse from one side takes to travel to the other side. - .. _class_Generic6DOFJoint_angular_limit_x/enabled: +.. _class_Generic6DOFJoint_angular_limit_x/enabled: - :ref:`bool` **angular_limit_x/enabled** @@ -210,7 +210,7 @@ The lower, the longer an impulse from one side takes to travel to the other side If ``true`` rotation across the x-axis is limited. - .. _class_Generic6DOFJoint_angular_limit_x/erp: +.. _class_Generic6DOFJoint_angular_limit_x/erp: - :ref:`float` **angular_limit_x/erp** @@ -222,7 +222,7 @@ If ``true`` rotation across the x-axis is limited. When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - .. _class_Generic6DOFJoint_angular_limit_x/force_limit: +.. _class_Generic6DOFJoint_angular_limit_x/force_limit: - :ref:`float` **angular_limit_x/force_limit** @@ -234,13 +234,13 @@ When rotating across x-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around x-axis. - .. _class_Generic6DOFJoint_angular_limit_x/lower_angle: +.. _class_Generic6DOFJoint_angular_limit_x/lower_angle: - :ref:`float` **angular_limit_x/lower_angle** The minimum rotation in negative direction to break loose and rotate around the x-axis. - .. _class_Generic6DOFJoint_angular_limit_x/restitution: +.. _class_Generic6DOFJoint_angular_limit_x/restitution: - :ref:`float` **angular_limit_x/restitution** @@ -252,7 +252,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. - .. _class_Generic6DOFJoint_angular_limit_x/softness: +.. _class_Generic6DOFJoint_angular_limit_x/softness: - :ref:`float` **angular_limit_x/softness** @@ -264,13 +264,13 @@ The amount of rotational restitution across the x-axis. The lower, the more rest The speed of all rotations across the x-axis. - .. _class_Generic6DOFJoint_angular_limit_x/upper_angle: +.. _class_Generic6DOFJoint_angular_limit_x/upper_angle: - :ref:`float` **angular_limit_x/upper_angle** The minimum rotation in positive direction to break loose and rotate around the x-axis. - .. _class_Generic6DOFJoint_angular_limit_y/damping: +.. _class_Generic6DOFJoint_angular_limit_y/damping: - :ref:`float` **angular_limit_y/damping** @@ -282,7 +282,7 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the y-axis. The lower, the more dampening occurs. - .. _class_Generic6DOFJoint_angular_limit_y/enabled: +.. _class_Generic6DOFJoint_angular_limit_y/enabled: - :ref:`bool` **angular_limit_y/enabled** @@ -294,7 +294,7 @@ The amount of rotational damping across the y-axis. The lower, the more dampenin If ``true`` rotation across the y-axis is limited. - .. _class_Generic6DOFJoint_angular_limit_y/erp: +.. _class_Generic6DOFJoint_angular_limit_y/erp: - :ref:`float` **angular_limit_y/erp** @@ -306,7 +306,7 @@ If ``true`` rotation across the y-axis is limited. When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - .. _class_Generic6DOFJoint_angular_limit_y/force_limit: +.. _class_Generic6DOFJoint_angular_limit_y/force_limit: - :ref:`float` **angular_limit_y/force_limit** @@ -318,13 +318,13 @@ When rotating across y-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around y-axis. - .. _class_Generic6DOFJoint_angular_limit_y/lower_angle: +.. _class_Generic6DOFJoint_angular_limit_y/lower_angle: - :ref:`float` **angular_limit_y/lower_angle** The minimum rotation in negative direction to break loose and rotate around the y-axis. - .. _class_Generic6DOFJoint_angular_limit_y/restitution: +.. _class_Generic6DOFJoint_angular_limit_y/restitution: - :ref:`float` **angular_limit_y/restitution** @@ -336,7 +336,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. - .. _class_Generic6DOFJoint_angular_limit_y/softness: +.. _class_Generic6DOFJoint_angular_limit_y/softness: - :ref:`float` **angular_limit_y/softness** @@ -348,13 +348,13 @@ The amount of rotational restitution across the y-axis. The lower, the more rest The speed of all rotations across the y-axis. - .. _class_Generic6DOFJoint_angular_limit_y/upper_angle: +.. _class_Generic6DOFJoint_angular_limit_y/upper_angle: - :ref:`float` **angular_limit_y/upper_angle** The minimum rotation in positive direction to break loose and rotate around the y-axis. - .. _class_Generic6DOFJoint_angular_limit_z/damping: +.. _class_Generic6DOFJoint_angular_limit_z/damping: - :ref:`float` **angular_limit_z/damping** @@ -366,7 +366,7 @@ The minimum rotation in positive direction to break loose and rotate around the The amount of rotational damping across the z-axis. The lower, the more dampening occurs. - .. _class_Generic6DOFJoint_angular_limit_z/enabled: +.. _class_Generic6DOFJoint_angular_limit_z/enabled: - :ref:`bool` **angular_limit_z/enabled** @@ -378,7 +378,7 @@ The amount of rotational damping across the z-axis. The lower, the more dampenin If ``true`` rotation across the z-axis is limited. - .. _class_Generic6DOFJoint_angular_limit_z/erp: +.. _class_Generic6DOFJoint_angular_limit_z/erp: - :ref:`float` **angular_limit_z/erp** @@ -390,7 +390,7 @@ If ``true`` rotation across the z-axis is limited. When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - .. _class_Generic6DOFJoint_angular_limit_z/force_limit: +.. _class_Generic6DOFJoint_angular_limit_z/force_limit: - :ref:`float` **angular_limit_z/force_limit** @@ -402,13 +402,13 @@ When rotating across z-axis, this error tolerance factor defines how much the co The maximum amount of force that can occur, when rotating around z-axis. - .. _class_Generic6DOFJoint_angular_limit_z/lower_angle: +.. _class_Generic6DOFJoint_angular_limit_z/lower_angle: - :ref:`float` **angular_limit_z/lower_angle** The minimum rotation in negative direction to break loose and rotate around the z-axis. - .. _class_Generic6DOFJoint_angular_limit_z/restitution: +.. _class_Generic6DOFJoint_angular_limit_z/restitution: - :ref:`float` **angular_limit_z/restitution** @@ -420,7 +420,7 @@ The minimum rotation in negative direction to break loose and rotate around the The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. - .. _class_Generic6DOFJoint_angular_limit_z/softness: +.. _class_Generic6DOFJoint_angular_limit_z/softness: - :ref:`float` **angular_limit_z/softness** @@ -432,13 +432,13 @@ The amount of rotational restitution across the z-axis. The lower, the more rest The speed of all rotations across the z-axis. - .. _class_Generic6DOFJoint_angular_limit_z/upper_angle: +.. _class_Generic6DOFJoint_angular_limit_z/upper_angle: - :ref:`float` **angular_limit_z/upper_angle** The minimum rotation in positive direction to break loose and rotate around the z-axis. - .. _class_Generic6DOFJoint_angular_motor_x/enabled: +.. _class_Generic6DOFJoint_angular_motor_x/enabled: - :ref:`bool` **angular_motor_x/enabled** @@ -450,7 +450,7 @@ The minimum rotation in positive direction to break loose and rotate around the If ``true`` a rotating motor at the x-axis is enabled. - .. _class_Generic6DOFJoint_angular_motor_x/force_limit: +.. _class_Generic6DOFJoint_angular_motor_x/force_limit: - :ref:`float` **angular_motor_x/force_limit** @@ -462,7 +462,7 @@ If ``true`` a rotating motor at the x-axis is enabled. Maximum acceleration for the motor at the x-axis. - .. _class_Generic6DOFJoint_angular_motor_x/target_velocity: +.. _class_Generic6DOFJoint_angular_motor_x/target_velocity: - :ref:`float` **angular_motor_x/target_velocity** @@ -474,7 +474,7 @@ Maximum acceleration for the motor at the x-axis. Target speed for the motor at the x-axis. - .. _class_Generic6DOFJoint_angular_motor_y/enabled: +.. _class_Generic6DOFJoint_angular_motor_y/enabled: - :ref:`bool` **angular_motor_y/enabled** @@ -486,7 +486,7 @@ Target speed for the motor at the x-axis. If ``true`` a rotating motor at the y-axis is enabled. - .. _class_Generic6DOFJoint_angular_motor_y/force_limit: +.. _class_Generic6DOFJoint_angular_motor_y/force_limit: - :ref:`float` **angular_motor_y/force_limit** @@ -498,7 +498,7 @@ If ``true`` a rotating motor at the y-axis is enabled. Maximum acceleration for the motor at the y-axis. - .. _class_Generic6DOFJoint_angular_motor_y/target_velocity: +.. _class_Generic6DOFJoint_angular_motor_y/target_velocity: - :ref:`float` **angular_motor_y/target_velocity** @@ -510,7 +510,7 @@ Maximum acceleration for the motor at the y-axis. Target speed for the motor at the y-axis. - .. _class_Generic6DOFJoint_angular_motor_z/enabled: +.. _class_Generic6DOFJoint_angular_motor_z/enabled: - :ref:`bool` **angular_motor_z/enabled** @@ -522,7 +522,7 @@ Target speed for the motor at the y-axis. If ``true`` a rotating motor at the z-axis is enabled. - .. _class_Generic6DOFJoint_angular_motor_z/force_limit: +.. _class_Generic6DOFJoint_angular_motor_z/force_limit: - :ref:`float` **angular_motor_z/force_limit** @@ -534,7 +534,7 @@ If ``true`` a rotating motor at the z-axis is enabled. Maximum acceleration for the motor at the z-axis. - .. _class_Generic6DOFJoint_angular_motor_z/target_velocity: +.. _class_Generic6DOFJoint_angular_motor_z/target_velocity: - :ref:`float` **angular_motor_z/target_velocity** @@ -546,7 +546,7 @@ Maximum acceleration for the motor at the z-axis. Target speed for the motor at the z-axis. - .. _class_Generic6DOFJoint_linear_limit_x/damping: +.. _class_Generic6DOFJoint_linear_limit_x/damping: - :ref:`float` **linear_limit_x/damping** @@ -558,7 +558,7 @@ Target speed for the motor at the z-axis. The amount of damping that happens at the x-motion. - .. _class_Generic6DOFJoint_linear_limit_x/enabled: +.. _class_Generic6DOFJoint_linear_limit_x/enabled: - :ref:`bool` **linear_limit_x/enabled** @@ -570,7 +570,7 @@ The amount of damping that happens at the x-motion. If ``true`` the linear motion across the x-axis is limited. - .. _class_Generic6DOFJoint_linear_limit_x/lower_distance: +.. _class_Generic6DOFJoint_linear_limit_x/lower_distance: - :ref:`float` **linear_limit_x/lower_distance** @@ -582,7 +582,7 @@ If ``true`` the linear motion across the x-axis is limited. The minimum difference between the pivot points' x-axis. - .. _class_Generic6DOFJoint_linear_limit_x/restitution: +.. _class_Generic6DOFJoint_linear_limit_x/restitution: - :ref:`float` **linear_limit_x/restitution** @@ -594,7 +594,7 @@ The minimum difference between the pivot points' x-axis. The amount of restitution on the x-axis movement The lower, the more momentum gets lost. - .. _class_Generic6DOFJoint_linear_limit_x/softness: +.. _class_Generic6DOFJoint_linear_limit_x/softness: - :ref:`float` **linear_limit_x/softness** @@ -606,7 +606,7 @@ The amount of restitution on the x-axis movement The lower, the more momentum ge A factor applied to the movement across the x-axis The lower, the slower the movement. - .. _class_Generic6DOFJoint_linear_limit_x/upper_distance: +.. _class_Generic6DOFJoint_linear_limit_x/upper_distance: - :ref:`float` **linear_limit_x/upper_distance** @@ -618,7 +618,7 @@ A factor applied to the movement across the x-axis The lower, the slower the mov The maximum difference between the pivot points' x-axis. - .. _class_Generic6DOFJoint_linear_limit_y/damping: +.. _class_Generic6DOFJoint_linear_limit_y/damping: - :ref:`float` **linear_limit_y/damping** @@ -630,7 +630,7 @@ The maximum difference between the pivot points' x-axis. The amount of damping that happens at the y-motion. - .. _class_Generic6DOFJoint_linear_limit_y/enabled: +.. _class_Generic6DOFJoint_linear_limit_y/enabled: - :ref:`bool` **linear_limit_y/enabled** @@ -642,7 +642,7 @@ The amount of damping that happens at the y-motion. If ``true`` the linear motion across the y-axis is limited. - .. _class_Generic6DOFJoint_linear_limit_y/lower_distance: +.. _class_Generic6DOFJoint_linear_limit_y/lower_distance: - :ref:`float` **linear_limit_y/lower_distance** @@ -654,7 +654,7 @@ If ``true`` the linear motion across the y-axis is limited. The minimum difference between the pivot points' y-axis. - .. _class_Generic6DOFJoint_linear_limit_y/restitution: +.. _class_Generic6DOFJoint_linear_limit_y/restitution: - :ref:`float` **linear_limit_y/restitution** @@ -666,7 +666,7 @@ The minimum difference between the pivot points' y-axis. The amount of restitution on the y-axis movement The lower, the more momentum gets lost. - .. _class_Generic6DOFJoint_linear_limit_y/softness: +.. _class_Generic6DOFJoint_linear_limit_y/softness: - :ref:`float` **linear_limit_y/softness** @@ -678,7 +678,7 @@ The amount of restitution on the y-axis movement The lower, the more momentum ge A factor applied to the movement across the y-axis The lower, the slower the movement. - .. _class_Generic6DOFJoint_linear_limit_y/upper_distance: +.. _class_Generic6DOFJoint_linear_limit_y/upper_distance: - :ref:`float` **linear_limit_y/upper_distance** @@ -690,7 +690,7 @@ A factor applied to the movement across the y-axis The lower, the slower the mov The maximum difference between the pivot points' y-axis. - .. _class_Generic6DOFJoint_linear_limit_z/damping: +.. _class_Generic6DOFJoint_linear_limit_z/damping: - :ref:`float` **linear_limit_z/damping** @@ -702,7 +702,7 @@ The maximum difference between the pivot points' y-axis. The amount of damping that happens at the z-motion. - .. _class_Generic6DOFJoint_linear_limit_z/enabled: +.. _class_Generic6DOFJoint_linear_limit_z/enabled: - :ref:`bool` **linear_limit_z/enabled** @@ -714,7 +714,7 @@ The amount of damping that happens at the z-motion. If ``true`` the linear motion across the z-axis is limited. - .. _class_Generic6DOFJoint_linear_limit_z/lower_distance: +.. _class_Generic6DOFJoint_linear_limit_z/lower_distance: - :ref:`float` **linear_limit_z/lower_distance** @@ -726,7 +726,7 @@ If ``true`` the linear motion across the z-axis is limited. The minimum difference between the pivot points' z-axis. - .. _class_Generic6DOFJoint_linear_limit_z/restitution: +.. _class_Generic6DOFJoint_linear_limit_z/restitution: - :ref:`float` **linear_limit_z/restitution** @@ -738,7 +738,7 @@ The minimum difference between the pivot points' z-axis. The amount of restitution on the z-axis movement The lower, the more momentum gets lost. - .. _class_Generic6DOFJoint_linear_limit_z/softness: +.. _class_Generic6DOFJoint_linear_limit_z/softness: - :ref:`float` **linear_limit_z/softness** @@ -750,7 +750,7 @@ The amount of restitution on the z-axis movement The lower, the more momentum ge A factor applied to the movement across the z-axis The lower, the slower the movement. - .. _class_Generic6DOFJoint_linear_limit_z/upper_distance: +.. _class_Generic6DOFJoint_linear_limit_z/upper_distance: - :ref:`float` **linear_limit_z/upper_distance** @@ -762,7 +762,7 @@ A factor applied to the movement across the z-axis The lower, the slower the mov The maximum difference between the pivot points' z-axis. - .. _class_Generic6DOFJoint_linear_motor_x/enabled: +.. _class_Generic6DOFJoint_linear_motor_x/enabled: - :ref:`bool` **linear_motor_x/enabled** @@ -774,7 +774,7 @@ The maximum difference between the pivot points' z-axis. If ``true`` then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. - .. _class_Generic6DOFJoint_linear_motor_x/force_limit: +.. _class_Generic6DOFJoint_linear_motor_x/force_limit: - :ref:`float` **linear_motor_x/force_limit** @@ -786,7 +786,7 @@ If ``true`` then there is a linear motor on the x-axis. It will attempt to reach The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. - .. _class_Generic6DOFJoint_linear_motor_x/target_velocity: +.. _class_Generic6DOFJoint_linear_motor_x/target_velocity: - :ref:`float` **linear_motor_x/target_velocity** @@ -798,7 +798,7 @@ The maximum force the linear motor can apply on the x-axis while trying to reach The speed that the linear motor will attempt to reach on the x-axis. - .. _class_Generic6DOFJoint_linear_motor_y/enabled: +.. _class_Generic6DOFJoint_linear_motor_y/enabled: - :ref:`bool` **linear_motor_y/enabled** @@ -810,7 +810,7 @@ The speed that the linear motor will attempt to reach on the x-axis. If ``true`` then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. - .. _class_Generic6DOFJoint_linear_motor_y/force_limit: +.. _class_Generic6DOFJoint_linear_motor_y/force_limit: - :ref:`float` **linear_motor_y/force_limit** @@ -822,7 +822,7 @@ If ``true`` then there is a linear motor on the y-axis. It will attempt to reach The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. - .. _class_Generic6DOFJoint_linear_motor_y/target_velocity: +.. _class_Generic6DOFJoint_linear_motor_y/target_velocity: - :ref:`float` **linear_motor_y/target_velocity** @@ -834,7 +834,7 @@ The maximum force the linear motor can apply on the y-axis while trying to reach The speed that the linear motor will attempt to reach on the y-axis. - .. _class_Generic6DOFJoint_linear_motor_z/enabled: +.. _class_Generic6DOFJoint_linear_motor_z/enabled: - :ref:`bool` **linear_motor_z/enabled** @@ -846,7 +846,7 @@ The speed that the linear motor will attempt to reach on the y-axis. If ``true`` then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. - .. _class_Generic6DOFJoint_linear_motor_z/force_limit: +.. _class_Generic6DOFJoint_linear_motor_z/force_limit: - :ref:`float` **linear_motor_z/force_limit** @@ -858,7 +858,7 @@ If ``true`` then there is a linear motor on the z-axis. It will attempt to reach The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. - .. _class_Generic6DOFJoint_linear_motor_z/target_velocity: +.. _class_Generic6DOFJoint_linear_motor_z/target_velocity: - :ref:`float` **linear_motor_z/target_velocity** diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index f84c16b8c..f2bc3ce1e 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -70,137 +70,137 @@ Methods Method Descriptions ------------------- - .. _class_Geometry_build_box_planes: +.. _class_Geometry_build_box_planes: - :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). - .. _class_Geometry_build_capsule_planes: +.. _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 **)** 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: +.. _class_Geometry_build_cylinder_planes: - :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). - .. _class_Geometry_clip_polygon: +.. _class_Geometry_clip_polygon: - :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: +.. _class_Geometry_convex_hull_2d: - :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. - .. _class_Geometry_get_closest_point_to_segment: +.. _class_Geometry_get_closest_point_to_segment: - :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: +.. _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 **)** 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: +.. _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 **)** 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: +.. _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 **)** 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: +.. _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 **)** 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: +.. _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 **)** 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: +.. _class_Geometry_get_uv84_normal_bit: - :ref:`int` **get_uv84_normal_bit** **(** :ref:`Vector3` normal **)** - .. _class_Geometry_line_intersects_line_2d: +.. _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 **)** 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: +.. _class_Geometry_make_atlas: - :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`. - .. _class_Geometry_point_is_inside_triangle: +.. _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 Returns if ``point`` is inside the triangle specified by ``a``, ``b`` and ``c``. - .. _class_Geometry_ray_intersects_triangle: +.. _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 **)** 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: +.. _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 **)** 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: +.. _class_Geometry_segment_intersects_convex: - :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. - .. _class_Geometry_segment_intersects_cylinder: +.. _class_Geometry_segment_intersects_cylinder: - :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. - .. _class_Geometry_segment_intersects_segment_2d: +.. _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 **)** 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: +.. _class_Geometry_segment_intersects_sphere: - :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. - .. _class_Geometry_segment_intersects_triangle: +.. _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 **)** 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: +.. _class_Geometry_triangulate_polygon: - :ref:`PoolIntArray` **triangulate_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 367e6213d..9936f1c47 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -42,7 +42,7 @@ Properties Enumerations ------------ - .. _enum_GeometryInstance_Flags: +.. _enum_GeometryInstance_Flags: enum **Flags**: @@ -51,7 +51,7 @@ enum **Flags**: Added documentation for GeometryInstance and VisualInstance - **FLAG_MAX** = **2** - .. _enum_GeometryInstance_ShadowCastingSetting: +.. _enum_GeometryInstance_ShadowCastingSetting: enum **ShadowCastingSetting**: @@ -74,7 +74,7 @@ Base node for geometry based visual instances. Shares some common functionality Property Descriptions --------------------- - .. _class_GeometryInstance_cast_shadow: +.. _class_GeometryInstance_cast_shadow: - :ref:`ShadowCastingSetting` **cast_shadow** @@ -86,7 +86,7 @@ Property Descriptions The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for values. - .. _class_GeometryInstance_extra_cull_margin: +.. _class_GeometryInstance_extra_cull_margin: - :ref:`float` **extra_cull_margin** @@ -98,7 +98,7 @@ The selected shadow casting flag. See SHADOW_CASTING_SETTING\_\* constants for v The extra distance added to the GeometryInstance's bounding box (:ref:`AABB`) to increase its cull box. - .. _class_GeometryInstance_lod_max_distance: +.. _class_GeometryInstance_lod_max_distance: - :ref:`float` **lod_max_distance** @@ -110,7 +110,7 @@ The extra distance added to the GeometryInstance's bounding box (:ref:`AABB` **lod_max_hysteresis** @@ -122,7 +122,7 @@ The GeometryInstance's max LOD distance. The GeometryInstance's max LOD margin. - .. _class_GeometryInstance_lod_min_distance: +.. _class_GeometryInstance_lod_min_distance: - :ref:`float` **lod_min_distance** @@ -134,7 +134,7 @@ The GeometryInstance's max LOD margin. The GeometryInstance's min LOD distance. - .. _class_GeometryInstance_lod_min_hysteresis: +.. _class_GeometryInstance_lod_min_hysteresis: - :ref:`float` **lod_min_hysteresis** @@ -146,7 +146,7 @@ The GeometryInstance's min LOD distance. The GeometryInstance's min LOD margin. - .. _class_GeometryInstance_material_override: +.. _class_GeometryInstance_material_override: - :ref:`Material` **material_override** @@ -160,7 +160,7 @@ 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: +.. _class_GeometryInstance_use_in_baked_light: - :ref:`bool` **use_in_baked_light** diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index e984645ee..a990b5a7c 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -53,7 +53,7 @@ Methods Enumerations ------------ - .. _enum_GIProbe_Subdiv: +.. _enum_GIProbe_Subdiv: enum **Subdiv**: @@ -67,10 +67,11 @@ Tutorials --------- - :doc:`../tutorials/3d/gi_probes` + Property Descriptions --------------------- - .. _class_GIProbe_bias: +.. _class_GIProbe_bias: - :ref:`float` **bias** @@ -80,7 +81,7 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ - .. _class_GIProbe_compress: +.. _class_GIProbe_compress: - :ref:`bool` **compress** @@ -90,7 +91,7 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ - .. _class_GIProbe_data: +.. _class_GIProbe_data: - :ref:`GIProbeData` **data** @@ -100,7 +101,7 @@ Property Descriptions | *Getter* | get_probe_data() | +----------+-----------------------+ - .. _class_GIProbe_dynamic_range: +.. _class_GIProbe_dynamic_range: - :ref:`int` **dynamic_range** @@ -110,7 +111,7 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ - .. _class_GIProbe_energy: +.. _class_GIProbe_energy: - :ref:`float` **energy** @@ -120,7 +121,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ - .. _class_GIProbe_extents: +.. _class_GIProbe_extents: - :ref:`Vector3` **extents** @@ -130,7 +131,7 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ - .. _class_GIProbe_interior: +.. _class_GIProbe_interior: - :ref:`bool` **interior** @@ -140,7 +141,7 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ - .. _class_GIProbe_normal_bias: +.. _class_GIProbe_normal_bias: - :ref:`float` **normal_bias** @@ -150,7 +151,7 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ - .. _class_GIProbe_propagation: +.. _class_GIProbe_propagation: - :ref:`float` **propagation** @@ -160,7 +161,7 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ - .. _class_GIProbe_subdiv: +.. _class_GIProbe_subdiv: - :ref:`Subdiv` **subdiv** @@ -173,11 +174,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_GIProbe_bake: +.. _class_GIProbe_bake: - void **bake** **(** :ref:`Node` from_node=null, :ref:`bool` create_visual_debug=false **)** - .. _class_GIProbe_debug_bake: +.. _class_GIProbe_debug_bake: - void **debug_bake** **(** **)** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index c7e8a9466..ab02f88a7 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -46,7 +46,7 @@ Properties Property Descriptions --------------------- - .. _class_GIProbeData_bias: +.. _class_GIProbeData_bias: - :ref:`float` **bias** @@ -56,7 +56,7 @@ Property Descriptions | *Getter* | get_bias() | +----------+-----------------+ - .. _class_GIProbeData_bounds: +.. _class_GIProbeData_bounds: - :ref:`AABB` **bounds** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_bounds() | +----------+-------------------+ - .. _class_GIProbeData_cell_size: +.. _class_GIProbeData_cell_size: - :ref:`float` **cell_size** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ - .. _class_GIProbeData_compress: +.. _class_GIProbeData_compress: - :ref:`bool` **compress** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | is_compressed() | +----------+---------------------+ - .. _class_GIProbeData_dynamic_data: +.. _class_GIProbeData_dynamic_data: - :ref:`PoolIntArray` **dynamic_data** @@ -96,7 +96,7 @@ Property Descriptions | *Getter* | get_dynamic_data() | +----------+-------------------------+ - .. _class_GIProbeData_dynamic_range: +.. _class_GIProbeData_dynamic_range: - :ref:`int` **dynamic_range** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | get_dynamic_range() | +----------+--------------------------+ - .. _class_GIProbeData_energy: +.. _class_GIProbeData_energy: - :ref:`float` **energy** @@ -116,7 +116,7 @@ Property Descriptions | *Getter* | get_energy() | +----------+-------------------+ - .. _class_GIProbeData_interior: +.. _class_GIProbeData_interior: - :ref:`bool` **interior** @@ -126,7 +126,7 @@ Property Descriptions | *Getter* | is_interior() | +----------+---------------------+ - .. _class_GIProbeData_normal_bias: +.. _class_GIProbeData_normal_bias: - :ref:`float` **normal_bias** @@ -136,7 +136,7 @@ Property Descriptions | *Getter* | get_normal_bias() | +----------+------------------------+ - .. _class_GIProbeData_propagation: +.. _class_GIProbeData_propagation: - :ref:`float` **propagation** @@ -146,7 +146,7 @@ Property Descriptions | *Getter* | get_propagation() | +----------+------------------------+ - .. _class_GIProbeData_to_cell_xform: +.. _class_GIProbeData_to_cell_xform: - :ref:`Transform` **to_cell_xform** diff --git a/classes/class_godotsharp.rst b/classes/class_godotsharp.rst index a2bce4bfb..fbbf6027a 100644 --- a/classes/class_godotsharp.rst +++ b/classes/class_godotsharp.rst @@ -32,25 +32,25 @@ Methods Method Descriptions ------------------- - .. _class_GodotSharp_attach_thread: +.. _class_GodotSharp_attach_thread: - void **attach_thread** **(** **)** Attaches the current thread to the mono runtime. - .. _class_GodotSharp_detach_thread: +.. _class_GodotSharp_detach_thread: - void **detach_thread** **(** **)** Detaches the current thread from the mono runtime. - .. _class_GodotSharp_is_domain_loaded: +.. _class_GodotSharp_is_domain_loaded: - :ref:`bool` **is_domain_loaded** **(** **)** Returns whether the scripts domain is loaded. - .. _class_GodotSharp_is_finalizing_domain: +.. _class_GodotSharp_is_finalizing_domain: - :ref:`bool` **is_finalizing_domain** **(** **)** diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 256c89860..182554a68 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -54,7 +54,7 @@ Given a set of colors, this node will interpolate them in order, meaning, that i Property Descriptions --------------------- - .. _class_Gradient_colors: +.. _class_Gradient_colors: - :ref:`PoolColorArray` **colors** @@ -66,7 +66,7 @@ Property Descriptions Gradient's colors returned as a :ref:`PoolColorArray`. - .. _class_Gradient_offsets: +.. _class_Gradient_offsets: - :ref:`PoolRealArray` **offsets** @@ -81,49 +81,49 @@ Gradient's offsets returned as a :ref:`PoolRealArray`. Method Descriptions ------------------- - .. _class_Gradient_add_point: +.. _class_Gradient_add_point: - 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: +.. _class_Gradient_get_color: - :ref:`Color` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* - .. _class_Gradient_get_offset: +.. _class_Gradient_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* - .. _class_Gradient_get_point_count: +.. _class_Gradient_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the number of colors in the ramp - .. _class_Gradient_interpolate: +.. _class_Gradient_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* - .. _class_Gradient_remove_point: +.. _class_Gradient_remove_point: - void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* - .. _class_Gradient_set_color: +.. _class_Gradient_set_color: - void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** Sets the color of the ramp color at index *point* - .. _class_Gradient_set_offset: +.. _class_Gradient_set_offset: - void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 94e02867d..bcb9a78b4 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -33,7 +33,7 @@ Uses a :ref:`Gradient` to fill the texture data, the gradient wi Property Descriptions --------------------- - .. _class_GradientTexture_gradient: +.. _class_GradientTexture_gradient: - :ref:`Gradient` **gradient** @@ -45,7 +45,7 @@ Property Descriptions The :ref:`Gradient` that will be used to fill the texture. - .. _class_GradientTexture_width: +.. _class_GradientTexture_width: - :ref:`int` **width** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 65d0da3ca..0255d4ff5 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -98,59 +98,59 @@ Theme Properties Signals ------- - .. _class_GraphEdit__begin_node_move: +.. _class_GraphEdit__begin_node_move: - **_begin_node_move** **(** **)** Signal sent at the beginning of a GraphNode movement. - .. _class_GraphEdit__end_node_move: +.. _class_GraphEdit__end_node_move: - **_end_node_move** **(** **)** Signal sent at the end of a GraphNode movement. - .. _class_GraphEdit_connection_request: +.. _class_GraphEdit_connection_request: - **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: +.. _class_GraphEdit_connection_to_empty: - **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** - .. _class_GraphEdit_delete_nodes_request: +.. _class_GraphEdit_delete_nodes_request: - **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. - .. _class_GraphEdit_disconnection_request: +.. _class_GraphEdit_disconnection_request: - **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. - .. _class_GraphEdit_duplicate_nodes_request: +.. _class_GraphEdit_duplicate_nodes_request: - **duplicate_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. - .. _class_GraphEdit_node_selected: +.. _class_GraphEdit_node_selected: - **node_selected** **(** :ref:`Node` node **)** Emitted when a GraphNode is selected. - .. _class_GraphEdit_popup_request: +.. _class_GraphEdit_popup_request: - **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: +.. _class_GraphEdit_scroll_offset_changed: - **scroll_offset_changed** **(** :ref:`Vector2` ofs **)** @@ -164,7 +164,7 @@ It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_p Property Descriptions --------------------- - .. _class_GraphEdit_right_disconnects: +.. _class_GraphEdit_right_disconnects: - :ref:`bool` **right_disconnects** @@ -176,7 +176,7 @@ Property Descriptions If ``true``, enables disconnection of existing connections in the GraphEdit by dragging the right end. - .. _class_GraphEdit_scroll_offset: +.. _class_GraphEdit_scroll_offset: - :ref:`Vector2` **scroll_offset** @@ -188,7 +188,7 @@ If ``true``, enables disconnection of existing connections in the GraphEdit by d The scroll offset. - .. _class_GraphEdit_snap_distance: +.. _class_GraphEdit_snap_distance: - :ref:`int` **snap_distance** @@ -200,7 +200,7 @@ The scroll offset. The snapping distance in pixels. - .. _class_GraphEdit_use_snap: +.. _class_GraphEdit_use_snap: - :ref:`bool` **use_snap** @@ -212,7 +212,7 @@ The snapping distance in pixels. If ``true``, enables snapping. - .. _class_GraphEdit_zoom: +.. _class_GraphEdit_zoom: - :ref:`float` **zoom** @@ -227,87 +227,87 @@ The current zoom value. Method Descriptions ------------------- - .. _class_GraphEdit_add_valid_connection_type: +.. _class_GraphEdit_add_valid_connection_type: - void **add_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** Makes possible the connection between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. - .. _class_GraphEdit_add_valid_left_disconnect_type: +.. _class_GraphEdit_add_valid_left_disconnect_type: - void **add_valid_left_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. - .. _class_GraphEdit_add_valid_right_disconnect_type: +.. _class_GraphEdit_add_valid_right_disconnect_type: - void **add_valid_right_disconnect_type** **(** :ref:`int` type **)** Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. - .. _class_GraphEdit_clear_connections: +.. _class_GraphEdit_clear_connections: - void **clear_connections** **(** **)** Remove all connections between nodes. - .. _class_GraphEdit_connect_node: +.. _class_GraphEdit_connect_node: - :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: +.. _class_GraphEdit_disconnect_node: - 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: +.. _class_GraphEdit_get_connection_list: - :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: +.. _class_GraphEdit_get_zoom_hbox: - :ref:`HBoxContainer` **get_zoom_hbox** **(** **)** - .. _class_GraphEdit_is_node_connected: +.. _class_GraphEdit_is_node_connected: - :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. - .. _class_GraphEdit_is_valid_connection_type: +.. _class_GraphEdit_is_valid_connection_type: - :ref:`bool` **is_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** const Returns whether it's possible to connect slots of the specified types. - .. _class_GraphEdit_remove_valid_connection_type: +.. _class_GraphEdit_remove_valid_connection_type: - void **remove_valid_connection_type** **(** :ref:`int` from_type, :ref:`int` to_type **)** Makes it not possible to connect between two different slot types. The type is defined with the :ref:`GraphNode.set_slot` method. - .. _class_GraphEdit_remove_valid_left_disconnect_type: +.. _class_GraphEdit_remove_valid_left_disconnect_type: - void **remove_valid_left_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. - .. _class_GraphEdit_remove_valid_right_disconnect_type: +.. _class_GraphEdit_remove_valid_right_disconnect_type: - void **remove_valid_right_disconnect_type** **(** :ref:`int` type **)** Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. - .. _class_GraphEdit_set_connection_activity: +.. _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 **)** - .. _class_GraphEdit_set_selected: +.. _class_GraphEdit_set_selected: - void **set_selected** **(** :ref:`Node` node **)** diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 24650316d..ae3fcfe78 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -116,38 +116,38 @@ Theme Properties Signals ------- - .. _class_GraphNode_close_request: +.. _class_GraphNode_close_request: - **close_request** **(** **)** Signal sent on closing the GraphNode. - .. _class_GraphNode_dragged: +.. _class_GraphNode_dragged: - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** Signal sent when the GraphNode is dragged. - .. _class_GraphNode_offset_changed: +.. _class_GraphNode_offset_changed: - **offset_changed** **(** **)** Signal sent when the GraphNode is moved. - .. _class_GraphNode_raise_request: +.. _class_GraphNode_raise_request: - **raise_request** **(** **)** Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. - .. _class_GraphNode_resize_request: +.. _class_GraphNode_resize_request: - **resize_request** **(** :ref:`Vector2` new_minsize **)** Enumerations ------------ - .. _enum_GraphNode_Overlay: +.. _enum_GraphNode_Overlay: enum **Overlay**: @@ -163,7 +163,7 @@ A GraphNode is a container defined by a title. It can have 1 or more input and o Property Descriptions --------------------- - .. _class_GraphNode_comment: +.. _class_GraphNode_comment: - :ref:`bool` **comment** @@ -173,7 +173,7 @@ Property Descriptions | *Getter* | is_comment() | +----------+--------------------+ - .. _class_GraphNode_offset: +.. _class_GraphNode_offset: - :ref:`Vector2` **offset** @@ -185,7 +185,7 @@ Property Descriptions 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: +.. _class_GraphNode_overlay: - :ref:`Overlay` **overlay** @@ -195,7 +195,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | get_overlay() | +----------+--------------------+ - .. _class_GraphNode_resizable: +.. _class_GraphNode_resizable: - :ref:`bool` **resizable** @@ -205,7 +205,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_resizable() | +----------+----------------------+ - .. _class_GraphNode_selected: +.. _class_GraphNode_selected: - :ref:`bool` **selected** @@ -215,7 +215,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_selected() | +----------+---------------------+ - .. _class_GraphNode_show_close: +.. _class_GraphNode_show_close: - :ref:`bool` **show_close** @@ -225,7 +225,7 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi | *Getter* | is_close_button_visible() | +----------+------------------------------+ - .. _class_GraphNode_title: +.. _class_GraphNode_title: - :ref:`String` **title** @@ -238,103 +238,103 @@ The offset of the GraphNode, relative to the scroll offset of the :ref:`GraphEdi Method Descriptions ------------------- - .. _class_GraphNode_clear_all_slots: +.. _class_GraphNode_clear_all_slots: - void **clear_all_slots** **(** **)** Disable all input and output slots of the GraphNode. - .. _class_GraphNode_clear_slot: +.. _class_GraphNode_clear_slot: - void **clear_slot** **(** :ref:`int` idx **)** Disable input and output slot whose index is 'idx'. - .. _class_GraphNode_get_connection_input_color: +.. _class_GraphNode_get_connection_input_color: - :ref:`Color` **get_connection_input_color** **(** :ref:`int` idx **)** Return the color of the input connection 'idx'. - .. _class_GraphNode_get_connection_input_count: +.. _class_GraphNode_get_connection_input_count: - :ref:`int` **get_connection_input_count** **(** **)** Return the number of enabled input slots (connections) to the GraphNode. - .. _class_GraphNode_get_connection_input_position: +.. _class_GraphNode_get_connection_input_position: - :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. - .. _class_GraphNode_get_connection_input_type: +.. _class_GraphNode_get_connection_input_type: - :ref:`int` **get_connection_input_type** **(** :ref:`int` idx **)** Return the type of the input connection 'idx'. - .. _class_GraphNode_get_connection_output_color: +.. _class_GraphNode_get_connection_output_color: - :ref:`Color` **get_connection_output_color** **(** :ref:`int` idx **)** Return the color of the output connection 'idx'. - .. _class_GraphNode_get_connection_output_count: +.. _class_GraphNode_get_connection_output_count: - :ref:`int` **get_connection_output_count** **(** **)** Return the number of enabled output slots (connections) of the GraphNode. - .. _class_GraphNode_get_connection_output_position: +.. _class_GraphNode_get_connection_output_position: - :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. - .. _class_GraphNode_get_connection_output_type: +.. _class_GraphNode_get_connection_output_type: - :ref:`int` **get_connection_output_type** **(** :ref:`int` idx **)** Return the type of the output connection 'idx'. - .. _class_GraphNode_get_slot_color_left: +.. _class_GraphNode_get_slot_color_left: - :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: +.. _class_GraphNode_get_slot_color_right: - :ref:`Color` **get_slot_color_right** **(** :ref:`int` idx **)** const Return the color set to 'idx' right (output) slot. - .. _class_GraphNode_get_slot_type_left: +.. _class_GraphNode_get_slot_type_left: - :ref:`int` **get_slot_type_left** **(** :ref:`int` idx **)** const Return the (integer) type of left (input) 'idx' slot. - .. _class_GraphNode_get_slot_type_right: +.. _class_GraphNode_get_slot_type_right: - :ref:`int` **get_slot_type_right** **(** :ref:`int` idx **)** const Return the (integer) type of right (output) 'idx' slot. - .. _class_GraphNode_is_slot_enabled_left: +.. _class_GraphNode_is_slot_enabled_left: - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const Return true if left (input) slot 'idx' is enabled. False otherwise. - .. _class_GraphNode_is_slot_enabled_right: +.. _class_GraphNode_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const Return true if right (output) slot 'idx' is enabled. False otherwise. - .. _class_GraphNode_set_slot: +.. _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 **)** diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index bd4156069..5e0710b03 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -47,7 +47,7 @@ Grid container will arrange its children in a grid like structure, the grid colu Property Descriptions --------------------- - .. _class_GridContainer_columns: +.. _class_GridContainer_columns: - :ref:`int` **columns** @@ -62,7 +62,7 @@ The number of columns in the ``GridContainer``. If modified, ``GridContainer`` r Method Descriptions ------------------- - .. _class_GridContainer_get_child_control_at_cell: +.. _class_GridContainer_get_child_control_at_cell: - :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 e94f31612..59ebc58fb 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -86,6 +86,7 @@ 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 ----------- @@ -101,10 +102,11 @@ Tutorials --------- - :doc:`../tutorials/3d/using_gridmaps` + Property Descriptions --------------------- - .. _class_GridMap_cell_center_x: +.. _class_GridMap_cell_center_x: - :ref:`bool` **cell_center_x** @@ -116,7 +118,7 @@ Property Descriptions If ``true`` grid items are centered on the X axis. - .. _class_GridMap_cell_center_y: +.. _class_GridMap_cell_center_y: - :ref:`bool` **cell_center_y** @@ -128,7 +130,7 @@ If ``true`` grid items are centered on the X axis. If ``true`` grid items are centered on the Y axis. - .. _class_GridMap_cell_center_z: +.. _class_GridMap_cell_center_z: - :ref:`bool` **cell_center_z** @@ -140,7 +142,7 @@ If ``true`` grid items are centered on the Y axis. If ``true`` grid items are centered on the Z axis. - .. _class_GridMap_cell_octant_size: +.. _class_GridMap_cell_octant_size: - :ref:`int` **cell_octant_size** @@ -152,7 +154,7 @@ If ``true`` grid items are centered on the Z axis. The size of each octant measured in number of cells. This applies to all three axis. - .. _class_GridMap_cell_scale: +.. _class_GridMap_cell_scale: - :ref:`float` **cell_scale** @@ -162,7 +164,7 @@ The size of each octant measured in number of cells. This applies to all three a | *Getter* | get_cell_scale() | +----------+-----------------------+ - .. _class_GridMap_cell_size: +.. _class_GridMap_cell_size: - :ref:`Vector3` **cell_size** @@ -174,7 +176,7 @@ The size of each octant measured in number of cells. This applies to all three a The dimensions of the grid's cells. - .. _class_GridMap_collision_layer: +.. _class_GridMap_collision_layer: - :ref:`int` **collision_layer** @@ -184,7 +186,7 @@ The dimensions of the grid's cells. | *Getter* | get_collision_layer() | +----------+----------------------------+ - .. _class_GridMap_collision_mask: +.. _class_GridMap_collision_mask: - :ref:`int` **collision_mask** @@ -194,7 +196,7 @@ The dimensions of the grid's cells. | *Getter* | get_collision_mask() | +----------+---------------------------+ - .. _class_GridMap_mesh_library: +.. _class_GridMap_mesh_library: - :ref:`MeshLibrary` **mesh_library** @@ -206,7 +208,7 @@ The dimensions of the grid's cells. The assigned :ref:`MeshLibrary`. - .. _class_GridMap_theme: +.. _class_GridMap_theme: - :ref:`MeshLibrary` **theme** @@ -221,69 +223,69 @@ Deprecated, use :ref:`mesh_library` instead. Method Descriptions ------------------- - .. _class_GridMap_clear: +.. _class_GridMap_clear: - void **clear** **(** **)** Clear all cells. - .. _class_GridMap_clear_baked_meshes: +.. _class_GridMap_clear_baked_meshes: - void **clear_baked_meshes** **(** **)** - .. _class_GridMap_get_bake_mesh_instance: +.. _class_GridMap_get_bake_mesh_instance: - :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** - .. _class_GridMap_get_bake_meshes: +.. _class_GridMap_get_bake_meshes: - :ref:`Array` **get_bake_meshes** **(** **)** - .. _class_GridMap_get_cell_item: +.. _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. - .. _class_GridMap_get_cell_item_orientation: +.. _class_GridMap_get_cell_item_orientation: - :ref:`int` **get_cell_item_orientation** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty. - .. _class_GridMap_get_collision_layer_bit: +.. _class_GridMap_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const - .. _class_GridMap_get_collision_mask_bit: +.. _class_GridMap_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const - .. _class_GridMap_get_meshes: +.. _class_GridMap_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. - .. _class_GridMap_get_used_cells: +.. _class_GridMap_get_used_cells: - :ref:`Array` **get_used_cells** **(** **)** const Array of :ref:`Vector3` with the non empty cell coordinates in the grid map. - .. _class_GridMap_make_baked_meshes: +.. _class_GridMap_make_baked_meshes: - void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** - .. _class_GridMap_map_to_world: +.. _class_GridMap_map_to_world: - :ref:`Vector3` **map_to_world** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z **)** const - .. _class_GridMap_resource_changed: +.. _class_GridMap_resource_changed: - void **resource_changed** **(** :ref:`Resource` resource **)** - .. _class_GridMap_set_cell_item: +.. _class_GridMap_set_cell_item: - void **set_cell_item** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` item, :ref:`int` orientation=0 **)** @@ -293,19 +295,19 @@ A negative item index will clear the cell. Optionally, the item's orientation can be passed. - .. _class_GridMap_set_clip: +.. _class_GridMap_set_clip: - void **set_clip** **(** :ref:`bool` enabled, :ref:`bool` clipabove=true, :ref:`int` floor=0, :ref:`Axis` axis=0 **)** - .. _class_GridMap_set_collision_layer_bit: +.. _class_GridMap_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** - .. _class_GridMap_set_collision_mask_bit: +.. _class_GridMap_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** - .. _class_GridMap_world_to_map: +.. _class_GridMap_world_to_map: - :ref:`Vector3` **world_to_map** **(** :ref:`Vector3` pos **)** const diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 13be9f83e..0c6bd1a5d 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -33,7 +33,7 @@ Groove constraint for 2D physics. This is useful for making a body "slide" throu Property Descriptions --------------------- - .. _class_GrooveJoint2D_initial_offset: +.. _class_GrooveJoint2D_initial_offset: - :ref:`float` **initial_offset** @@ -45,7 +45,7 @@ Property Descriptions The body B's initial anchor position defined by the joint's origin and a local offset :ref:`initial_offset` along the joint's y axis (along the groove). Default value: ``25`` - .. _class_GrooveJoint2D_length: +.. _class_GrooveJoint2D_length: - :ref:`float` **length** diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index c25c91c2e..fda4f2c66 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -44,7 +44,7 @@ Properties Enumerations ------------ - .. _enum_HingeJoint_Flag: +.. _enum_HingeJoint_Flag: enum **Flag**: @@ -52,7 +52,7 @@ enum **Flag**: - **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_HingeJoint_Param: enum **Param**: @@ -74,7 +74,7 @@ Normally uses the z-axis of body A as the hinge axis, another axis can be specif Property Descriptions --------------------- - .. _class_HingeJoint_angular_limit/bias: +.. _class_HingeJoint_angular_limit/bias: - :ref:`float` **angular_limit/bias** @@ -86,7 +86,7 @@ Property Descriptions The speed with which the rotation across the axis perpendicular to the hinge gets corrected. - .. _class_HingeJoint_angular_limit/enable: +.. _class_HingeJoint_angular_limit/enable: - :ref:`bool` **angular_limit/enable** @@ -98,13 +98,13 @@ The speed with which the rotation across the axis perpendicular to the hinge get If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. - .. _class_HingeJoint_angular_limit/lower: +.. _class_HingeJoint_angular_limit/lower: - :ref:`float` **angular_limit/lower** The minimum rotation. only active if :ref:`angular_limit/enable` is ``true``. - .. _class_HingeJoint_angular_limit/relaxation: +.. _class_HingeJoint_angular_limit/relaxation: - :ref:`float` **angular_limit/relaxation** @@ -116,7 +116,7 @@ The minimum rotation. only active if :ref:`angular_limit/enable` **angular_limit/softness** @@ -126,13 +126,13 @@ The lower this value, the more the rotation gets slowed down. | *Getter* | get_param() | +----------+------------------+ - .. _class_HingeJoint_angular_limit/upper: +.. _class_HingeJoint_angular_limit/upper: - :ref:`float` **angular_limit/upper** The maximum rotation. only active if :ref:`angular_limit/enable` is ``true``. - .. _class_HingeJoint_motor/enable: +.. _class_HingeJoint_motor/enable: - :ref:`bool` **motor/enable** @@ -144,7 +144,7 @@ The maximum rotation. only active if :ref:`angular_limit/enable` **motor/max_impulse** @@ -156,7 +156,7 @@ When activated, a motor turns the hinge. Maximum acceleration for the motor. - .. _class_HingeJoint_motor/target_velocity: +.. _class_HingeJoint_motor/target_velocity: - :ref:`float` **motor/target_velocity** @@ -168,7 +168,7 @@ Maximum acceleration for the motor. Target speed for the motor. - .. _class_HingeJoint_params/bias: +.. _class_HingeJoint_params/bias: - :ref:`float` **params/bias** diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index a9202e11e..33c98f6a4 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -63,7 +63,7 @@ Methods Enumerations ------------ - .. _enum_HTTPClient_Status: +.. _enum_HTTPClient_Status: enum **Status**: @@ -78,7 +78,7 @@ enum **Status**: - **STATUS_CONNECTION_ERROR** = **8** --- Status: Error in HTTP connection. - **STATUS_SSL_HANDSHAKE_ERROR** = **9** --- Status: Error in SSL handshake. - .. _enum_HTTPClient_Method: +.. _enum_HTTPClient_Method: enum **Method**: @@ -93,7 +93,7 @@ enum **Method**: - **METHOD_PATCH** = **8** --- HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. - **METHOD_MAX** = **9** --- Marker for end of ``METHOD_*`` enum. Not used. - .. _enum_HTTPClient_ResponseCode: +.. _enum_HTTPClient_ResponseCode: enum **ResponseCode**: @@ -174,11 +174,13 @@ Tutorials --------- - :doc:`../tutorials/networking/http_client_class` + - :doc:`../tutorials/networking/ssl_certificates` + Property Descriptions --------------------- - .. _class_HTTPClient_blocking_mode_enabled: +.. _class_HTTPClient_blocking_mode_enabled: - :ref:`bool` **blocking_mode_enabled** @@ -190,7 +192,7 @@ Property Descriptions If ``true``, execution will block until all data is read from the response. - .. _class_HTTPClient_connection: +.. _class_HTTPClient_connection: - :ref:`StreamPeer` **connection** @@ -205,13 +207,13 @@ The connection to use for this client. Method Descriptions ------------------- - .. _class_HTTPClient_close: +.. _class_HTTPClient_close: - void **close** **(** **)** Closes the current connection, allowing reuse of this ``HTTPClient``. - .. _class_HTTPClient_connect_to_host: +.. _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 **)** @@ -223,25 +225,25 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f ``verify_host`` will check the SSL identity of the host if set to ``true``. - .. _class_HTTPClient_get_response_body_length: +.. _class_HTTPClient_get_response_body_length: - :ref:`int` **get_response_body_length** **(** **)** const Returns the response's body length. - .. _class_HTTPClient_get_response_code: +.. _class_HTTPClient_get_response_code: - :ref:`int` **get_response_code** **(** **)** const Returns the response's HTTP status code. - .. _class_HTTPClient_get_response_headers: +.. _class_HTTPClient_get_response_headers: - :ref:`PoolStringArray` **get_response_headers** **(** **)** Returns the response headers. - .. _class_HTTPClient_get_response_headers_as_dictionary: +.. _class_HTTPClient_get_response_headers_as_dictionary: - :ref:`Dictionary` **get_response_headers_as_dictionary** **(** **)** @@ -251,31 +253,31 @@ Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - .. _class_HTTPClient_get_status: +.. _class_HTTPClient_get_status: - :ref:`Status` **get_status** **(** **)** const Returns a STATUS\_\* enum constant. Need to call :ref:`poll` in order to get status updates. - .. _class_HTTPClient_has_response: +.. _class_HTTPClient_has_response: - :ref:`bool` **has_response** **(** **)** const If ``true`` this ``HTTPClient`` has a response available. - .. _class_HTTPClient_is_response_chunked: +.. _class_HTTPClient_is_response_chunked: - :ref:`bool` **is_response_chunked** **(** **)** const If ``true`` this ``HTTPClient`` has a response that is chunked. - .. _class_HTTPClient_poll: +.. _class_HTTPClient_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: +.. _class_HTTPClient_query_string_from_dict: - :ref:`String` **query_string_from_dict** **(** :ref:`Dictionary` fields **)** @@ -295,13 +297,13 @@ Furthermore, if a key has a null value, only the key itself is added, without eq String queryString = httpClient.query_string_from_dict(fields) returns:= "single=123¬_valued&multiple=22&multiple=33&multiple=44" - .. _class_HTTPClient_read_response_body_chunk: +.. _class_HTTPClient_read_response_body_chunk: - :ref:`PoolByteArray` **read_response_body_chunk** **(** **)** Reads one chunk from the response. - .. _class_HTTPClient_request: +.. _class_HTTPClient_request: - :ref:`Error` **request** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`String` body="" **)** @@ -318,7 +320,7 @@ To create a POST request with query strings to push to the server, do: var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())] var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) - .. _class_HTTPClient_request_raw: +.. _class_HTTPClient_request_raw: - :ref:`Error` **request_raw** **(** :ref:`Method` method, :ref:`String` url, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -328,7 +330,7 @@ Headers are HTTP request headers. For available HTTP methods, see ``METHOD_*``. Sends the body data raw, as a byte array and does not encode it in any way. - .. _class_HTTPClient_set_read_chunk_size: +.. _class_HTTPClient_set_read_chunk_size: - void **set_read_chunk_size** **(** :ref:`int` bytes **)** diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 7840ea1c0..005fe19bf 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -47,7 +47,7 @@ Methods Signals ------- - .. _class_HTTPRequest_request_completed: +.. _class_HTTPRequest_request_completed: - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** @@ -56,7 +56,7 @@ This signal is emitted upon request completion. Enumerations ------------ - .. _enum_HTTPRequest_Result: +.. _enum_HTTPRequest_Result: enum **Result**: @@ -84,10 +84,11 @@ Tutorials --------- - :doc:`../tutorials/networking/ssl_certificates` + Property Descriptions --------------------- - .. _class_HTTPRequest_body_size_limit: +.. _class_HTTPRequest_body_size_limit: - :ref:`int` **body_size_limit** @@ -99,7 +100,7 @@ Property Descriptions Maximum allowed size for response bodies. - .. _class_HTTPRequest_download_file: +.. _class_HTTPRequest_download_file: - :ref:`String` **download_file** @@ -111,7 +112,7 @@ Maximum allowed size for response bodies. The file to download into. Will output any received file into it. - .. _class_HTTPRequest_max_redirects: +.. _class_HTTPRequest_max_redirects: - :ref:`int` **max_redirects** @@ -123,7 +124,7 @@ The file to download into. Will output any received file into it. Maximum number of allowed redirects. - .. _class_HTTPRequest_use_threads: +.. _class_HTTPRequest_use_threads: - :ref:`bool` **use_threads** @@ -138,31 +139,31 @@ If ``true`` multithreading is used to improve performance. Method Descriptions ------------------- - .. _class_HTTPRequest_cancel_request: +.. _class_HTTPRequest_cancel_request: - void **cancel_request** **(** **)** Cancels the current request. - .. _class_HTTPRequest_get_body_size: +.. _class_HTTPRequest_get_body_size: - :ref:`int` **get_body_size** **(** **)** const Returns the response body length. - .. _class_HTTPRequest_get_downloaded_bytes: +.. _class_HTTPRequest_get_downloaded_bytes: - :ref:`int` **get_downloaded_bytes** **(** **)** const Returns the amount of bytes this HTTPRequest downloaded. - .. _class_HTTPRequest_get_http_client_status: +.. _class_HTTPRequest_get_http_client_status: - :ref:`Status` **get_http_client_status** **(** **)** const Returns the current status of the underlying :ref:`HTTPClient`. See ``STATUS_*`` enum on :ref:`HTTPClient`. - .. _class_HTTPRequest_request: +.. _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="" **)** diff --git a/classes/class_image.rst b/classes/class_image.rst index c18380944..4820225b1 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -131,7 +131,7 @@ Methods Enumerations ------------ - .. _enum_Image_CompressMode: +.. _enum_Image_CompressMode: enum **CompressMode**: @@ -141,7 +141,7 @@ enum **CompressMode**: - **COMPRESS_ETC** = **3** - **COMPRESS_ETC2** = **4** - .. _enum_Image_Interpolation: +.. _enum_Image_Interpolation: enum **Interpolation**: @@ -156,7 +156,7 @@ If the image does not have mipmaps, they will be generated and used internally, On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. - .. _enum_Image_AlphaMode: +.. _enum_Image_AlphaMode: enum **AlphaMode**: @@ -164,7 +164,7 @@ enum **AlphaMode**: - **ALPHA_BIT** = **1** - **ALPHA_BLEND** = **2** - .. _enum_Image_CompressSource: +.. _enum_Image_CompressSource: enum **CompressSource**: @@ -172,7 +172,7 @@ enum **CompressSource**: - **COMPRESS_SOURCE_SRGB** = **1** - **COMPRESS_SOURCE_NORMAL** = **2** - .. _enum_Image_Format: +.. _enum_Image_Format: enum **Format**: @@ -223,7 +223,7 @@ Native image datatype. Contains image data, which can be converted to a :ref:`Te Property Descriptions --------------------- - .. _class_Image_data: +.. _class_Image_data: - :ref:`Dictionary` **data** @@ -232,271 +232,271 @@ Holds all of the image's color data in a given format. See ``FORMAT_*`` constant Method Descriptions ------------------- - .. _class_Image_blend_rect: +.. _class_Image_blend_rect: - 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: +.. _class_Image_blend_rect_mask: - 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: +.. _class_Image_blit_rect: - 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: +.. _class_Image_blit_rect_mask: - 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. - .. _class_Image_bumpmap_to_normalmap: +.. _class_Image_bumpmap_to_normalmap: - void **bumpmap_to_normalmap** **(** :ref:`float` bump_scale=1.0 **)** - .. _class_Image_clear_mipmaps: +.. _class_Image_clear_mipmaps: - void **clear_mipmaps** **(** **)** Removes the image's mipmaps. - .. _class_Image_compress: +.. _class_Image_compress: - :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: +.. _class_Image_convert: - void **convert** **(** :ref:`Format` format **)** Converts the image's format. See ``FORMAT_*`` constants. - .. _class_Image_copy_from: +.. _class_Image_copy_from: - void **copy_from** **(** :ref:`Image` src **)** Copies ``src`` image to this image. - .. _class_Image_create: +.. _class_Image_create: - 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: +.. _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 **)** 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. - .. _class_Image_crop: +.. _class_Image_crop: - void **crop** **(** :ref:`int` width, :ref:`int` height **)** Crops the image to the given ``width`` and ``height``. If the specified size is larger than the current size, the extra area is filled with black pixels. - .. _class_Image_decompress: +.. _class_Image_decompress: - :ref:`Error` **decompress** **(** **)** Decompresses the image if it is compressed. Returns an error if decompress function is not available. - .. _class_Image_detect_alpha: +.. _class_Image_detect_alpha: - :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. - .. _class_Image_expand_x2_hq2x: +.. _class_Image_expand_x2_hq2x: - void **expand_x2_hq2x** **(** **)** Stretches the image and enlarges it by a factor of 2. No interpolation is done. - .. _class_Image_fill: +.. _class_Image_fill: - void **fill** **(** :ref:`Color` color **)** Fills the image with a given :ref:`Color`. - .. _class_Image_fix_alpha_edges: +.. _class_Image_fix_alpha_edges: - void **fix_alpha_edges** **(** **)** Blends low-alpha pixels with nearby pixels. - .. _class_Image_flip_x: +.. _class_Image_flip_x: - void **flip_x** **(** **)** Flips the image horizontally. - .. _class_Image_flip_y: +.. _class_Image_flip_y: - void **flip_y** **(** **)** Flips the image vertically. - .. _class_Image_generate_mipmaps: +.. _class_Image_generate_mipmaps: - :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: +.. _class_Image_get_data: - :ref:`PoolByteArray` **get_data** **(** **)** const Returns the image's raw data. - .. _class_Image_get_format: +.. _class_Image_get_format: - :ref:`Format` **get_format** **(** **)** const Returns the image’s format. See ``FORMAT_*`` constants. - .. _class_Image_get_height: +.. _class_Image_get_height: - :ref:`int` **get_height** **(** **)** const Returns the image's height. - .. _class_Image_get_mipmap_offset: +.. _class_Image_get_mipmap_offset: - :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const Returns the offset where the image's mipmap with index ``mipmap`` is stored in the ``data`` dictionary. - .. _class_Image_get_pixel: +.. _class_Image_get_pixel: - :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)``. - .. _class_Image_get_pixelv: +.. _class_Image_get_pixelv: - :ref:`Color` **get_pixelv** **(** :ref:`Vector2` src **)** const - .. _class_Image_get_rect: +.. _class_Image_get_rect: - :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: +.. _class_Image_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns the image's size (width and height). - .. _class_Image_get_used_rect: +.. _class_Image_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** const Returns a :ref:`Rect2` enclosing the visible portion of the image. - .. _class_Image_get_width: +.. _class_Image_get_width: - :ref:`int` **get_width** **(** **)** const Returns the image's width. - .. _class_Image_has_mipmaps: +.. _class_Image_has_mipmaps: - :ref:`bool` **has_mipmaps** **(** **)** const Returns ``true`` if the image has generated mipmaps. - .. _class_Image_is_compressed: +.. _class_Image_is_compressed: - :ref:`bool` **is_compressed** **(** **)** const Returns ``true`` if the image is compressed. - .. _class_Image_is_empty: +.. _class_Image_is_empty: - :ref:`bool` **is_empty** **(** **)** const Returns ``true`` if the image has no data. - .. _class_Image_is_invisible: +.. _class_Image_is_invisible: - :ref:`bool` **is_invisible** **(** **)** const Returns ``true`` if all the image's pixels have an alpha value of 0. Returns ``false`` if any pixel has an alpha value higher than 0. - .. _class_Image_load: +.. _class_Image_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Loads an image from file ``path``. - .. _class_Image_load_jpg_from_buffer: +.. _class_Image_load_jpg_from_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: +.. _class_Image_load_png_from_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: +.. _class_Image_load_webp_from_buffer: - :ref:`Error` **load_webp_from_buffer** **(** :ref:`PoolByteArray` buffer **)** Loads an image from the binary contents of a WebP file. - .. _class_Image_lock: +.. _class_Image_lock: - void **lock** **(** **)** Locks the data for writing access. - .. _class_Image_normalmap_to_xy: +.. _class_Image_normalmap_to_xy: - void **normalmap_to_xy** **(** **)** Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count. - .. _class_Image_premultiply_alpha: +.. _class_Image_premultiply_alpha: - void **premultiply_alpha** **(** **)** Multiplies color values with alpha values. Resulting color values for a pixel are ``(color * alpha)/256``. - .. _class_Image_resize: +.. _class_Image_resize: - 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. - .. _class_Image_resize_to_po2: +.. _class_Image_resize_to_po2: - void **resize_to_po2** **(** :ref:`bool` square=false **)** Resizes the image to the nearest power of 2 for the width and height. If ``square`` is ``true`` then set width and height to be the same. - .. _class_Image_rgbe_to_srgb: +.. _class_Image_rgbe_to_srgb: - :ref:`Image` **rgbe_to_srgb** **(** **)** - .. _class_Image_save_png: +.. _class_Image_save_png: - :ref:`Error` **save_png** **(** :ref:`String` path **)** const Saves the image as a PNG file to ``path``. - .. _class_Image_set_pixel: +.. _class_Image_set_pixel: - void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** @@ -511,23 +511,23 @@ Sets the :ref:`Color` of the pixel at ``(x, y)`` if the image is lo img.unlock() img.set_pixel(x, y, color) # Does not have an effect - .. _class_Image_set_pixelv: +.. _class_Image_set_pixelv: - void **set_pixelv** **(** :ref:`Vector2` dst, :ref:`Color` color **)** - .. _class_Image_shrink_x2: +.. _class_Image_shrink_x2: - void **shrink_x2** **(** **)** Shrinks the image by a factor of 2. - .. _class_Image_srgb_to_linear: +.. _class_Image_srgb_to_linear: - void **srgb_to_linear** **(** **)** Converts the raw data from the sRGB colorspace to a linear scale. - .. _class_Image_unlock: +.. _class_Image_unlock: - void **unlock** **(** **)** diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 88ba28384..ee5620825 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -45,7 +45,7 @@ Methods Enumerations ------------ - .. _enum_ImageTexture_Storage: +.. _enum_ImageTexture_Storage: enum **Storage**: @@ -61,7 +61,7 @@ A :ref:`Texture` based on an :ref:`Image`. Can be cr Property Descriptions --------------------- - .. _class_ImageTexture_lossy_quality: +.. _class_ImageTexture_lossy_quality: - :ref:`float` **lossy_quality** @@ -73,7 +73,7 @@ Property Descriptions The storage quality for ``ImageTexture``.STORAGE_COMPRESS_LOSSY. - .. _class_ImageTexture_storage: +.. _class_ImageTexture_storage: - :ref:`Storage` **storage** @@ -88,7 +88,7 @@ The storage type (raw, lossy, or compressed). Method Descriptions ------------------- - .. _class_ImageTexture_create: +.. _class_ImageTexture_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`Format` format, :ref:`int` flags=7 **)** @@ -98,31 +98,31 @@ Create a new ``ImageTexture`` with "width" and "height". "flags" one or more of :ref:`Texture`.FLAG\_\*. - .. _class_ImageTexture_create_from_image: +.. _class_ImageTexture_create_from_image: - 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\_\*. - .. _class_ImageTexture_get_format: +.. _class_ImageTexture_get_format: - :ref:`Format` **get_format** **(** **)** const Return the format of the ``ImageTexture``, one of :ref:`Image`.FORMAT\_\*. - .. _class_ImageTexture_load: +.. _class_ImageTexture_load: - :ref:`Error` **load** **(** :ref:`String` path **)** Load an ``ImageTexture`` from a file path. - .. _class_ImageTexture_set_data: +.. _class_ImageTexture_set_data: - void **set_data** **(** :ref:`Image` image **)** Set the :ref:`Image` of this ``ImageTexture``. - .. _class_ImageTexture_set_size_override: +.. _class_ImageTexture_set_size_override: - void **set_size_override** **(** :ref:`Vector2` size **)** diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index ca68861ab..96a4ff8ee 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -49,19 +49,19 @@ Draws simple geometry from code. Uses a drawing mode similar to OpenGL 1.x. Method Descriptions ------------------- - .. _class_ImmediateGeometry_add_sphere: +.. _class_ImmediateGeometry_add_sphere: - void **add_sphere** **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** Simple helper to draw a uvsphere, with given latitudes, longitude and radius. - .. _class_ImmediateGeometry_add_vertex: +.. _class_ImmediateGeometry_add_vertex: - void **add_vertex** **(** :ref:`Vector3` position **)** Adds a vertex with the currently set color/uv/etc. - .. _class_ImmediateGeometry_begin: +.. _class_ImmediateGeometry_begin: - void **begin** **(** :ref:`PrimitiveType` primitive, :ref:`Texture` texture=null **)** @@ -69,43 +69,43 @@ Begin drawing (And optionally pass a texture override). When done call end(). Fo For the type of primitive, use the :ref:`Mesh`.PRIMITIVE\_\* enumerations. - .. _class_ImmediateGeometry_clear: +.. _class_ImmediateGeometry_clear: - void **clear** **(** **)** Clears everything that was drawn using begin/end. - .. _class_ImmediateGeometry_end: +.. _class_ImmediateGeometry_end: - void **end** **(** **)** Ends a drawing context and displays the results. - .. _class_ImmediateGeometry_set_color: +.. _class_ImmediateGeometry_set_color: - void **set_color** **(** :ref:`Color` color **)** The current drawing color. - .. _class_ImmediateGeometry_set_normal: +.. _class_ImmediateGeometry_set_normal: - void **set_normal** **(** :ref:`Vector3` normal **)** The next vertex's normal. - .. _class_ImmediateGeometry_set_tangent: +.. _class_ImmediateGeometry_set_tangent: - void **set_tangent** **(** :ref:`Plane` tangent **)** The next vertex's tangent (and binormal facing). - .. _class_ImmediateGeometry_set_uv: +.. _class_ImmediateGeometry_set_uv: - void **set_uv** **(** :ref:`Vector2` uv **)** The next vertex's UV. - .. _class_ImmediateGeometry_set_uv2: +.. _class_ImmediateGeometry_set_uv2: - void **set_uv2** **(** :ref:`Vector2` uv **)** diff --git a/classes/class_input.rst b/classes/class_input.rst index 31a6878a8..14525b6a0 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -100,7 +100,7 @@ Methods Signals ------- - .. _class_Input_joy_connection_changed: +.. _class_Input_joy_connection_changed: - **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected **)** @@ -109,7 +109,7 @@ Emitted when a joypad device has been connected or disconnected. Enumerations ------------ - .. _enum_Input_MouseMode: +.. _enum_Input_MouseMode: enum **MouseMode**: @@ -118,7 +118,7 @@ enum **MouseMode**: - **MOUSE_MODE_CAPTURED** = **2** --- Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. - **MOUSE_MODE_CONFINED** = **3** --- Makes the mouse cursor visible but confines it to the game window. - .. _enum_Input_CursorShape: +.. _enum_Input_CursorShape: enum **CursorShape**: @@ -149,28 +149,29 @@ Tutorials --------- - :doc:`../tutorials/inputs/index` + Method Descriptions ------------------- - .. _class_Input_action_press: +.. _class_Input_action_press: - void **action_press** **(** :ref:`String` action **)** This will simulate pressing the specified action. - .. _class_Input_action_release: +.. _class_Input_action_release: - void **action_release** **(** :ref:`String` action **)** If the specified action is already pressed, this will release it. - .. _class_Input_add_joy_mapping: +.. _class_Input_add_joy_mapping: - 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: +.. _class_Input_get_accelerometer: - :ref:`Vector3` **get_accelerometer** **(** **)** const @@ -178,99 +179,99 @@ If the device has an accelerometer, this will return the acceleration. Otherwise 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: +.. _class_Input_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const - .. _class_Input_get_connected_joypads: +.. _class_Input_get_connected_joypads: - :ref:`Array` **get_connected_joypads** **(** **)** Returns an :ref:`Array` containing the device IDs of all currently connected joypads. - .. _class_Input_get_gravity: +.. _class_Input_get_gravity: - :ref:`Vector3` **get_gravity** **(** **)** const If the device has an accelerometer, this will return the gravity. Otherwise, it returns an empty :ref:`Vector3`. - .. _class_Input_get_gyroscope: +.. _class_Input_get_gyroscope: - :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`. - .. _class_Input_get_joy_axis: +.. _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`) - .. _class_Input_get_joy_axis_index_from_string: +.. _class_Input_get_joy_axis_index_from_string: - :ref:`int` **get_joy_axis_index_from_string** **(** :ref:`String` axis **)** - .. _class_Input_get_joy_axis_string: +.. _class_Input_get_joy_axis_string: - :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** - .. _class_Input_get_joy_button_index_from_string: +.. _class_Input_get_joy_button_index_from_string: - :ref:`int` **get_joy_button_index_from_string** **(** :ref:`String` button **)** - .. _class_Input_get_joy_button_string: +.. _class_Input_get_joy_button_string: - :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** - .. _class_Input_get_joy_guid: +.. _class_Input_get_joy_guid: - :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: +.. _class_Input_get_joy_name: - :ref:`String` **get_joy_name** **(** :ref:`int` device **)** Returns the name of the joypad at the specified device index - .. _class_Input_get_joy_vibration_duration: +.. _class_Input_get_joy_vibration_duration: - :ref:`float` **get_joy_vibration_duration** **(** :ref:`int` device **)** Returns the duration of the current vibration effect in seconds. - .. _class_Input_get_joy_vibration_strength: +.. _class_Input_get_joy_vibration_strength: - :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: +.. _class_Input_get_last_mouse_speed: - :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: +.. _class_Input_get_magnetometer: - :ref:`Vector3` **get_magnetometer** **(** **)** const If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. - .. _class_Input_get_mouse_button_mask: +.. _class_Input_get_mouse_button_mask: - :ref:`int` **get_mouse_button_mask** **(** **)** const Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. - .. _class_Input_get_mouse_mode: +.. _class_Input_get_mouse_mode: - :ref:`MouseMode` **get_mouse_mode** **(** **)** const Return the mouse mode. See the constants for more information. - .. _class_Input_is_action_just_pressed: +.. _class_Input_is_action_just_pressed: - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const @@ -278,59 +279,59 @@ Returns ``true`` when the user starts pressing the action event, meaning it's tr This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. - .. _class_Input_is_action_just_released: +.. _class_Input_is_action_just_released: - :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: +.. _class_Input_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const Returns ``true`` if you are pressing the action event. - .. _class_Input_is_joy_button_pressed: +.. _class_Input_is_joy_button_pressed: - :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`) - .. _class_Input_is_joy_known: +.. _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. - .. _class_Input_is_key_pressed: +.. _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`. - .. _class_Input_is_mouse_button_pressed: +.. _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`. - .. _class_Input_joy_connection_changed: +.. _class_Input_joy_connection_changed: - void **joy_connection_changed** **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** - .. _class_Input_parse_input_event: +.. _class_Input_parse_input_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. - .. _class_Input_remove_joy_mapping: +.. _class_Input_remove_joy_mapping: - 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: +.. _class_Input_set_custom_mouse_cursor: - void **set_custom_mouse_cursor** **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** @@ -340,7 +341,7 @@ Sets a custom mouse cursor image, which is only visible inside the game window. ``hotspot`` must be within ``image``'s size. - .. _class_Input_set_default_cursor_shape: +.. _class_Input_set_default_cursor_shape: - void **set_default_cursor_shape** **(** :ref:`CursorShape` shape=0 **)** @@ -348,13 +349,13 @@ Sets the default cursor shape to be used in the viewport instead of ``CURSOR_ARR Note that if you want to change the default cursor shape for :ref:`Control`'s nodes, use :ref:`Control.mouse_default_cursor_shape` instead. - .. _class_Input_set_mouse_mode: +.. _class_Input_set_mouse_mode: - void **set_mouse_mode** **(** :ref:`MouseMode` mode **)** Set the mouse mode. See the constants for more information. - .. _class_Input_start_joy_vibration: +.. _class_Input_start_joy_vibration: - void **start_joy_vibration** **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** @@ -362,13 +363,13 @@ Starts to vibrate the joypad. Joypads usually come with two rumble motors, a str Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. - .. _class_Input_stop_joy_vibration: +.. _class_Input_stop_joy_vibration: - void **stop_joy_vibration** **(** :ref:`int` device **)** Stops the vibration of the joypad. - .. _class_Input_warp_mouse_position: +.. _class_Input_warp_mouse_position: - void **warp_mouse_position** **(** :ref:`Vector2` to **)** diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index fe1d8dc20..ae5793f69 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -59,11 +59,13 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + - :doc:`../tutorials/2d/2d_transforms` + Property Descriptions --------------------- - .. _class_InputEvent_device: +.. _class_InputEvent_device: - :ref:`int` **device** @@ -78,57 +80,57 @@ The event's device ID. Method Descriptions ------------------- - .. _class_InputEvent_as_text: +.. _class_InputEvent_as_text: - :ref:`String` **as_text** **(** **)** const Returns a :ref:`String` representation of the event. - .. _class_InputEvent_get_action_strength: +.. _class_InputEvent_get_action_strength: - :ref:`float` **get_action_strength** **(** :ref:`String` action **)** const - .. _class_InputEvent_is_action: +.. _class_InputEvent_is_action: - :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: +.. _class_InputEvent_is_action_pressed: - :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: +.. _class_InputEvent_is_action_released: - :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``. - .. _class_InputEvent_is_action_type: +.. _class_InputEvent_is_action_type: - :ref:`bool` **is_action_type** **(** **)** const Returns ``true`` if this input event's type is one of the ``InputEvent`` constants. - .. _class_InputEvent_is_echo: +.. _class_InputEvent_is_echo: - :ref:`bool` **is_echo** **(** **)** const Returns ``true`` if this input event is an echo event (only for events of type KEY). - .. _class_InputEvent_is_pressed: +.. _class_InputEvent_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const Returns ``true`` if this input event is pressed. Not relevant for the event types ``MOUSE_MOTION``, ``SCREEN_DRAG`` or ``NONE``. - .. _class_InputEvent_shortcut_match: +.. _class_InputEvent_shortcut_match: - :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const - .. _class_InputEvent_xformed_by: +.. _class_InputEvent_xformed_by: - :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 93108ec03..7b4bec301 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -34,10 +34,11 @@ Tutorials --------- - `#actions <../tutorials/inputs/inputevent.html#actions>`_ in :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventAction_action: +.. _class_InputEventAction_action: - :ref:`String` **action** @@ -49,7 +50,7 @@ Property Descriptions The action's name. Actions are accessed via this :ref:`String`. - .. _class_InputEventAction_pressed: +.. _class_InputEventAction_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventgesture.rst b/classes/class_inputeventgesture.rst index 512a9b0d0..a750511e1 100644 --- a/classes/class_inputeventgesture.rst +++ b/classes/class_inputeventgesture.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_InputEventGesture_position: +.. _class_InputEventGesture_position: - :ref:`Vector2` **position** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 96aa70fce..9b1e57dae 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -36,10 +36,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventJoypadButton_button_index: +.. _class_InputEventJoypadButton_button_index: - :ref:`int` **button_index** @@ -51,7 +52,7 @@ Property Descriptions Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. - .. _class_InputEventJoypadButton_pressed: +.. _class_InputEventJoypadButton_pressed: - :ref:`bool` **pressed** @@ -63,7 +64,7 @@ Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope If ``true`` the button's state is pressed. If ``false`` the button's state is released. - .. _class_InputEventJoypadButton_pressure: +.. _class_InputEventJoypadButton_pressure: - :ref:`float` **pressure** diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 496e2e278..00c02fdb2 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -34,10 +34,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventJoypadMotion_axis: +.. _class_InputEventJoypadMotion_axis: - :ref:`int` **axis** @@ -49,7 +50,7 @@ Property Descriptions Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. - .. _class_InputEventJoypadMotion_axis_value: +.. _class_InputEventJoypadMotion_axis_value: - :ref:`float` **axis_value** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index a92c5bf35..1ad09cf87 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -45,10 +45,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventKey_echo: +.. _class_InputEventKey_echo: - :ref:`bool` **echo** @@ -60,7 +61,7 @@ Property Descriptions If ``true`` the key was already pressed before this event. It means the user is holding the key down. - .. _class_InputEventKey_pressed: +.. _class_InputEventKey_pressed: - :ref:`bool` **pressed** @@ -72,7 +73,7 @@ If ``true`` the key was already pressed before this event. It means the user is If ``true`` the key's state is pressed. If ``false`` the key's state is released. - .. _class_InputEventKey_scancode: +.. _class_InputEventKey_scancode: - :ref:`int` **scancode** @@ -84,7 +85,7 @@ If ``true`` the key's state is pressed. If ``false`` the key's state is released Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. - .. _class_InputEventKey_unicode: +.. _class_InputEventKey_unicode: - :ref:`int` **unicode** @@ -99,7 +100,7 @@ Key unicode identifier when relevant. Method Descriptions ------------------- - .. _class_InputEventKey_get_scancode_with_modifiers: +.. _class_InputEventKey_get_scancode_with_modifiers: - :ref:`int` **get_scancode_with_modifiers** **(** **)** const diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 70c1d48f3..8a97dfb8d 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_InputEventMagnifyGesture_factor: +.. _class_InputEventMagnifyGesture_factor: - :ref:`float` **factor** diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index fb2c35d7c..e648fbd06 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -38,10 +38,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventMouse_button_mask: +.. _class_InputEventMouse_button_mask: - :ref:`int` **button_mask** @@ -53,7 +54,7 @@ Property Descriptions Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. - .. _class_InputEventMouse_global_position: +.. _class_InputEventMouse_global_position: - :ref:`Vector2` **global_position** @@ -65,7 +66,7 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK Mouse position relative to the current :ref:`Viewport` when used in :ref:`Control._gui_input`, otherwise is at 0,0. - .. _class_InputEventMouse_position: +.. _class_InputEventMouse_position: - :ref:`Vector2` **position** diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index c00fd8b3f..0f5a35a97 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -38,10 +38,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/mouse_and_input_coordinates` + Property Descriptions --------------------- - .. _class_InputEventMouseButton_button_index: +.. _class_InputEventMouseButton_button_index: - :ref:`int` **button_index** @@ -53,7 +54,7 @@ Property Descriptions Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. - .. _class_InputEventMouseButton_doubleclick: +.. _class_InputEventMouseButton_doubleclick: - :ref:`bool` **doubleclick** @@ -65,7 +66,7 @@ Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in If ``true`` the mouse button's state is a double-click. If ``false`` the mouse button's state is released. - .. _class_InputEventMouseButton_factor: +.. _class_InputEventMouseButton_factor: - :ref:`float` **factor** @@ -77,7 +78,7 @@ If ``true`` the mouse button's state is a double-click. If ``false`` the mouse b Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scroll amount (vertically or horizontally). Only supported on some platforms, sensitivity varies by platform. May be 0 if not supported. - .. _class_InputEventMouseButton_pressed: +.. _class_InputEventMouseButton_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 2214ecf04..921e4150c 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -34,10 +34,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/mouse_and_input_coordinates` + Property Descriptions --------------------- - .. _class_InputEventMouseMotion_relative: +.. _class_InputEventMouseMotion_relative: - :ref:`Vector2` **relative** @@ -49,7 +50,7 @@ Property Descriptions Mouse position relative to the previous position (position at the last frame). - .. _class_InputEventMouseMotion_speed: +.. _class_InputEventMouseMotion_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 21ba1d94d..4584eb0bc 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_InputEventPanGesture_delta: +.. _class_InputEventPanGesture_delta: - :ref:`Vector2` **delta** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 66782ba3f..e881da015 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -40,10 +40,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventScreenDrag_index: +.. _class_InputEventScreenDrag_index: - :ref:`int` **index** @@ -55,7 +56,7 @@ Property Descriptions Drag event index in the case of a multi-drag event. - .. _class_InputEventScreenDrag_position: +.. _class_InputEventScreenDrag_position: - :ref:`Vector2` **position** @@ -67,7 +68,7 @@ Drag event index in the case of a multi-drag event. Drag position. - .. _class_InputEventScreenDrag_relative: +.. _class_InputEventScreenDrag_relative: - :ref:`Vector2` **relative** @@ -79,7 +80,7 @@ Drag position. Drag position relative to its start position. - .. _class_InputEventScreenDrag_speed: +.. _class_InputEventScreenDrag_speed: - :ref:`Vector2` **speed** diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index 819b7080f..e1ca490ef 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -38,10 +38,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventScreenTouch_index: +.. _class_InputEventScreenTouch_index: - :ref:`int` **index** @@ -53,7 +54,7 @@ Property Descriptions Touch index in the case of a multi-touch event. One index = one finger. - .. _class_InputEventScreenTouch_position: +.. _class_InputEventScreenTouch_position: - :ref:`Vector2` **position** @@ -65,7 +66,7 @@ Touch index in the case of a multi-touch event. One index = one finger. Touch position. - .. _class_InputEventScreenTouch_pressed: +.. _class_InputEventScreenTouch_pressed: - :ref:`bool` **pressed** diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index 1d9fe71d0..d0d95132e 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -42,10 +42,11 @@ Tutorials --------- - :doc:`../tutorials/inputs/inputevent` + Property Descriptions --------------------- - .. _class_InputEventWithModifiers_alt: +.. _class_InputEventWithModifiers_alt: - :ref:`bool` **alt** @@ -57,7 +58,7 @@ Property Descriptions State of the Alt modifier. - .. _class_InputEventWithModifiers_command: +.. _class_InputEventWithModifiers_command: - :ref:`bool` **command** @@ -69,7 +70,7 @@ State of the Alt modifier. State of the Command modifier. - .. _class_InputEventWithModifiers_control: +.. _class_InputEventWithModifiers_control: - :ref:`bool` **control** @@ -81,7 +82,7 @@ State of the Command modifier. State of the Ctrl modifier. - .. _class_InputEventWithModifiers_meta: +.. _class_InputEventWithModifiers_meta: - :ref:`bool` **meta** @@ -93,7 +94,7 @@ State of the Ctrl modifier. State of the Meta modifier. - .. _class_InputEventWithModifiers_shift: +.. _class_InputEventWithModifiers_shift: - :ref:`bool` **shift** diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index f4b9ea353..13cfcc6ea 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -54,38 +54,39 @@ Tutorials --------- - `#inputmap <../tutorials/inputs/inputevent.html#inputmap>`_ in :doc:`../tutorials/inputs/inputevent` + Method Descriptions ------------------- - .. _class_InputMap_action_add_event: +.. _class_InputMap_action_add_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. - .. _class_InputMap_action_erase_event: +.. _class_InputMap_action_erase_event: - void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** Removes an :ref:`InputEvent` from an action. - .. _class_InputMap_action_erase_events: +.. _class_InputMap_action_erase_events: - void **action_erase_events** **(** :ref:`String` action **)** Removes all events from an action. - .. _class_InputMap_action_has_event: +.. _class_InputMap_action_has_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. - .. _class_InputMap_action_set_deadzone: +.. _class_InputMap_action_set_deadzone: - void **action_set_deadzone** **(** :ref:`String` action, :ref:`float` deadzone **)** - .. _class_InputMap_add_action: +.. _class_InputMap_add_action: - void **add_action** **(** :ref:`String` action, :ref:`float` deadzone=0.5 **)** @@ -93,37 +94,37 @@ 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`. - .. _class_InputMap_erase_action: +.. _class_InputMap_erase_action: - void **erase_action** **(** :ref:`String` action **)** Removes an action from the ``InputMap``. - .. _class_InputMap_event_is_action: +.. _class_InputMap_event_is_action: - :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. - .. _class_InputMap_get_action_list: +.. _class_InputMap_get_action_list: - :ref:`Array` **get_action_list** **(** :ref:`String` action **)** Returns an array of :ref:`InputEvent`\ s associated with a given action. - .. _class_InputMap_get_actions: +.. _class_InputMap_get_actions: - :ref:`Array` **get_actions** **(** **)** Returns an array of all actions in the ``InputMap``. - .. _class_InputMap_has_action: +.. _class_InputMap_has_action: - :ref:`bool` **has_action** **(** :ref:`String` action **)** const Returns ``true`` if the ``InputMap`` has a registered action with the given name. - .. _class_InputMap_load_from_globals: +.. _class_InputMap_load_from_globals: - void **load_from_globals** **(** **)** diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index bb28825ca..1995c9173 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -39,21 +39,21 @@ The InstancePlaceholder does not have a transform. This causes any child nodes t Method Descriptions ------------------- - .. _class_InstancePlaceholder_create_instance: +.. _class_InstancePlaceholder_create_instance: - :ref:`Node` **create_instance** **(** :ref:`bool` replace=false, :ref:`PackedScene` custom_scene=null **)** - .. _class_InstancePlaceholder_get_instance_path: +.. _class_InstancePlaceholder_get_instance_path: - :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`. - .. _class_InstancePlaceholder_get_stored_values: +.. _class_InstancePlaceholder_get_stored_values: - :ref:`Dictionary` **get_stored_values** **(** :ref:`bool` with_order=false **)** - .. _class_InstancePlaceholder_replace_by_instance: +.. _class_InstancePlaceholder_replace_by_instance: - void **replace_by_instance** **(** :ref:`PackedScene` custom_scene=null **)** diff --git a/classes/class_int.rst b/classes/class_int.rst index 419a3f871..5b05ff355 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -33,19 +33,19 @@ Integer built-in type. Method Descriptions ------------------- - .. _class_int_int: +.. _class_int_int: - :ref:`int` **int** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. - .. _class_int_int: +.. _class_int_int: - :ref:`int` **int** **(** :ref:`float` from **)** Cast a float value to an integer value, this method simply removes the number fractions, so for example ``int(2.7)`` will be equals to 2, ``int(.1)`` will be equals to 0 and ``int(-2.7)`` will be equals to -2. - .. _class_int_int: +.. _class_int_int: - :ref:`int` **int** **(** :ref:`String` from **)** diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index a8c50dc67..d0a3d6d3c 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -44,7 +44,7 @@ If it is not :ref:`enabled` or does not have a Property Descriptions --------------------- - .. _class_InterpolatedCamera_enabled: +.. _class_InterpolatedCamera_enabled: - :ref:`bool` **enabled** @@ -56,7 +56,7 @@ Property Descriptions If ``true`` and a target is set, the camera will move automatically. - .. _class_InterpolatedCamera_speed: +.. _class_InterpolatedCamera_speed: - :ref:`float` **speed** @@ -68,7 +68,7 @@ If ``true`` and a target is set, the camera will move automatically. How quickly the camera moves toward its target. Higher values will result in tighter camera motion. - .. _class_InterpolatedCamera_target: +.. _class_InterpolatedCamera_target: - :ref:`NodePath` **target** @@ -83,7 +83,7 @@ The target's :ref:`NodePath`. Method Descriptions ------------------- - .. _class_InterpolatedCamera_set_target: +.. _class_InterpolatedCamera_set_target: - void **set_target** **(** :ref:`Object` target **)** diff --git a/classes/class_ip.rst b/classes/class_ip.rst index 0597944a6..fbbf6ce62 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -40,7 +40,7 @@ Methods Enumerations ------------ - .. _enum_IP_ResolverStatus: +.. _enum_IP_ResolverStatus: enum **ResolverStatus**: @@ -49,7 +49,7 @@ enum **ResolverStatus**: - **RESOLVER_STATUS_DONE** = **2** --- DNS hostname resolver status: Done. - **RESOLVER_STATUS_ERROR** = **3** --- DNS hostname resolver status: Error. - .. _enum_IP_Type: +.. _enum_IP_Type: enum **Type**: @@ -63,6 +63,7 @@ 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 ----------- @@ -71,43 +72,43 @@ IP contains support functions for the Internet Protocol (IP). TCP/IP support is Method Descriptions ------------------- - .. _class_IP_clear_cache: +.. _class_IP_clear_cache: - 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. - .. _class_IP_erase_resolve_item: +.. _class_IP_erase_resolve_item: - void **erase_resolve_item** **(** :ref:`int` id **)** Removes a given item "id" from the queue. This should be used to free a queue after it has completed to enable more queries to happen. - .. _class_IP_get_local_addresses: +.. _class_IP_get_local_addresses: - :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: +.. _class_IP_get_resolve_item_address: - :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: +.. _class_IP_get_resolve_item_status: - :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: +.. _class_IP_resolve_hostname: - :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: +.. _class_IP_resolve_hostname_queue_item: - :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`Type` ip_type=3 **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index c418ac4c5..11d540085 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -160,13 +160,13 @@ Theme Properties Signals ------- - .. _class_ItemList_item_activated: +.. _class_ItemList_item_activated: - **item_activated** **(** :ref:`int` index **)** Fired when specified list item is activated via double click or Enter. - .. _class_ItemList_item_rmb_selected: +.. _class_ItemList_item_rmb_selected: - **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** @@ -176,37 +176,37 @@ The click position is also provided to allow appropriate popup of context menus at the correct location. - .. _class_ItemList_item_selected: +.. _class_ItemList_item_selected: - **item_selected** **(** :ref:`int` index **)** Fired when specified item has been selected. - .. _class_ItemList_multi_selected: +.. _class_ItemList_multi_selected: - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** Fired when a multiple selection is altered on a list allowing multiple selection. - .. _class_ItemList_nothing_selected: +.. _class_ItemList_nothing_selected: - **nothing_selected** **(** **)** - .. _class_ItemList_rmb_clicked: +.. _class_ItemList_rmb_clicked: - **rmb_clicked** **(** :ref:`Vector2` at_position **)** Enumerations ------------ - .. _enum_ItemList_IconMode: +.. _enum_ItemList_IconMode: enum **IconMode**: - **ICON_MODE_TOP** = **0** - **ICON_MODE_LEFT** = **1** - .. _enum_ItemList_SelectMode: +.. _enum_ItemList_SelectMode: enum **SelectMode**: @@ -223,7 +223,7 @@ Selectable items in the list may be selected or deselected and multiple selectio Property Descriptions --------------------- - .. _class_ItemList_allow_reselect: +.. _class_ItemList_allow_reselect: - :ref:`bool` **allow_reselect** @@ -235,7 +235,7 @@ Property Descriptions If ``true`` the currently selected item may be selected again. - .. _class_ItemList_allow_rmb_select: +.. _class_ItemList_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -247,7 +247,7 @@ If ``true`` the currently selected item may be selected again. If ``true`` a right mouse button click can select items. - .. _class_ItemList_auto_height: +.. _class_ItemList_auto_height: - :ref:`bool` **auto_height** @@ -257,7 +257,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | has_auto_height() | +----------+------------------------+ - .. _class_ItemList_fixed_column_width: +.. _class_ItemList_fixed_column_width: - :ref:`int` **fixed_column_width** @@ -267,7 +267,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_fixed_column_width() | +----------+-------------------------------+ - .. _class_ItemList_fixed_icon_size: +.. _class_ItemList_fixed_icon_size: - :ref:`Vector2` **fixed_icon_size** @@ -277,7 +277,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_fixed_icon_size() | +----------+----------------------------+ - .. _class_ItemList_icon_mode: +.. _class_ItemList_icon_mode: - :ref:`IconMode` **icon_mode** @@ -287,7 +287,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_icon_mode() | +----------+----------------------+ - .. _class_ItemList_icon_scale: +.. _class_ItemList_icon_scale: - :ref:`float` **icon_scale** @@ -297,7 +297,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_icon_scale() | +----------+-----------------------+ - .. _class_ItemList_max_columns: +.. _class_ItemList_max_columns: - :ref:`int` **max_columns** @@ -307,7 +307,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_max_columns() | +----------+------------------------+ - .. _class_ItemList_max_text_lines: +.. _class_ItemList_max_text_lines: - :ref:`int` **max_text_lines** @@ -317,7 +317,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | get_max_text_lines() | +----------+---------------------------+ - .. _class_ItemList_same_column_width: +.. _class_ItemList_same_column_width: - :ref:`bool` **same_column_width** @@ -327,7 +327,7 @@ If ``true`` a right mouse button click can select items. | *Getter* | is_same_column_width() | +----------+------------------------------+ - .. _class_ItemList_select_mode: +.. _class_ItemList_select_mode: - :ref:`SelectMode` **select_mode** @@ -342,13 +342,13 @@ Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- - .. _class_ItemList_add_icon_item: +.. _class_ItemList_add_icon_item: - 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: +.. _class_ItemList_add_item: - void **add_item** **(** :ref:`String` text, :ref:`Texture` icon=null, :ref:`bool` selectable=true **)** @@ -356,123 +356,123 @@ Adds an item to the item list with specified text. Specify an icon of null for If selectable is true the list item will be selectable. - .. _class_ItemList_clear: +.. _class_ItemList_clear: - void **clear** **(** **)** Remove all items from the list. - .. _class_ItemList_ensure_current_is_visible: +.. _class_ItemList_ensure_current_is_visible: - void **ensure_current_is_visible** **(** **)** Ensure selection is visible, adjusting the scroll position as necessary. - .. _class_ItemList_get_item_at_position: +.. _class_ItemList_get_item_at_position: - :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. - .. _class_ItemList_get_item_count: +.. _class_ItemList_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return count of items currently in the item list. - .. _class_ItemList_get_item_custom_bg_color: +.. _class_ItemList_get_item_custom_bg_color: - :ref:`Color` **get_item_custom_bg_color** **(** :ref:`int` idx **)** const - .. _class_ItemList_get_item_custom_fg_color: +.. _class_ItemList_get_item_custom_fg_color: - :ref:`Color` **get_item_custom_fg_color** **(** :ref:`int` idx **)** const - .. _class_ItemList_get_item_icon: +.. _class_ItemList_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const - .. _class_ItemList_get_item_icon_modulate: +.. _class_ItemList_get_item_icon_modulate: - :ref:`Color` **get_item_icon_modulate** **(** :ref:`int` idx **)** const Returns a :ref:`Color` modulating item's icon at the specified index. - .. _class_ItemList_get_item_icon_region: +.. _class_ItemList_get_item_icon_region: - :ref:`Rect2` **get_item_icon_region** **(** :ref:`int` idx **)** const - .. _class_ItemList_get_item_metadata: +.. _class_ItemList_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const - .. _class_ItemList_get_item_text: +.. _class_ItemList_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text for specified item index. - .. _class_ItemList_get_item_tooltip: +.. _class_ItemList_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const Return tooltip hint for specified item index. - .. _class_ItemList_get_selected_items: +.. _class_ItemList_get_selected_items: - :ref:`PoolIntArray` **get_selected_items** **(** **)** Returns the list of selected indexes. - .. _class_ItemList_get_v_scroll: +.. _class_ItemList_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the current vertical scroll bar for the List. - .. _class_ItemList_is_anything_selected: +.. _class_ItemList_is_anything_selected: - :ref:`bool` **is_anything_selected** **(** **)** Returns ``true`` if one or more items are selected. - .. _class_ItemList_is_item_disabled: +.. _class_ItemList_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is disabled - .. _class_ItemList_is_item_selectable: +.. _class_ItemList_is_item_selectable: - :ref:`bool` **is_item_selectable** **(** :ref:`int` idx **)** const Returns whether or not the item at the specified index is selectable. - .. _class_ItemList_is_item_tooltip_enabled: +.. _class_ItemList_is_item_tooltip_enabled: - :ref:`bool` **is_item_tooltip_enabled** **(** :ref:`int` idx **)** const Returns whether the tooltip is enabled for specified item index. - .. _class_ItemList_is_selected: +.. _class_ItemList_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` idx **)** const Returns whether or not item at the specified index is currently selected. - .. _class_ItemList_move_item: +.. _class_ItemList_move_item: - void **move_item** **(** :ref:`int` from_idx, :ref:`int` to_idx **)** Moves item at index ``from_idx`` to ``to_idx``. - .. _class_ItemList_remove_item: +.. _class_ItemList_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Remove item at specified index from the list. - .. _class_ItemList_select: +.. _class_ItemList_select: - void **select** **(** :ref:`int` idx, :ref:`bool` single=true **)** @@ -480,15 +480,15 @@ Select the item at the specified index. Note: This method does not trigger the item selection signal. - .. _class_ItemList_set_item_custom_bg_color: +.. _class_ItemList_set_item_custom_bg_color: - void **set_item_custom_bg_color** **(** :ref:`int` idx, :ref:`Color` custom_bg_color **)** - .. _class_ItemList_set_item_custom_fg_color: +.. _class_ItemList_set_item_custom_fg_color: - void **set_item_custom_fg_color** **(** :ref:`int` idx, :ref:`Color` custom_fg_color **)** - .. _class_ItemList_set_item_disabled: +.. _class_ItemList_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** @@ -496,65 +496,65 @@ Disable (or enable) item at specified index. Disabled items are not be selectable and do not fire activation (Enter or double-click) signals. - .. _class_ItemList_set_item_icon: +.. _class_ItemList_set_item_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: +.. _class_ItemList_set_item_icon_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. - .. _class_ItemList_set_item_icon_region: +.. _class_ItemList_set_item_icon_region: - void **set_item_icon_region** **(** :ref:`int` idx, :ref:`Rect2` rect **)** - .. _class_ItemList_set_item_metadata: +.. _class_ItemList_set_item_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. - .. _class_ItemList_set_item_selectable: +.. _class_ItemList_set_item_selectable: - void **set_item_selectable** **(** :ref:`int` idx, :ref:`bool` selectable **)** Allow or disallow selection of the item at the specified index. - .. _class_ItemList_set_item_text: +.. _class_ItemList_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** Sets text of item at specified index. - .. _class_ItemList_set_item_tooltip: +.. _class_ItemList_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** Sets tooltip hint for item at specified index. - .. _class_ItemList_set_item_tooltip_enabled: +.. _class_ItemList_set_item_tooltip_enabled: - void **set_item_tooltip_enabled** **(** :ref:`int` idx, :ref:`bool` enable **)** Sets whether the tooltip is enabled for specified item index. - .. _class_ItemList_sort_items_by_text: +.. _class_ItemList_sort_items_by_text: - void **sort_items_by_text** **(** **)** Sorts items in the list by their text. - .. _class_ItemList_unselect: +.. _class_ItemList_unselect: - void **unselect** **(** :ref:`int` idx **)** Ensure item at specified index is not selected. - .. _class_ItemList_unselect_all: +.. _class_ItemList_unselect_all: - void **unselect_all** **(** **)** diff --git a/classes/class_javascript.rst b/classes/class_javascript.rst index 1c808e6ad..0a9ce9677 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascript.rst @@ -32,10 +32,11 @@ 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` + Method Descriptions ------------------- - .. _class_JavaScript_eval: +.. _class_JavaScript_eval: - :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 8008830cd..9db270d11 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -39,7 +39,7 @@ All 3D joints link two nodes, has a priority, and can decide if the two bodies o Property Descriptions --------------------- - .. _class_Joint_collision/exclude_nodes: +.. _class_Joint_collision/exclude_nodes: - :ref:`bool` **collision/exclude_nodes** @@ -51,7 +51,7 @@ Property Descriptions If ``true`` the two bodies of the nodes are not able to collide with each other. - .. _class_Joint_nodes/node_a: +.. _class_Joint_nodes/node_a: - :ref:`NodePath` **nodes/node_a** @@ -63,7 +63,7 @@ If ``true`` the two bodies of the nodes are not able to collide with each other. The :ref:`Node`, the first side of the Joint attaches to. - .. _class_Joint_nodes/node_b: +.. _class_Joint_nodes/node_b: - :ref:`NodePath` **nodes/node_b** @@ -75,7 +75,7 @@ The :ref:`Node`, the first side of the Joint attaches to. The :ref:`Node`, the second side of the Joint attaches to. - .. _class_Joint_solver/priority: +.. _class_Joint_solver/priority: - :ref:`int` **solver/priority** diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index 86914f311..acec411af 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -39,7 +39,7 @@ Base node for all joint constraints in 2D physics. Joints take 2 bodies and appl Property Descriptions --------------------- - .. _class_Joint2D_bias: +.. _class_Joint2D_bias: - :ref:`float` **bias** @@ -51,7 +51,7 @@ Property Descriptions When :ref:`node_a` and :ref:`node_b` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0`` - .. _class_Joint2D_disable_collision: +.. _class_Joint2D_disable_collision: - :ref:`bool` **disable_collision** @@ -63,7 +63,7 @@ When :ref:`node_a` and :ref:`node_b` If ``true`` :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. - .. _class_Joint2D_node_a: +.. _class_Joint2D_node_a: - :ref:`NodePath` **node_a** @@ -75,7 +75,7 @@ If ``true`` :ref:`node_a` and :ref:`node_b`. - .. _class_Joint2D_node_b: +.. _class_Joint2D_node_b: - :ref:`NodePath` **node_b** diff --git a/classes/class_json.rst b/classes/class_json.rst index b5a286b7a..08261d808 100644 --- a/classes/class_json.rst +++ b/classes/class_json.rst @@ -33,13 +33,13 @@ Helper class for parsing JSON data. For usage example and other important hints, Method Descriptions ------------------- - .. _class_JSON_parse: +.. _class_JSON_parse: - :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** Parses a JSON encoded string and returns a :ref:`JSONParseResult` containing the result. - .. _class_JSON_print: +.. _class_JSON_print: - :ref:`String` **print** **(** :ref:`Variant` value, :ref:`String` indent="", :ref:`bool` sort_keys=false **)** diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst index 260a3bfd8..52f572b09 100644 --- a/classes/class_jsonparseresult.rst +++ b/classes/class_jsonparseresult.rst @@ -37,7 +37,7 @@ Returned by :ref:`JSON.parse`, ``JSONParseResult`` contains de Property Descriptions --------------------- - .. _class_JSONParseResult_error: +.. _class_JSONParseResult_error: - :ref:`Error` **error** @@ -49,7 +49,7 @@ Property Descriptions The error type if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. - .. _class_JSONParseResult_error_line: +.. _class_JSONParseResult_error_line: - :ref:`int` **error_line** @@ -61,7 +61,7 @@ The error type if JSON source was not successfully parsed. See :ref:`@GlobalScop The line number where the error occurred if JSON source was not successfully parsed. - .. _class_JSONParseResult_error_string: +.. _class_JSONParseResult_error_string: - :ref:`String` **error_string** @@ -73,7 +73,7 @@ The line number where the error occurred if JSON source was not successfully par The error message if JSON source was not successfully parsed. See :ref:`@GlobalScope` ERR\_\* constants. - .. _class_JSONParseResult_result: +.. _class_JSONParseResult_result: - :ref:`Variant` **result** diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 9eb4685ad..450f6c920 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -67,10 +67,11 @@ Tutorials --------- - :doc:`../tutorials/physics/kinematic_character_2d` + Property Descriptions --------------------- - .. _class_KinematicBody_collision/safe_margin: +.. _class_KinematicBody_collision/safe_margin: - :ref:`float` **collision/safe_margin** @@ -82,7 +83,7 @@ Property Descriptions If the body is at least this close to another body, this body will consider them to be colliding. - .. _class_KinematicBody_move_lock_x: +.. _class_KinematicBody_move_lock_x: - :ref:`bool` **move_lock_x** @@ -92,7 +93,7 @@ If the body is at least this close to another body, this body will consider them | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_KinematicBody_move_lock_y: +.. _class_KinematicBody_move_lock_y: - :ref:`bool` **move_lock_y** @@ -102,7 +103,7 @@ If the body is at least this close to another body, this body will consider them | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_KinematicBody_move_lock_z: +.. _class_KinematicBody_move_lock_z: - :ref:`bool` **move_lock_z** @@ -115,43 +116,43 @@ If the body is at least this close to another body, this body will consider them Method Descriptions ------------------- - .. _class_KinematicBody_get_floor_velocity: +.. _class_KinematicBody_get_floor_velocity: - :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: +.. _class_KinematicBody_get_slide_collision: - :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). - .. _class_KinematicBody_get_slide_count: +.. _class_KinematicBody_get_slide_count: - :ref:`int` **get_slide_count** **(** **)** const Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. - .. _class_KinematicBody_is_on_ceiling: +.. _class_KinematicBody_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody_is_on_floor: +.. _class_KinematicBody_is_on_floor: - :ref:`bool` **is_on_floor** **(** **)** const Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody_is_on_wall: +.. _class_KinematicBody_is_on_wall: - :ref:`bool` **is_on_wall** **(** **)** const Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody_move_and_collide: +.. _class_KinematicBody_move_and_collide: - :ref:`KinematicCollision` **move_and_collide** **(** :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia=true, :ref:`bool` test_only=false **)** @@ -159,7 +160,7 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. If ``test_only`` is ``true[/true], the body does not move but the would-be collision information is given. - .. _class_KinematicBody_move_and_slide: +.. _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 **)** @@ -177,7 +178,7 @@ If the body collides, it will change direction a maximum of ``max_slides`` times Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. - .. _class_KinematicBody_move_and_slide_with_snap: +.. _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 **)** @@ -185,7 +186,7 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl 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: +.. _class_KinematicBody_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec, :ref:`bool` infinite_inertia **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 3ae36d070..8457b98f5 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -62,7 +62,7 @@ Kinematic Characters: KinematicBody2D also has an API for moving objects (the :r Property Descriptions --------------------- - .. _class_KinematicBody2D_collision/safe_margin: +.. _class_KinematicBody2D_collision/safe_margin: - :ref:`float` **collision/safe_margin** @@ -74,7 +74,7 @@ Property Descriptions 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: +.. _class_KinematicBody2D_motion/sync_to_physics: - :ref:`bool` **motion/sync_to_physics** @@ -89,49 +89,49 @@ If ``true`` the body's movement will be synchronized to the physics frame. This Method Descriptions ------------------- - .. _class_KinematicBody2D_get_floor_velocity: +.. _class_KinematicBody2D_get_floor_velocity: - :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: +.. _class_KinematicBody2D_get_slide_collision: - :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). - .. _class_KinematicBody2D_get_slide_count: +.. _class_KinematicBody2D_get_slide_count: - :ref:`int` **get_slide_count** **(** **)** const Returns the number of times the body collided and changed direction during the last call to :ref:`move_and_slide`. - .. _class_KinematicBody2D_is_on_ceiling: +.. _class_KinematicBody2D_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const Returns ``true`` if the body is on the ceiling. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody2D_is_on_floor: +.. _class_KinematicBody2D_is_on_floor: - :ref:`bool` **is_on_floor** **(** **)** const Returns ``true`` if the body is on the floor. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody2D_is_on_wall: +.. _class_KinematicBody2D_is_on_wall: - :ref:`bool` **is_on_wall** **(** **)** const Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_and_slide`. - .. _class_KinematicBody2D_move_and_collide: +.. _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 **)** 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: +.. _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 **)** @@ -149,7 +149,7 @@ If the body collides, it will change direction a maximum of ``max_bounces`` time Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use :ref:`get_slide_collision`. - .. _class_KinematicBody2D_move_and_slide_with_snap: +.. _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 **)** @@ -157,7 +157,7 @@ Moves the body while keeping it attached to slopes. Similar to :ref:`move_and_sl 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)`` or by using :ref:`move_and_slide` instead. - .. _class_KinematicBody2D_test_move: +.. _class_KinematicBody2D_test_move: - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec, :ref:`bool` infinite_inertia **)** diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 5d88672e7..345d20cfc 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -53,7 +53,7 @@ This object contains information about the collision, including the colliding ob Property Descriptions --------------------- - .. _class_KinematicCollision_collider: +.. _class_KinematicCollision_collider: - :ref:`Object` **collider** @@ -63,7 +63,7 @@ Property Descriptions The colliding body. - .. _class_KinematicCollision_collider_id: +.. _class_KinematicCollision_collider_id: - :ref:`int` **collider_id** @@ -73,7 +73,7 @@ The colliding body. The colliding body's unique :ref:`RID`. - .. _class_KinematicCollision_collider_metadata: +.. _class_KinematicCollision_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -83,7 +83,7 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. - .. _class_KinematicCollision_collider_shape: +.. _class_KinematicCollision_collider_shape: - :ref:`Object` **collider_shape** @@ -93,7 +93,7 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. - .. _class_KinematicCollision_collider_shape_index: +.. _class_KinematicCollision_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -103,7 +103,7 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject`. - .. _class_KinematicCollision_collider_velocity: +.. _class_KinematicCollision_collider_velocity: - :ref:`Vector3` **collider_velocity** @@ -113,7 +113,7 @@ The colliding shape's index. See :ref:`CollisionObject`. The colliding object's velocity. - .. _class_KinematicCollision_local_shape: +.. _class_KinematicCollision_local_shape: - :ref:`Object` **local_shape** @@ -123,7 +123,7 @@ The colliding object's velocity. The moving object's colliding shape. - .. _class_KinematicCollision_normal: +.. _class_KinematicCollision_normal: - :ref:`Vector3` **normal** @@ -133,7 +133,7 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. - .. _class_KinematicCollision_position: +.. _class_KinematicCollision_position: - :ref:`Vector3` **position** @@ -143,7 +143,7 @@ The colliding body's shape's normal at the point of collision. The point of collision. - .. _class_KinematicCollision_remainder: +.. _class_KinematicCollision_remainder: - :ref:`Vector3` **remainder** @@ -153,7 +153,7 @@ The point of collision. The moving object's remaining movement vector. - .. _class_KinematicCollision_travel: +.. _class_KinematicCollision_travel: - :ref:`Vector3` **travel** diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst index 8bcfeb17d..766ea3bcc 100644 --- a/classes/class_kinematiccollision2d.rst +++ b/classes/class_kinematiccollision2d.rst @@ -53,7 +53,7 @@ This object contains information about the collision, including the colliding ob Property Descriptions --------------------- - .. _class_KinematicCollision2D_collider: +.. _class_KinematicCollision2D_collider: - :ref:`Object` **collider** @@ -63,7 +63,7 @@ Property Descriptions The colliding body. - .. _class_KinematicCollision2D_collider_id: +.. _class_KinematicCollision2D_collider_id: - :ref:`int` **collider_id** @@ -73,7 +73,7 @@ The colliding body. The colliding body's unique :ref:`RID`. - .. _class_KinematicCollision2D_collider_metadata: +.. _class_KinematicCollision2D_collider_metadata: - :ref:`Variant` **collider_metadata** @@ -83,7 +83,7 @@ The colliding body's unique :ref:`RID`. The colliding body's metadata. See :ref:`Object`. - .. _class_KinematicCollision2D_collider_shape: +.. _class_KinematicCollision2D_collider_shape: - :ref:`Object` **collider_shape** @@ -93,7 +93,7 @@ The colliding body's metadata. See :ref:`Object`. The colliding body's shape. - .. _class_KinematicCollision2D_collider_shape_index: +.. _class_KinematicCollision2D_collider_shape_index: - :ref:`int` **collider_shape_index** @@ -103,7 +103,7 @@ The colliding body's shape. The colliding shape's index. See :ref:`CollisionObject2D`. - .. _class_KinematicCollision2D_collider_velocity: +.. _class_KinematicCollision2D_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -113,7 +113,7 @@ The colliding shape's index. See :ref:`CollisionObject2D` **local_shape** @@ -123,7 +123,7 @@ The colliding object's velocity. The moving object's colliding shape. - .. _class_KinematicCollision2D_normal: +.. _class_KinematicCollision2D_normal: - :ref:`Vector2` **normal** @@ -133,7 +133,7 @@ The moving object's colliding shape. The colliding body's shape's normal at the point of collision. - .. _class_KinematicCollision2D_position: +.. _class_KinematicCollision2D_position: - :ref:`Vector2` **position** @@ -143,7 +143,7 @@ The colliding body's shape's normal at the point of collision. The point of collision. - .. _class_KinematicCollision2D_remainder: +.. _class_KinematicCollision2D_remainder: - :ref:`Vector2` **remainder** @@ -153,7 +153,7 @@ The point of collision. The moving object's remaining movement vector. - .. _class_KinematicCollision2D_travel: +.. _class_KinematicCollision2D_travel: - :ref:`Vector2` **travel** diff --git a/classes/class_label.rst b/classes/class_label.rst index 3325304de..0dab0d2e7 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -80,7 +80,7 @@ Theme Properties Enumerations ------------ - .. _enum_Label_Align: +.. _enum_Label_Align: enum **Align**: @@ -89,7 +89,7 @@ enum **Align**: - **ALIGN_RIGHT** = **2** --- Align rows to the right (default). - **ALIGN_FILL** = **3** --- Expand row whitespaces to fit the width. - .. _enum_Label_VAlign: +.. _enum_Label_VAlign: enum **VAlign**: @@ -108,7 +108,7 @@ Note that contrarily to most other :ref:`Control`\ s, Label's :re Property Descriptions --------------------- - .. _class_Label_align: +.. _class_Label_align: - :ref:`Align` **align** @@ -120,7 +120,7 @@ Property Descriptions 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: +.. _class_Label_autowrap: - :ref:`bool` **autowrap** @@ -132,7 +132,7 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or 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: +.. _class_Label_clip_text: - :ref:`bool` **clip_text** @@ -144,7 +144,7 @@ If ``true``, wraps the text inside the node's bounding rectangle. If you resize 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: +.. _class_Label_lines_skipped: - :ref:`int` **lines_skipped** @@ -156,7 +156,7 @@ If ``true``, the Label only shows the text that fits inside its bounding rectang The node ignores the first ``lines_skipped`` lines before it starts to display text. - .. _class_Label_max_lines_visible: +.. _class_Label_max_lines_visible: - :ref:`int` **max_lines_visible** @@ -168,7 +168,7 @@ The node ignores the first ``lines_skipped`` lines before it starts to display t Limits the lines of text the node shows on screen. - .. _class_Label_percent_visible: +.. _class_Label_percent_visible: - :ref:`float` **percent_visible** @@ -180,7 +180,7 @@ Limits the lines of text the node shows on screen. 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: +.. _class_Label_text: - :ref:`String` **text** @@ -192,7 +192,7 @@ Limits the count of visible characters. If you set ``percent_visible`` to 50, on The text to display on screen. - .. _class_Label_uppercase: +.. _class_Label_uppercase: - :ref:`bool` **uppercase** @@ -204,7 +204,7 @@ The text to display on screen. If ``true``, all the text displays as UPPERCASE. - .. _class_Label_valign: +.. _class_Label_valign: - :ref:`VAlign` **valign** @@ -216,7 +216,7 @@ If ``true``, all the text displays as UPPERCASE. Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants. - .. _class_Label_visible_characters: +.. _class_Label_visible_characters: - :ref:`int` **visible_characters** @@ -231,25 +231,25 @@ Restricts the number of characters to display. Set to -1 to disable. Method Descriptions ------------------- - .. _class_Label_get_line_count: +.. _class_Label_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Returns the amount of lines of text the Label has. - .. _class_Label_get_line_height: +.. _class_Label_get_line_height: - :ref:`int` **get_line_height** **(** **)** const Returns the font size in pixels. - .. _class_Label_get_total_character_count: +.. _class_Label_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total length of the text. - .. _class_Label_get_visible_line_count: +.. _class_Label_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index f852406ac..9e1001e9c 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -47,49 +47,49 @@ You can dynamically add pieces(:ref:`Texture`) to this ``LargeTex Method Descriptions ------------------- - .. _class_LargeTexture_add_piece: +.. _class_LargeTexture_add_piece: - :ref:`int` **add_piece** **(** :ref:`Vector2` ofs, :ref:`Texture` texture **)** Add another :ref:`Texture` to this ``LargeTexture``, starting on offset "ofs". - .. _class_LargeTexture_clear: +.. _class_LargeTexture_clear: - void **clear** **(** **)** Clears the ``LargeTexture``. - .. _class_LargeTexture_get_piece_count: +.. _class_LargeTexture_get_piece_count: - :ref:`int` **get_piece_count** **(** **)** const Returns the number of pieces currently in this ``LargeTexture``. - .. _class_LargeTexture_get_piece_offset: +.. _class_LargeTexture_get_piece_offset: - :ref:`Vector2` **get_piece_offset** **(** :ref:`int` idx **)** const Returns the offset of the piece with index "idx". - .. _class_LargeTexture_get_piece_texture: +.. _class_LargeTexture_get_piece_texture: - :ref:`Texture` **get_piece_texture** **(** :ref:`int` idx **)** const Returns the :ref:`Texture` of the piece with index "idx". - .. _class_LargeTexture_set_piece_offset: +.. _class_LargeTexture_set_piece_offset: - 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: +.. _class_LargeTexture_set_piece_texture: - void **set_piece_texture** **(** :ref:`int` idx, :ref:`Texture` texture **)** Sets the :ref:`Texture` of the piece with index "idx" to "ofs". - .. _class_LargeTexture_set_size: +.. _class_LargeTexture_set_size: - void **set_size** **(** :ref:`Vector2` size **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index 47cc86252..f21458e3b 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -52,7 +52,7 @@ Properties Enumerations ------------ - .. _enum_Light_BakeMode: +.. _enum_Light_BakeMode: enum **BakeMode**: @@ -60,7 +60,7 @@ enum **BakeMode**: - **BAKE_INDIRECT** = **1** --- Only indirect lighting will be baked. Default value. - **BAKE_ALL** = **2** --- Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). - .. _enum_Light_Param: +.. _enum_Light_Param: enum **Param**: @@ -90,10 +90,11 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` + Property Descriptions --------------------- - .. _class_Light_editor_only: +.. _class_Light_editor_only: - :ref:`bool` **editor_only** @@ -105,7 +106,7 @@ Property Descriptions If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. - .. _class_Light_light_bake_mode: +.. _class_Light_light_bake_mode: - :ref:`BakeMode` **light_bake_mode** @@ -117,7 +118,7 @@ If ``true`` the light only appears in the editor and will not be visible at runt The light's bake mode. See :ref:`BakeMode`. - .. _class_Light_light_color: +.. _class_Light_light_color: - :ref:`Color` **light_color** @@ -129,7 +130,7 @@ The light's bake mode. See :ref:`BakeMode`. The light's color. - .. _class_Light_light_cull_mask: +.. _class_Light_light_cull_mask: - :ref:`int` **light_cull_mask** @@ -141,7 +142,7 @@ The light's color. The light will affect objects in the selected layers. - .. _class_Light_light_energy: +.. _class_Light_light_energy: - :ref:`float` **light_energy** @@ -153,7 +154,7 @@ The light will affect objects in the selected layers. The light's strength multiplier. - .. _class_Light_light_indirect_energy: +.. _class_Light_light_indirect_energy: - :ref:`float` **light_indirect_energy** @@ -165,7 +166,7 @@ The light's strength multiplier. Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. - .. _class_Light_light_negative: +.. _class_Light_light_negative: - :ref:`bool` **light_negative** @@ -177,7 +178,7 @@ Secondary multiplier used with indirect light (light bounces). This works in bak If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. - .. _class_Light_light_specular: +.. _class_Light_light_specular: - :ref:`float` **light_specular** @@ -189,7 +190,7 @@ If ``true`` the light's effect is reversed, darkening areas and casting bright s 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: +.. _class_Light_shadow_bias: - :ref:`float` **shadow_bias** @@ -201,7 +202,7 @@ The intensity of the specular blob in objects affected by the light. At ``0`` th 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: +.. _class_Light_shadow_color: - :ref:`Color` **shadow_color** @@ -213,7 +214,7 @@ Used to adjust shadow appearance. Too small a value results in self shadowing, w The color of shadows cast by this light. - .. _class_Light_shadow_contact: +.. _class_Light_shadow_contact: - :ref:`float` **shadow_contact** @@ -225,7 +226,7 @@ The color of shadows cast by this light. Attempts to reduce :ref:`shadow_bias` gap. - .. _class_Light_shadow_enabled: +.. _class_Light_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -237,7 +238,7 @@ Attempts to reduce :ref:`shadow_bias` gap. If ``true`` the light will cast shadows. Default value: ``false``. - .. _class_Light_shadow_reverse_cull_face: +.. _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 b672a4507..63baf6b7f 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -66,7 +66,7 @@ Properties Enumerations ------------ - .. _enum_Light2D_Mode: +.. _enum_Light2D_Mode: enum **Mode**: @@ -75,7 +75,7 @@ enum **Mode**: - **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_Light2D_ShadowFilter: enum **ShadowFilter**: @@ -94,7 +94,7 @@ Casts light in a 2D environment. Light is defined by a (usually grayscale) textu Property Descriptions --------------------- - .. _class_Light2D_color: +.. _class_Light2D_color: - :ref:`Color` **color** @@ -106,7 +106,7 @@ Property Descriptions The Light2D's :ref:`Color`. - .. _class_Light2D_editor_only: +.. _class_Light2D_editor_only: - :ref:`bool` **editor_only** @@ -118,7 +118,7 @@ The Light2D's :ref:`Color`. If ``true`` Light2D will only appear when editing the scene. Default value: ``false``. - .. _class_Light2D_enabled: +.. _class_Light2D_enabled: - :ref:`bool` **enabled** @@ -130,7 +130,7 @@ If ``true`` Light2D will only appear when editing the scene. Default value: ``fa If ``true`` Light2D will emit light. Default value: ``true``. - .. _class_Light2D_energy: +.. _class_Light2D_energy: - :ref:`float` **energy** @@ -142,7 +142,7 @@ If ``true`` Light2D will emit light. Default value: ``true``. The Light2D's energy value. The larger the value, the stronger the light. - .. _class_Light2D_mode: +.. _class_Light2D_mode: - :ref:`Mode` **mode** @@ -154,7 +154,7 @@ The Light2D's energy value. The larger the value, the stronger the light. The Light2D's mode. See MODE\_\* constants for values. - .. _class_Light2D_offset: +.. _class_Light2D_offset: - :ref:`Vector2` **offset** @@ -166,7 +166,7 @@ The Light2D's mode. See MODE\_\* constants for values. The offset of the Light2D's ``texture``. - .. _class_Light2D_range_height: +.. _class_Light2D_range_height: - :ref:`float` **range_height** @@ -178,7 +178,7 @@ The offset of the Light2D's ``texture``. The height of the Light2D. Used with 2D normal mapping. - .. _class_Light2D_range_item_cull_mask: +.. _class_Light2D_range_item_cull_mask: - :ref:`int` **range_item_cull_mask** @@ -190,7 +190,7 @@ The height of the Light2D. Used with 2D normal mapping. The layer mask. Only objects with a matching mask will be affected by the Light2D. - .. _class_Light2D_range_layer_max: +.. _class_Light2D_range_layer_max: - :ref:`int` **range_layer_max** @@ -202,7 +202,7 @@ The layer mask. Only objects with a matching mask will be affected by the Light2 Maximum layer value of objects that are affected by the Light2D. Default value: ``0``. - .. _class_Light2D_range_layer_min: +.. _class_Light2D_range_layer_min: - :ref:`int` **range_layer_min** @@ -214,7 +214,7 @@ Maximum layer value of objects that are affected by the Light2D. Default value: Minimum layer value of objects that are affected by the Light2D. Default value: ``0``. - .. _class_Light2D_range_z_max: +.. _class_Light2D_range_z_max: - :ref:`int` **range_z_max** @@ -226,7 +226,7 @@ Minimum layer value of objects that are affected by the Light2D. Default value: Maximum ``Z`` value of objects that are affected by the Light2D. Default value: ``1024``. - .. _class_Light2D_range_z_min: +.. _class_Light2D_range_z_min: - :ref:`int` **range_z_min** @@ -238,7 +238,7 @@ Maximum ``Z`` value of objects that are affected by the Light2D. Default value: Minimum ``z`` value of objects that are affected by the Light2D. Default value: ``-1024``. - .. _class_Light2D_shadow_buffer_size: +.. _class_Light2D_shadow_buffer_size: - :ref:`int` **shadow_buffer_size** @@ -250,7 +250,7 @@ Minimum ``z`` value of objects that are affected by the Light2D. Default value: Shadow buffer size. Default value: ``2048``. - .. _class_Light2D_shadow_color: +.. _class_Light2D_shadow_color: - :ref:`Color` **shadow_color** @@ -262,7 +262,7 @@ Shadow buffer size. Default value: ``2048``. :ref:`Color` of shadows cast by the Light2D. - .. _class_Light2D_shadow_enabled: +.. _class_Light2D_shadow_enabled: - :ref:`bool` **shadow_enabled** @@ -274,7 +274,7 @@ Shadow buffer size. Default value: ``2048``. If ``true`` the Light2D will cast shadows. Default value: ``false``. - .. _class_Light2D_shadow_filter: +.. _class_Light2D_shadow_filter: - :ref:`ShadowFilter` **shadow_filter** @@ -286,7 +286,7 @@ If ``true`` the Light2D will cast shadows. Default value: ``false``. Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. Default value: ``None``. - .. _class_Light2D_shadow_filter_smooth: +.. _class_Light2D_shadow_filter_smooth: - :ref:`float` **shadow_filter_smooth** @@ -298,7 +298,7 @@ Shadow filter type. Use SHADOW_FILTER\_\* constants to set ``shadow_filter``. De Smoothing value for shadows. - .. _class_Light2D_shadow_gradient_length: +.. _class_Light2D_shadow_gradient_length: - :ref:`float` **shadow_gradient_length** @@ -310,7 +310,7 @@ Smoothing value for shadows. Smooth shadow gradient length. - .. _class_Light2D_shadow_item_cull_mask: +.. _class_Light2D_shadow_item_cull_mask: - :ref:`int` **shadow_item_cull_mask** @@ -322,7 +322,7 @@ Smooth shadow gradient length. The shadow mask. Used with :ref:`LightOccluder2D` to cast shadows. Only occluders with a matching shadow mask will cast shadows. - .. _class_Light2D_texture: +.. _class_Light2D_texture: - :ref:`Texture` **texture** @@ -334,7 +334,7 @@ The shadow mask. Used with :ref:`LightOccluder2D` to cast :ref:`Texture` used for the Light2D's appearance. - .. _class_Light2D_texture_scale: +.. _class_Light2D_texture_scale: - :ref:`float` **texture_scale** diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 0b6f2e92c..b2d75e3c2 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -33,7 +33,7 @@ Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be p Property Descriptions --------------------- - .. _class_LightOccluder2D_light_mask: +.. _class_LightOccluder2D_light_mask: - :ref:`int` **light_mask** @@ -45,7 +45,7 @@ Property Descriptions The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). - .. _class_LightOccluder2D_occluder: +.. _class_LightOccluder2D_occluder: - :ref:`OccluderPolygon2D` **occluder** diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 91e3c6ff4..0e453f1bf 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -61,7 +61,7 @@ Methods Enumerations ------------ - .. _enum_Line2D_LineCapMode: +.. _enum_Line2D_LineCapMode: enum **LineCapMode**: @@ -69,7 +69,7 @@ enum **LineCapMode**: - **LINE_CAP_BOX** = **1** --- Draws the line cap as a box. - **LINE_CAP_ROUND** = **2** --- Draws the line cap as a circle. - .. _enum_Line2D_LineTextureMode: +.. _enum_Line2D_LineTextureMode: enum **LineTextureMode**: @@ -77,7 +77,7 @@ enum **LineTextureMode**: - **LINE_TEXTURE_TILE** = **1** --- Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. - **LINE_TEXTURE_STRETCH** = **2** --- Stretches the texture across the line. Import the texture with Repeat Disabled for best results. - .. _enum_Line2D_LineJointMode: +.. _enum_Line2D_LineJointMode: enum **LineJointMode**: @@ -93,7 +93,7 @@ A line through several points in 2D space. Property Descriptions --------------------- - .. _class_Line2D_begin_cap_mode: +.. _class_Line2D_begin_cap_mode: - :ref:`LineCapMode` **begin_cap_mode** @@ -105,7 +105,7 @@ Property Descriptions Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. - .. _class_Line2D_default_color: +.. _class_Line2D_default_color: - :ref:`Color` **default_color** @@ -117,7 +117,7 @@ Controls the style of the line's first point. Use ``LINE_CAP_*`` constants. Defa The line's color. Will not be used if a gradient is set. - .. _class_Line2D_end_cap_mode: +.. _class_Line2D_end_cap_mode: - :ref:`LineCapMode` **end_cap_mode** @@ -129,7 +129,7 @@ The line's color. Will not be used if a gradient is set. Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Default value: ``LINE_CAP_NONE``. - .. _class_Line2D_gradient: +.. _class_Line2D_gradient: - :ref:`Gradient` **gradient** @@ -141,7 +141,7 @@ Controls the style of the line's last point. Use ``LINE_CAP_*`` constants. Defau 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: +.. _class_Line2D_joint_mode: - :ref:`LineJointMode` **joint_mode** @@ -153,7 +153,7 @@ The gradient is drawn through the whole line from start to finish. The default c The style for the points between the start and the end. - .. _class_Line2D_points: +.. _class_Line2D_points: - :ref:`PoolVector2Array` **points** @@ -165,7 +165,7 @@ The style for the points between the start and the end. The points that form the lines. The line is drawn between every point set in this array. - .. _class_Line2D_round_precision: +.. _class_Line2D_round_precision: - :ref:`int` **round_precision** @@ -177,7 +177,7 @@ The points that form the lines. The line is drawn between every point set in thi 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: +.. _class_Line2D_sharp_limit: - :ref:`float` **sharp_limit** @@ -189,7 +189,7 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joi 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: +.. _class_Line2D_texture: - :ref:`Texture` **texture** @@ -201,7 +201,7 @@ The direction difference in radians between vector points. This value is only us The texture used for the line's texture. Uses ``texture_mode`` for drawing style. - .. _class_Line2D_texture_mode: +.. _class_Line2D_texture_mode: - :ref:`LineTextureMode` **texture_mode** @@ -213,7 +213,7 @@ The texture used for the line's texture. Uses ``texture_mode`` for drawing style The style to render the ``texture`` on the line. Use ``LINE_TEXTURE_*`` constants. Default value: ``LINE_TEXTURE_NONE``. - .. _class_Line2D_width: +.. _class_Line2D_width: - :ref:`float` **width** @@ -228,31 +228,31 @@ The line's width. Method Descriptions ------------------- - .. _class_Line2D_add_point: +.. _class_Line2D_add_point: - void **add_point** **(** :ref:`Vector2` position **)** Add a point at the ``position``. Appends the point at the end of the line. - .. _class_Line2D_get_point_count: +.. _class_Line2D_get_point_count: - :ref:`int` **get_point_count** **(** **)** const Returns the Line2D's amount of points. - .. _class_Line2D_get_point_position: +.. _class_Line2D_get_point_position: - :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const Returns point ``i``'s position. - .. _class_Line2D_remove_point: +.. _class_Line2D_remove_point: - void **remove_point** **(** :ref:`int` i **)** Remove the point at index ``i`` from the line. - .. _class_Line2D_set_point_position: +.. _class_Line2D_set_point_position: - void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index f45dfd547..a0275709b 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -102,13 +102,13 @@ Theme Properties Signals ------- - .. _class_LineEdit_text_changed: +.. _class_LineEdit_text_changed: - **text_changed** **(** :ref:`String` new_text **)** Emitted when the text changes. - .. _class_LineEdit_text_entered: +.. _class_LineEdit_text_entered: - **text_entered** **(** :ref:`String` new_text **)** @@ -117,7 +117,7 @@ Emitted when the user presses KEY_ENTER on the ``LineEdit``. Enumerations ------------ - .. _enum_LineEdit_Align: +.. _enum_LineEdit_Align: enum **Align**: @@ -126,7 +126,7 @@ enum **Align**: - **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_LineEdit_MenuItems: enum **MenuItems**: @@ -147,7 +147,7 @@ LineEdit provides a single line string editor, used for text fields. Property Descriptions --------------------- - .. _class_LineEdit_align: +.. _class_LineEdit_align: - :ref:`Align` **align** @@ -159,7 +159,7 @@ Property Descriptions Text alignment as defined in the ALIGN\_\* enum. - .. _class_LineEdit_caret_blink: +.. _class_LineEdit_caret_blink: - :ref:`bool` **caret_blink** @@ -171,7 +171,7 @@ Text alignment as defined in the ALIGN\_\* enum. If ``true`` the caret (visual cursor) blinks. - .. _class_LineEdit_caret_blink_speed: +.. _class_LineEdit_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -183,7 +183,7 @@ If ``true`` the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. - .. _class_LineEdit_caret_position: +.. _class_LineEdit_caret_position: - :ref:`int` **caret_position** @@ -195,7 +195,7 @@ Duration (in seconds) of a caret's blinking cycle. The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it. - .. _class_LineEdit_clear_button_enabled: +.. _class_LineEdit_clear_button_enabled: - :ref:`bool` **clear_button_enabled** @@ -205,7 +205,7 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to | *Getter* | is_clear_button_enabled() | +----------+---------------------------------+ - .. _class_LineEdit_context_menu_enabled: +.. _class_LineEdit_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -217,7 +217,7 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to If ``true`` the context menu will appear when right clicked. - .. _class_LineEdit_editable: +.. _class_LineEdit_editable: - :ref:`bool` **editable** @@ -229,7 +229,7 @@ If ``true`` the context menu will appear when right clicked. If ``false`` existing text cannot be modified and new text cannot be added. - .. _class_LineEdit_expand_to_text_length: +.. _class_LineEdit_expand_to_text_length: - :ref:`bool` **expand_to_text_length** @@ -241,7 +241,7 @@ If ``false`` existing text cannot be modified and new text cannot be added. 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: +.. _class_LineEdit_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -253,7 +253,7 @@ If ``true`` the :ref:`LineEdit` width will increase to stay long 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: +.. _class_LineEdit_max_length: - :ref:`int` **max_length** @@ -265,7 +265,7 @@ Defines how the :ref:`LineEdit` can grab focus (Keyboard and mou Maximum amount of characters that can be entered inside the :ref:`LineEdit`. If ``0``, there is no limit. - .. _class_LineEdit_placeholder_alpha: +.. _class_LineEdit_placeholder_alpha: - :ref:`float` **placeholder_alpha** @@ -277,7 +277,7 @@ Maximum amount of characters that can be entered inside the :ref:`LineEdit`. From ``0`` to ``1``. - .. _class_LineEdit_placeholder_text: +.. _class_LineEdit_placeholder_text: - :ref:`String` **placeholder_text** @@ -289,7 +289,7 @@ Opacity of the :ref:`placeholder_text`. From `` Text shown when the :ref:`LineEdit` is empty. It is **not** the :ref:`LineEdit`'s default value (see :ref:`text`). - .. _class_LineEdit_secret: +.. _class_LineEdit_secret: - :ref:`bool` **secret** @@ -301,7 +301,7 @@ Text shown when the :ref:`LineEdit` is empty. It is **not** the If ``true``, every character is replaced with the secret character (see :ref:`secret_character`). - .. _class_LineEdit_secret_character: +.. _class_LineEdit_secret_character: - :ref:`String` **secret_character** @@ -313,7 +313,7 @@ If ``true``, every character is replaced with the secret character (see :ref:`se The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character. - .. _class_LineEdit_text: +.. _class_LineEdit_text: - :ref:`String` **text** @@ -328,37 +328,37 @@ String value of the :ref:`LineEdit`. Method Descriptions ------------------- - .. _class_LineEdit_append_at_cursor: +.. _class_LineEdit_append_at_cursor: - void **append_at_cursor** **(** :ref:`String` text **)** Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length`, nothing happens. - .. _class_LineEdit_clear: +.. _class_LineEdit_clear: - void **clear** **(** **)** Erases the :ref:`LineEdit` text. - .. _class_LineEdit_deselect: +.. _class_LineEdit_deselect: - void **deselect** **(** **)** Clears the current selection. - .. _class_LineEdit_get_menu: +.. _class_LineEdit_get_menu: - :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`. - .. _class_LineEdit_menu_option: +.. _class_LineEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** Executes a given action as defined in the MENU\_\* enum. - .. _class_LineEdit_select: +.. _class_LineEdit_select: - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** @@ -371,7 +371,7 @@ Selects characters inside :ref:`LineEdit` between ``from`` and ` select(4) # ome select(2, 5) # lco - .. _class_LineEdit_select_all: +.. _class_LineEdit_select_all: - void **select_all** **(** **)** diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 750a156f8..2d9e33459 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -33,7 +33,7 @@ Line shape for 2D collisions. It works like a 2D plane and will not allow any bo Property Descriptions --------------------- - .. _class_LineShape2D_d: +.. _class_LineShape2D_d: - :ref:`float` **d** @@ -45,7 +45,7 @@ Property Descriptions The line's distance from the origin. - .. _class_LineShape2D_normal: +.. _class_LineShape2D_normal: - :ref:`Vector2` **normal** diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 2d3ad1069..0a4364eba 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -45,7 +45,7 @@ Theme Properties Enumerations ------------ - .. _enum_LinkButton_UnderlineMode: +.. _enum_LinkButton_UnderlineMode: enum **UnderlineMode**: @@ -61,7 +61,7 @@ This kind of buttons are primarily used when the interaction with the button cau Property Descriptions --------------------- - .. _class_LinkButton_text: +.. _class_LinkButton_text: - :ref:`String` **text** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | get_text() | +----------+-----------------+ - .. _class_LinkButton_underline: +.. _class_LinkButton_underline: - :ref:`UnderlineMode` **underline** diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 27c6321dc..4b822d89a 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -32,19 +32,19 @@ Methods Method Descriptions ------------------- - .. _class_Listener_clear_current: +.. _class_Listener_clear_current: - void **clear_current** **(** **)** - .. _class_Listener_get_listener_transform: +.. _class_Listener_get_listener_transform: - :ref:`Transform` **get_listener_transform** **(** **)** const - .. _class_Listener_is_current: +.. _class_Listener_is_current: - :ref:`bool` **is_current** **(** **)** const - .. _class_Listener_make_current: +.. _class_Listener_make_current: - void **make_current** **(** **)** diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 4c09be4ec..e7add13c3 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -63,6 +63,7 @@ Constants - **NOTIFICATION_TRANSLATION_CHANGED** = **90** - **NOTIFICATION_WM_ABOUT** = **91** - **NOTIFICATION_CRASH** = **92** + Description ----------- @@ -71,61 +72,61 @@ Main loop is the abstract main loop base class. All other main loop classes are Method Descriptions ------------------- - .. _class_MainLoop__drop_files: +.. _class_MainLoop__drop_files: - void **_drop_files** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** virtual - .. _class_MainLoop__finalize: +.. _class_MainLoop__finalize: - void **_finalize** **(** **)** virtual Called before the program exits. - .. _class_MainLoop__idle: +.. _class_MainLoop__idle: - void **_idle** **(** :ref:`float` delta **)** virtual Called each idle frame with time since last call as an only argument. - .. _class_MainLoop__initialize: +.. _class_MainLoop__initialize: - void **_initialize** **(** **)** virtual Called once during initialization. - .. _class_MainLoop__input_event: +.. _class_MainLoop__input_event: - void **_input_event** **(** :ref:`InputEvent` event **)** virtual - .. _class_MainLoop__input_text: +.. _class_MainLoop__input_text: - void **_input_text** **(** :ref:`String` text **)** virtual - .. _class_MainLoop__iteration: +.. _class_MainLoop__iteration: - void **_iteration** **(** :ref:`float` delta **)** virtual - .. _class_MainLoop_finish: +.. _class_MainLoop_finish: - void **finish** **(** **)** - .. _class_MainLoop_idle: +.. _class_MainLoop_idle: - :ref:`bool` **idle** **(** :ref:`float` delta **)** - .. _class_MainLoop_init: +.. _class_MainLoop_init: - void **init** **(** **)** - .. _class_MainLoop_input_event: +.. _class_MainLoop_input_event: - void **input_event** **(** :ref:`InputEvent` event **)** - .. _class_MainLoop_input_text: +.. _class_MainLoop_input_text: - void **input_text** **(** :ref:`String` text **)** - .. _class_MainLoop_iteration: +.. _class_MainLoop_iteration: - :ref:`bool` **iteration** **(** :ref:`float` delta **)** diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 907adc39c..65b657db1 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -41,37 +41,37 @@ Provides data transformation and encoding utility functions. Method Descriptions ------------------- - .. _class_Marshalls_base64_to_raw: +.. _class_Marshalls_base64_to_raw: - :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** Return :ref:`PoolByteArray` of a given base64 encoded String. - .. _class_Marshalls_base64_to_utf8: +.. _class_Marshalls_base64_to_utf8: - :ref:`String` **base64_to_utf8** **(** :ref:`String` base64_str **)** Return utf8 String of a given base64 encoded String. - .. _class_Marshalls_base64_to_variant: +.. _class_Marshalls_base64_to_variant: - :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** Return :ref:`Variant` of a given base64 encoded String. - .. _class_Marshalls_raw_to_base64: +.. _class_Marshalls_raw_to_base64: - :ref:`String` **raw_to_base64** **(** :ref:`PoolByteArray` array **)** Return base64 encoded String of a given :ref:`PoolByteArray`. - .. _class_Marshalls_utf8_to_base64: +.. _class_Marshalls_utf8_to_base64: - :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** Return base64 encoded String of a given utf8 String. - .. _class_Marshalls_variant_to_base64: +.. _class_Marshalls_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** diff --git a/classes/class_material.rst b/classes/class_material.rst index 0c4588f8c..21eb29a7d 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -32,6 +32,7 @@ Constants - **RENDER_PRIORITY_MAX** = **127** - **RENDER_PRIORITY_MIN** = **-128** + Description ----------- @@ -40,7 +41,7 @@ Material is a base :ref:`Resource` used for coloring and shading Property Descriptions --------------------- - .. _class_Material_next_pass: +.. _class_Material_next_pass: - :ref:`Material` **next_pass** @@ -50,7 +51,7 @@ Property Descriptions | *Getter* | get_next_pass() | +----------+----------------------+ - .. _class_Material_render_priority: +.. _class_Material_render_priority: - :ref:`int` **render_priority** diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 65aa1ddea..be49ad978 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -55,7 +55,7 @@ Theme Properties Signals ------- - .. _class_MenuButton_about_to_show: +.. _class_MenuButton_about_to_show: - **about_to_show** **(** **)** @@ -69,13 +69,13 @@ Special button that brings up a :ref:`PopupMenu` when clicked. Method Descriptions ------------------- - .. _class_MenuButton_get_popup: +.. _class_MenuButton_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. - .. _class_MenuButton_set_disable_shortcuts: +.. _class_MenuButton_set_disable_shortcuts: - void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 8aaf27363..3e3eb19aa 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -51,14 +51,14 @@ Methods Enumerations ------------ - .. _enum_Mesh_BlendShapeMode: +.. _enum_Mesh_BlendShapeMode: enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** - .. _enum_Mesh_ArrayType: +.. _enum_Mesh_ArrayType: enum **ArrayType**: @@ -73,7 +73,7 @@ enum **ArrayType**: - **ARRAY_INDEX** = **8** --- Array of indices. - **ARRAY_MAX** = **9** - .. _enum_Mesh_ArrayFormat: +.. _enum_Mesh_ArrayFormat: enum **ArrayFormat**: @@ -100,7 +100,7 @@ enum **ArrayFormat**: - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** - **ARRAY_COMPRESS_DEFAULT** = **97280** - .. _enum_Mesh_PrimitiveType: +.. _enum_Mesh_PrimitiveType: enum **PrimitiveType**: @@ -120,7 +120,7 @@ Mesh is a type of :ref:`Resource` that contains vertex-array bas Property Descriptions --------------------- - .. _class_Mesh_lightmap_size_hint: +.. _class_Mesh_lightmap_size_hint: - :ref:`Vector2` **lightmap_size_hint** @@ -133,55 +133,55 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Mesh_create_convex_shape: +.. _class_Mesh_create_convex_shape: - :ref:`Shape` **create_convex_shape** **(** **)** const Calculate a :ref:`ConvexPolygonShape` from the mesh. - .. _class_Mesh_create_outline: +.. _class_Mesh_create_outline: - :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: +.. _class_Mesh_create_trimesh_shape: - :ref:`Shape` **create_trimesh_shape** **(** **)** const Calculate a :ref:`ConcavePolygonShape` from the mesh. - .. _class_Mesh_generate_triangle_mesh: +.. _class_Mesh_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const Generate a :ref:`TriangleMesh` from the mesh. - .. _class_Mesh_get_faces: +.. _class_Mesh_get_faces: - :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: +.. _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: +.. _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: +.. _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: +.. _class_Mesh_surface_get_material: - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 830a2edb6..c617e8981 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -100,155 +100,155 @@ Methods Method Descriptions ------------------- - .. _class_MeshDataTool_clear: +.. _class_MeshDataTool_clear: - void **clear** **(** **)** - .. _class_MeshDataTool_commit_to_surface: +.. _class_MeshDataTool_commit_to_surface: - :ref:`Error` **commit_to_surface** **(** :ref:`ArrayMesh` mesh **)** - .. _class_MeshDataTool_create_from_surface: +.. _class_MeshDataTool_create_from_surface: - :ref:`Error` **create_from_surface** **(** :ref:`ArrayMesh` mesh, :ref:`int` surface **)** - .. _class_MeshDataTool_get_edge_count: +.. _class_MeshDataTool_get_edge_count: - :ref:`int` **get_edge_count** **(** **)** const - .. _class_MeshDataTool_get_edge_faces: +.. _class_MeshDataTool_get_edge_faces: - :ref:`PoolIntArray` **get_edge_faces** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_edge_meta: +.. _class_MeshDataTool_get_edge_meta: - :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_edge_vertex: +.. _class_MeshDataTool_get_edge_vertex: - :ref:`int` **get_edge_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const - .. _class_MeshDataTool_get_face_count: +.. _class_MeshDataTool_get_face_count: - :ref:`int` **get_face_count** **(** **)** const - .. _class_MeshDataTool_get_face_edge: +.. _class_MeshDataTool_get_face_edge: - :ref:`int` **get_face_edge** **(** :ref:`int` idx, :ref:`int` edge **)** const - .. _class_MeshDataTool_get_face_meta: +.. _class_MeshDataTool_get_face_meta: - :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_face_normal: +.. _class_MeshDataTool_get_face_normal: - :ref:`Vector3` **get_face_normal** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_face_vertex: +.. _class_MeshDataTool_get_face_vertex: - :ref:`int` **get_face_vertex** **(** :ref:`int` idx, :ref:`int` vertex **)** const - .. _class_MeshDataTool_get_format: +.. _class_MeshDataTool_get_format: - :ref:`int` **get_format** **(** **)** const - .. _class_MeshDataTool_get_material: +.. _class_MeshDataTool_get_material: - :ref:`Material` **get_material** **(** **)** const - .. _class_MeshDataTool_get_vertex: +.. _class_MeshDataTool_get_vertex: - :ref:`Vector3` **get_vertex** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_bones: +.. _class_MeshDataTool_get_vertex_bones: - :ref:`PoolIntArray` **get_vertex_bones** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_color: +.. _class_MeshDataTool_get_vertex_color: - :ref:`Color` **get_vertex_color** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_count: +.. _class_MeshDataTool_get_vertex_count: - :ref:`int` **get_vertex_count** **(** **)** const - .. _class_MeshDataTool_get_vertex_edges: +.. _class_MeshDataTool_get_vertex_edges: - :ref:`PoolIntArray` **get_vertex_edges** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_faces: +.. _class_MeshDataTool_get_vertex_faces: - :ref:`PoolIntArray` **get_vertex_faces** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_meta: +.. _class_MeshDataTool_get_vertex_meta: - :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_normal: +.. _class_MeshDataTool_get_vertex_normal: - :ref:`Vector3` **get_vertex_normal** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_tangent: +.. _class_MeshDataTool_get_vertex_tangent: - :ref:`Plane` **get_vertex_tangent** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_uv: +.. _class_MeshDataTool_get_vertex_uv: - :ref:`Vector2` **get_vertex_uv** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_uv2: +.. _class_MeshDataTool_get_vertex_uv2: - :ref:`Vector2` **get_vertex_uv2** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_get_vertex_weights: +.. _class_MeshDataTool_get_vertex_weights: - :ref:`PoolRealArray` **get_vertex_weights** **(** :ref:`int` idx **)** const - .. _class_MeshDataTool_set_edge_meta: +.. _class_MeshDataTool_set_edge_meta: - void **set_edge_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** - .. _class_MeshDataTool_set_face_meta: +.. _class_MeshDataTool_set_face_meta: - void **set_face_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** - .. _class_MeshDataTool_set_material: +.. _class_MeshDataTool_set_material: - void **set_material** **(** :ref:`Material` material **)** - .. _class_MeshDataTool_set_vertex: +.. _class_MeshDataTool_set_vertex: - void **set_vertex** **(** :ref:`int` idx, :ref:`Vector3` vertex **)** - .. _class_MeshDataTool_set_vertex_bones: +.. _class_MeshDataTool_set_vertex_bones: - void **set_vertex_bones** **(** :ref:`int` idx, :ref:`PoolIntArray` bones **)** - .. _class_MeshDataTool_set_vertex_color: +.. _class_MeshDataTool_set_vertex_color: - void **set_vertex_color** **(** :ref:`int` idx, :ref:`Color` color **)** - .. _class_MeshDataTool_set_vertex_meta: +.. _class_MeshDataTool_set_vertex_meta: - void **set_vertex_meta** **(** :ref:`int` idx, :ref:`Variant` meta **)** - .. _class_MeshDataTool_set_vertex_normal: +.. _class_MeshDataTool_set_vertex_normal: - void **set_vertex_normal** **(** :ref:`int` idx, :ref:`Vector3` normal **)** - .. _class_MeshDataTool_set_vertex_tangent: +.. _class_MeshDataTool_set_vertex_tangent: - void **set_vertex_tangent** **(** :ref:`int` idx, :ref:`Plane` tangent **)** - .. _class_MeshDataTool_set_vertex_uv: +.. _class_MeshDataTool_set_vertex_uv: - void **set_vertex_uv** **(** :ref:`int` idx, :ref:`Vector2` uv **)** - .. _class_MeshDataTool_set_vertex_uv2: +.. _class_MeshDataTool_set_vertex_uv2: - void **set_vertex_uv2** **(** :ref:`int` idx, :ref:`Vector2` uv2 **)** - .. _class_MeshDataTool_set_vertex_weights: +.. _class_MeshDataTool_set_vertex_weights: - void **set_vertex_weights** **(** :ref:`int` idx, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 1db8a51ad..e7145a9f2 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -50,7 +50,7 @@ MeshInstance is a node that takes a :ref:`Mesh` resource and adds it Property Descriptions --------------------- - .. _class_MeshInstance_mesh: +.. _class_MeshInstance_mesh: - :ref:`Mesh` **mesh** @@ -62,7 +62,7 @@ Property Descriptions The :ref:`Mesh` resource for the instance. - .. _class_MeshInstance_skeleton: +.. _class_MeshInstance_skeleton: - :ref:`NodePath` **skeleton** @@ -77,31 +77,31 @@ The :ref:`Mesh` resource for the instance. Method Descriptions ------------------- - .. _class_MeshInstance_create_convex_collision: +.. _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. - .. _class_MeshInstance_create_debug_tangents: +.. _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. - .. _class_MeshInstance_create_trimesh_collision: +.. _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. - .. _class_MeshInstance_get_surface_material: +.. _class_MeshInstance_get_surface_material: - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. - .. _class_MeshInstance_set_surface_material: +.. _class_MeshInstance_set_surface_material: - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** diff --git a/classes/class_meshinstance2d.rst b/classes/class_meshinstance2d.rst index 3a1e74981..9732d14db 100644 --- a/classes/class_meshinstance2d.rst +++ b/classes/class_meshinstance2d.rst @@ -30,7 +30,7 @@ Properties Property Descriptions --------------------- - .. _class_MeshInstance2D_mesh: +.. _class_MeshInstance2D_mesh: - :ref:`Mesh` **mesh** @@ -40,7 +40,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ - .. _class_MeshInstance2D_normal_map: +.. _class_MeshInstance2D_normal_map: - :ref:`Texture` **normal_map** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_normal_map() | +----------+-----------------------+ - .. _class_MeshInstance2D_texture: +.. _class_MeshInstance2D_texture: - :ref:`Texture` **texture** diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 967abd9ab..1b9781c64 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -61,85 +61,85 @@ Library of meshes. Contains a list of :ref:`Mesh` resources, each wi Method Descriptions ------------------- - .. _class_MeshLibrary_clear: +.. _class_MeshLibrary_clear: - void **clear** **(** **)** Clear the library. - .. _class_MeshLibrary_create_item: +.. _class_MeshLibrary_create_item: - void **create_item** **(** :ref:`int` id **)** Create a new item in the library, supplied an id. - .. _class_MeshLibrary_find_item_by_name: +.. _class_MeshLibrary_find_item_by_name: - :ref:`int` **find_item_by_name** **(** :ref:`String` name **)** const - .. _class_MeshLibrary_get_item_list: +.. _class_MeshLibrary_get_item_list: - :ref:`PoolIntArray` **get_item_list** **(** **)** const Return the list of items. - .. _class_MeshLibrary_get_item_mesh: +.. _class_MeshLibrary_get_item_mesh: - :ref:`Mesh` **get_item_mesh** **(** :ref:`int` id **)** const Return the mesh of the item. - .. _class_MeshLibrary_get_item_name: +.. _class_MeshLibrary_get_item_name: - :ref:`String` **get_item_name** **(** :ref:`int` id **)** const Return the name of the item. - .. _class_MeshLibrary_get_item_navmesh: +.. _class_MeshLibrary_get_item_navmesh: - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const - .. _class_MeshLibrary_get_item_preview: +.. _class_MeshLibrary_get_item_preview: - :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const - .. _class_MeshLibrary_get_item_shapes: +.. _class_MeshLibrary_get_item_shapes: - :ref:`Array` **get_item_shapes** **(** :ref:`int` id **)** const - .. _class_MeshLibrary_get_last_unused_item_id: +.. _class_MeshLibrary_get_last_unused_item_id: - :ref:`int` **get_last_unused_item_id** **(** **)** const Get an unused id for a new item. - .. _class_MeshLibrary_remove_item: +.. _class_MeshLibrary_remove_item: - void **remove_item** **(** :ref:`int` id **)** Remove the item. - .. _class_MeshLibrary_set_item_mesh: +.. _class_MeshLibrary_set_item_mesh: - void **set_item_mesh** **(** :ref:`int` id, :ref:`Mesh` mesh **)** Set the mesh of the item. - .. _class_MeshLibrary_set_item_name: +.. _class_MeshLibrary_set_item_name: - void **set_item_name** **(** :ref:`int` id, :ref:`String` name **)** Set the name of the item. - .. _class_MeshLibrary_set_item_navmesh: +.. _class_MeshLibrary_set_item_navmesh: - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** - .. _class_MeshLibrary_set_item_preview: +.. _class_MeshLibrary_set_item_preview: - void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** - .. _class_MeshLibrary_set_item_shapes: +.. _class_MeshLibrary_set_item_shapes: - void **set_item_shapes** **(** :ref:`int` id, :ref:`Array` shapes **)** diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 35fd9af3b..f366c364d 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -43,7 +43,7 @@ Note that even though there is no positional tracking the camera will assume the Property Descriptions --------------------- - .. _class_MobileVRInterface_display_to_lens: +.. _class_MobileVRInterface_display_to_lens: - :ref:`float` **display_to_lens** @@ -55,7 +55,7 @@ Property Descriptions The distance between the display and the lenses inside of the device in centimeters. - .. _class_MobileVRInterface_display_width: +.. _class_MobileVRInterface_display_width: - :ref:`float` **display_width** @@ -67,7 +67,7 @@ The distance between the display and the lenses inside of the device in centimet The width of the display in centimeters. - .. _class_MobileVRInterface_iod: +.. _class_MobileVRInterface_iod: - :ref:`float` **iod** @@ -79,7 +79,7 @@ The width of the display in centimeters. The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. - .. _class_MobileVRInterface_k1: +.. _class_MobileVRInterface_k1: - :ref:`float` **k1** @@ -91,7 +91,7 @@ The interocular distance, also known as the interpupillary distance. The distanc The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. - .. _class_MobileVRInterface_k2: +.. _class_MobileVRInterface_k2: - :ref:`float` **k2** @@ -103,7 +103,7 @@ The k1 lens factor is one of the two constants that define the strength of the l The k2 lens factor, see k1. - .. _class_MobileVRInterface_oversample: +.. _class_MobileVRInterface_oversample: - :ref:`float` **oversample** diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 1d81d3167..0bd083421 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -53,14 +53,14 @@ Methods Enumerations ------------ - .. _enum_MultiMesh_TransformFormat: +.. _enum_MultiMesh_TransformFormat: enum **TransformFormat**: - **TRANSFORM_2D** = **0** - **TRANSFORM_3D** = **1** - .. _enum_MultiMesh_ColorFormat: +.. _enum_MultiMesh_ColorFormat: enum **ColorFormat**: @@ -68,7 +68,7 @@ enum **ColorFormat**: - **COLOR_8BIT** = **1** - **COLOR_FLOAT** = **2** - .. _enum_MultiMesh_CustomDataFormat: +.. _enum_MultiMesh_CustomDataFormat: enum **CustomDataFormat**: @@ -90,7 +90,7 @@ Since instances may have any behavior, the AABB used for visibility must be prov Property Descriptions --------------------- - .. _class_MultiMesh_color_format: +.. _class_MultiMesh_color_format: - :ref:`ColorFormat` **color_format** @@ -100,7 +100,7 @@ Property Descriptions | *Getter* | get_color_format() | +----------+-------------------------+ - .. _class_MultiMesh_custom_data_format: +.. _class_MultiMesh_custom_data_format: - :ref:`CustomDataFormat` **custom_data_format** @@ -110,7 +110,7 @@ Property Descriptions | *Getter* | get_custom_data_format() | +----------+-------------------------------+ - .. _class_MultiMesh_instance_count: +.. _class_MultiMesh_instance_count: - :ref:`int` **instance_count** @@ -120,7 +120,7 @@ Property Descriptions | *Getter* | get_instance_count() | +----------+---------------------------+ - .. _class_MultiMesh_mesh: +.. _class_MultiMesh_mesh: - :ref:`Mesh` **mesh** @@ -130,7 +130,7 @@ Property Descriptions | *Getter* | get_mesh() | +----------+-----------------+ - .. _class_MultiMesh_transform_format: +.. _class_MultiMesh_transform_format: - :ref:`TransformFormat` **transform_format** @@ -143,39 +143,39 @@ Property Descriptions Method Descriptions ------------------- - .. _class_MultiMesh_get_aabb: +.. _class_MultiMesh_get_aabb: - :ref:`AABB` **get_aabb** **(** **)** const Return the visibility AABB. - .. _class_MultiMesh_get_instance_color: +.. _class_MultiMesh_get_instance_color: - :ref:`Color` **get_instance_color** **(** :ref:`int` instance **)** const Get the color of a specific instance. - .. _class_MultiMesh_get_instance_custom_data: +.. _class_MultiMesh_get_instance_custom_data: - :ref:`Color` **get_instance_custom_data** **(** :ref:`int` instance **)** const - .. _class_MultiMesh_get_instance_transform: +.. _class_MultiMesh_get_instance_transform: - :ref:`Transform` **get_instance_transform** **(** :ref:`int` instance **)** const Return the transform of a specific instance. - .. _class_MultiMesh_set_instance_color: +.. _class_MultiMesh_set_instance_color: - void **set_instance_color** **(** :ref:`int` instance, :ref:`Color` color **)** Set the color of a specific instance. - .. _class_MultiMesh_set_instance_custom_data: +.. _class_MultiMesh_set_instance_custom_data: - void **set_instance_custom_data** **(** :ref:`int` instance, :ref:`Color` custom_data **)** - .. _class_MultiMesh_set_instance_transform: +.. _class_MultiMesh_set_instance_transform: - void **set_instance_transform** **(** :ref:`int` instance, :ref:`Transform` transform **)** diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 6122615ff..325cc4f31 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -33,7 +33,7 @@ This is useful to optimize the rendering of a high amount of instances of a give Property Descriptions --------------------- - .. _class_MultiMeshInstance_multimesh: +.. _class_MultiMeshInstance_multimesh: - :ref:`MultiMesh` **multimesh** diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index e39326ab6..87f29b39d 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -51,37 +51,37 @@ Methods Signals ------- - .. _class_MultiplayerAPI_connected_to_server: +.. _class_MultiplayerAPI_connected_to_server: - **connected_to_server** **(** **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` successfully connected to a server. Only emitted on clients. - .. _class_MultiplayerAPI_connection_failed: +.. _class_MultiplayerAPI_connection_failed: - **connection_failed** **(** **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. - .. _class_MultiplayerAPI_network_peer_connected: +.. _class_MultiplayerAPI_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). - .. _class_MultiplayerAPI_network_peer_disconnected: +.. _class_MultiplayerAPI_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** Emitted whenever this MultiplayerAPI's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. - .. _class_MultiplayerAPI_network_peer_packet: +.. _class_MultiplayerAPI_network_peer_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. - .. _class_MultiplayerAPI_server_disconnected: +.. _class_MultiplayerAPI_server_disconnected: - **server_disconnected** **(** **)** @@ -90,7 +90,7 @@ Emitted whenever this MultiplayerAPI's :ref:`network_peer` **network_peer** @@ -128,7 +128,7 @@ Property Descriptions 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 puppet. 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: +.. _class_MultiplayerAPI_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -143,25 +143,25 @@ If ``true`` the MultiplayerAPI's :ref:`network_peer` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this MultiplayerAPI's :ref:`network_peer`. - .. _class_MultiplayerAPI_get_network_unique_id: +.. _class_MultiplayerAPI_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this MultiplayerAPI's :ref:`network_peer`. - .. _class_MultiplayerAPI_get_rpc_sender_id: +.. _class_MultiplayerAPI_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const @@ -169,19 +169,19 @@ Returns the sender's peer ID for the RPC currently being executed. NOTE: If not inside an RPC this method will return 0. - .. _class_MultiplayerAPI_has_network_peer: +.. _class_MultiplayerAPI_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. - .. _class_MultiplayerAPI_is_network_server: +.. _class_MultiplayerAPI_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const Returns ``true`` if this MultiplayerAPI's :ref:`network_peer` is in server mode (listening for connections). - .. _class_MultiplayerAPI_poll: +.. _class_MultiplayerAPI_poll: - void **poll** **(** **)** @@ -189,13 +189,13 @@ Method used for polling the MultiplayerAPI. You only need to worry about this if 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: +.. _class_MultiplayerAPI_send_bytes: - :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: +.. _class_MultiplayerAPI_set_root_node: - void **set_root_node** **(** :ref:`Node` node **)** diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 3bf8b93de..619020858 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -35,19 +35,19 @@ A synchronization Mutex. Element used to synchronize multiple :ref:`Thread` **try_lock** **(** **)** Try locking this ``Mutex``, does not block. Returns OK on success, ERR_BUSY otherwise. - .. _class_Mutex_unlock: +.. _class_Mutex_unlock: - void **unlock** **(** **)** diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index c250625c2..aec3fc1f6 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -47,7 +47,7 @@ Methods Property Descriptions --------------------- - .. _class_NativeScript_class_name: +.. _class_NativeScript_class_name: - :ref:`String` **class_name** @@ -57,7 +57,7 @@ Property Descriptions | *Getter* | get_class_name() | +----------+-----------------------+ - .. _class_NativeScript_library: +.. _class_NativeScript_library: - :ref:`GDNativeLibrary` **library** @@ -67,7 +67,7 @@ Property Descriptions | *Getter* | get_library() | +----------+--------------------+ - .. _class_NativeScript_script_class_icon_path: +.. _class_NativeScript_script_class_icon_path: - :ref:`String` **script_class_icon_path** @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_script_class_icon_path() | +----------+-----------------------------------+ - .. _class_NativeScript_script_class_name: +.. _class_NativeScript_script_class_name: - :ref:`String` **script_class_name** @@ -90,31 +90,31 @@ Property Descriptions Method Descriptions ------------------- - .. _class_NativeScript_get_class_documentation: +.. _class_NativeScript_get_class_documentation: - :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: +.. _class_NativeScript_get_method_documentation: - :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: +.. _class_NativeScript_get_property_documentation: - :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: +.. _class_NativeScript_get_signal_documentation: - :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: +.. _class_NativeScript_new: - :ref:`Object` **new** **(** **)** vararg diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index df3c9075b..1f12f5e22 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -52,7 +52,7 @@ Provides navigation and pathfinding within a collection of :ref:`NavigationMesh< Property Descriptions --------------------- - .. _class_Navigation_up_vector: +.. _class_Navigation_up_vector: - :ref:`Vector3` **up_vector** @@ -67,49 +67,49 @@ Defines which direction is up. By default this is ``(0, 1, 0)``, which is the wo Method Descriptions ------------------- - .. _class_Navigation_get_closest_point: +.. _class_Navigation_get_closest_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: +.. _class_Navigation_get_closest_point_normal: - :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: +.. _class_Navigation_get_closest_point_owner: - :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). - .. _class_Navigation_get_closest_point_to_segment: +.. _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 **)** 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: +.. _class_Navigation_get_simple_path: - :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. - .. _class_Navigation_navmesh_add: +.. _class_Navigation_navmesh_add: - :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`. - .. _class_Navigation_navmesh_remove: +.. _class_Navigation_navmesh_remove: - void **navmesh_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationMesh` with the given ID. - .. _class_Navigation_navmesh_set_transform: +.. _class_Navigation_navmesh_set_transform: - void **navmesh_set_transform** **(** :ref:`int` id, :ref:`Transform` xform **)** diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 355699215..237b38a1b 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -41,37 +41,37 @@ Navigation2D provides navigation and pathfinding within a 2D area, specified as Method Descriptions ------------------- - .. _class_Navigation2D_get_closest_point: +.. _class_Navigation2D_get_closest_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: +.. _class_Navigation2D_get_closest_point_owner: - :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). - .. _class_Navigation2D_get_simple_path: +.. _class_Navigation2D_get_simple_path: - :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: +.. _class_Navigation2D_navpoly_add: - :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`. - .. _class_Navigation2D_navpoly_remove: +.. _class_Navigation2D_navpoly_remove: - void **navpoly_remove** **(** :ref:`int` id **)** Removes the :ref:`NavigationPolygon` with the given ID. - .. _class_Navigation2D_navpoly_set_transform: +.. _class_Navigation2D_navpoly_set_transform: - void **navpoly_set_transform** **(** :ref:`int` id, :ref:`Transform2D` xform **)** diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index b25fbaba4..50e98d54c 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -80,10 +80,11 @@ Constants - **SAMPLE_PARTITION_WATERSHED** = **0** - **SAMPLE_PARTITION_MONOTONE** = **1** - **SAMPLE_PARTITION_LAYERS** = **2** + Property Descriptions --------------------- - .. _class_NavigationMesh_agent/height: +.. _class_NavigationMesh_agent/height: - :ref:`float` **agent/height** @@ -93,7 +94,7 @@ Property Descriptions | *Getter* | get_agent_height() | +----------+-------------------------+ - .. _class_NavigationMesh_agent/max_climb: +.. _class_NavigationMesh_agent/max_climb: - :ref:`float` **agent/max_climb** @@ -103,7 +104,7 @@ Property Descriptions | *Getter* | get_agent_max_climb() | +----------+----------------------------+ - .. _class_NavigationMesh_agent/max_slope: +.. _class_NavigationMesh_agent/max_slope: - :ref:`float` **agent/max_slope** @@ -113,7 +114,7 @@ Property Descriptions | *Getter* | get_agent_max_slope() | +----------+----------------------------+ - .. _class_NavigationMesh_agent/radius: +.. _class_NavigationMesh_agent/radius: - :ref:`float` **agent/radius** @@ -123,7 +124,7 @@ Property Descriptions | *Getter* | get_agent_radius() | +----------+-------------------------+ - .. _class_NavigationMesh_cell/height: +.. _class_NavigationMesh_cell/height: - :ref:`float` **cell/height** @@ -133,7 +134,7 @@ Property Descriptions | *Getter* | get_cell_height() | +----------+------------------------+ - .. _class_NavigationMesh_cell/size: +.. _class_NavigationMesh_cell/size: - :ref:`float` **cell/size** @@ -143,7 +144,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ - .. _class_NavigationMesh_detail/sample_distance: +.. _class_NavigationMesh_detail/sample_distance: - :ref:`float` **detail/sample_distance** @@ -153,7 +154,7 @@ Property Descriptions | *Getter* | get_detail_sample_distance() | +----------+-----------------------------------+ - .. _class_NavigationMesh_detail/sample_max_error: +.. _class_NavigationMesh_detail/sample_max_error: - :ref:`float` **detail/sample_max_error** @@ -163,7 +164,7 @@ Property Descriptions | *Getter* | get_detail_sample_max_error() | +----------+------------------------------------+ - .. _class_NavigationMesh_edge/max_error: +.. _class_NavigationMesh_edge/max_error: - :ref:`float` **edge/max_error** @@ -173,7 +174,7 @@ Property Descriptions | *Getter* | get_edge_max_error() | +----------+---------------------------+ - .. _class_NavigationMesh_edge/max_length: +.. _class_NavigationMesh_edge/max_length: - :ref:`float` **edge/max_length** @@ -183,7 +184,7 @@ Property Descriptions | *Getter* | get_edge_max_length() | +----------+----------------------------+ - .. _class_NavigationMesh_filter/filter_walkable_low_height_spans: +.. _class_NavigationMesh_filter/filter_walkable_low_height_spans: - :ref:`bool` **filter/filter_walkable_low_height_spans** @@ -193,7 +194,7 @@ Property Descriptions | *Getter* | get_filter_walkable_low_height_spans() | +----------+---------------------------------------------+ - .. _class_NavigationMesh_filter/ledge_spans: +.. _class_NavigationMesh_filter/ledge_spans: - :ref:`bool` **filter/ledge_spans** @@ -203,7 +204,7 @@ Property Descriptions | *Getter* | get_filter_ledge_spans() | +----------+-------------------------------+ - .. _class_NavigationMesh_filter/low_hanging_obstacles: +.. _class_NavigationMesh_filter/low_hanging_obstacles: - :ref:`bool` **filter/low_hanging_obstacles** @@ -213,7 +214,7 @@ Property Descriptions | *Getter* | get_filter_low_hanging_obstacles() | +----------+-----------------------------------------+ - .. _class_NavigationMesh_polygon/verts_per_poly: +.. _class_NavigationMesh_polygon/verts_per_poly: - :ref:`float` **polygon/verts_per_poly** @@ -223,7 +224,7 @@ Property Descriptions | *Getter* | get_verts_per_poly() | +----------+---------------------------+ - .. _class_NavigationMesh_region/merge_size: +.. _class_NavigationMesh_region/merge_size: - :ref:`float` **region/merge_size** @@ -233,7 +234,7 @@ Property Descriptions | *Getter* | get_region_merge_size() | +----------+------------------------------+ - .. _class_NavigationMesh_region/min_size: +.. _class_NavigationMesh_region/min_size: - :ref:`float` **region/min_size** @@ -243,7 +244,7 @@ Property Descriptions | *Getter* | get_region_min_size() | +----------+----------------------------+ - .. _class_NavigationMesh_sample_partition_type/sample_partition_type: +.. _class_NavigationMesh_sample_partition_type/sample_partition_type: - :ref:`int` **sample_partition_type/sample_partition_type** @@ -256,31 +257,31 @@ Property Descriptions Method Descriptions ------------------- - .. _class_NavigationMesh_add_polygon: +.. _class_NavigationMesh_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** - .. _class_NavigationMesh_clear_polygons: +.. _class_NavigationMesh_clear_polygons: - void **clear_polygons** **(** **)** - .. _class_NavigationMesh_create_from_mesh: +.. _class_NavigationMesh_create_from_mesh: - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** - .. _class_NavigationMesh_get_polygon: +.. _class_NavigationMesh_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** - .. _class_NavigationMesh_get_polygon_count: +.. _class_NavigationMesh_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const - .. _class_NavigationMesh_get_vertices: +.. _class_NavigationMesh_get_vertices: - :ref:`PoolVector3Array` **get_vertices** **(** **)** const - .. _class_NavigationMesh_set_vertices: +.. _class_NavigationMesh_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 37416167d..a77e7349d 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_NavigationMeshInstance_enabled: +.. _class_NavigationMeshInstance_enabled: - :ref:`bool` **enabled** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ - .. _class_NavigationMeshInstance_navmesh: +.. _class_NavigationMeshInstance_navmesh: - :ref:`NavigationMesh` **navmesh** diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index f02ce13fc..86a75939f 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -52,59 +52,59 @@ Methods Method Descriptions ------------------- - .. _class_NavigationPolygon_add_outline: +.. _class_NavigationPolygon_add_outline: - void **add_outline** **(** :ref:`PoolVector2Array` outline **)** - .. _class_NavigationPolygon_add_outline_at_index: +.. _class_NavigationPolygon_add_outline_at_index: - void **add_outline_at_index** **(** :ref:`PoolVector2Array` outline, :ref:`int` index **)** - .. _class_NavigationPolygon_add_polygon: +.. _class_NavigationPolygon_add_polygon: - void **add_polygon** **(** :ref:`PoolIntArray` polygon **)** - .. _class_NavigationPolygon_clear_outlines: +.. _class_NavigationPolygon_clear_outlines: - void **clear_outlines** **(** **)** - .. _class_NavigationPolygon_clear_polygons: +.. _class_NavigationPolygon_clear_polygons: - void **clear_polygons** **(** **)** - .. _class_NavigationPolygon_get_outline: +.. _class_NavigationPolygon_get_outline: - :ref:`PoolVector2Array` **get_outline** **(** :ref:`int` idx **)** const - .. _class_NavigationPolygon_get_outline_count: +.. _class_NavigationPolygon_get_outline_count: - :ref:`int` **get_outline_count** **(** **)** const - .. _class_NavigationPolygon_get_polygon: +.. _class_NavigationPolygon_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** - .. _class_NavigationPolygon_get_polygon_count: +.. _class_NavigationPolygon_get_polygon_count: - :ref:`int` **get_polygon_count** **(** **)** const - .. _class_NavigationPolygon_get_vertices: +.. _class_NavigationPolygon_get_vertices: - :ref:`PoolVector2Array` **get_vertices** **(** **)** const - .. _class_NavigationPolygon_make_polygons_from_outlines: +.. _class_NavigationPolygon_make_polygons_from_outlines: - void **make_polygons_from_outlines** **(** **)** - .. _class_NavigationPolygon_remove_outline: +.. _class_NavigationPolygon_remove_outline: - void **remove_outline** **(** :ref:`int` idx **)** - .. _class_NavigationPolygon_set_outline: +.. _class_NavigationPolygon_set_outline: - void **set_outline** **(** :ref:`int` idx, :ref:`PoolVector2Array` outline **)** - .. _class_NavigationPolygon_set_vertices: +.. _class_NavigationPolygon_set_vertices: - void **set_vertices** **(** :ref:`PoolVector2Array` vertices **)** diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index ed0b40852..85122bd61 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_NavigationPolygonInstance_enabled: +.. _class_NavigationPolygonInstance_enabled: - :ref:`bool` **enabled** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | is_enabled() | +----------+--------------------+ - .. _class_NavigationPolygonInstance_navpoly: +.. _class_NavigationPolygonInstance_navpoly: - :ref:`NavigationPolygon` **navpoly** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 929b4a82b..738dc21c3 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -55,7 +55,7 @@ Methods Enumerations ------------ - .. _enum_NetworkedMultiplayerENet_CompressionMode: +.. _enum_NetworkedMultiplayerENet_CompressionMode: enum **CompressionMode**: @@ -74,11 +74,13 @@ Tutorials --------- - :doc:`../tutorials/networking/high_level_multiplayer` + - `http://enet.bespin.org/usergroup0.html `_ + Property Descriptions --------------------- - .. _class_NetworkedMultiplayerENet_always_ordered: +.. _class_NetworkedMultiplayerENet_always_ordered: - :ref:`bool` **always_ordered** @@ -90,7 +92,7 @@ Property Descriptions 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: +.. _class_NetworkedMultiplayerENet_channel_count: - :ref:`int` **channel_count** @@ -102,7 +104,7 @@ Always use ``TRANSFER_MODE_ORDERED`` in place of ``TRANSFER_MODE_UNRELIABLE``. T 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: +.. _class_NetworkedMultiplayerENet_compression_mode: - :ref:`CompressionMode` **compression_mode** @@ -114,7 +116,7 @@ The number of channels to be used by ENet. Default: ``3``. Channels are used to 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: +.. _class_NetworkedMultiplayerENet_transfer_channel: - :ref:`int` **transfer_channel** @@ -129,55 +131,55 @@ Set the default channel to be used to transfer data. By default this value is `` Method Descriptions ------------------- - .. _class_NetworkedMultiplayerENet_close_connection: +.. _class_NetworkedMultiplayerENet_close_connection: - void **close_connection** **(** :ref:`int` wait_usec=100 **)** Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server. - .. _class_NetworkedMultiplayerENet_create_client: +.. _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 **)** 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 traversal technique. - .. _class_NetworkedMultiplayerENet_create_server: +.. _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 **)** 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. - .. _class_NetworkedMultiplayerENet_disconnect_peer: +.. _class_NetworkedMultiplayerENet_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id, :ref:`bool` now=false **)** Disconnect the given peer. If "now" is set to true, the connection will be closed immediately without flushing queued messages. - .. _class_NetworkedMultiplayerENet_get_last_packet_channel: +.. _class_NetworkedMultiplayerENet_get_last_packet_channel: - :ref:`int` **get_last_packet_channel** **(** **)** const Returns the channel of the last packet fetched via :ref:`PacketPeer.get_packet` - .. _class_NetworkedMultiplayerENet_get_packet_channel: +.. _class_NetworkedMultiplayerENet_get_packet_channel: - :ref:`int` **get_packet_channel** **(** **)** const Returns the channel of the next packet that will be retrieved via :ref:`PacketPeer.get_packet_peer` - .. _class_NetworkedMultiplayerENet_get_peer_address: +.. _class_NetworkedMultiplayerENet_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. - .. _class_NetworkedMultiplayerENet_get_peer_port: +.. _class_NetworkedMultiplayerENet_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. - .. _class_NetworkedMultiplayerENet_set_bind_ip: +.. _class_NetworkedMultiplayerENet_set_bind_ip: - void **set_bind_ip** **(** :ref:`String` ip **)** diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 4b8d997d8..299b6db64 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -45,31 +45,31 @@ Methods Signals ------- - .. _class_NetworkedMultiplayerPeer_connection_failed: +.. _class_NetworkedMultiplayerPeer_connection_failed: - **connection_failed** **(** **)** Emitted when a connection attempt fails. - .. _class_NetworkedMultiplayerPeer_connection_succeeded: +.. _class_NetworkedMultiplayerPeer_connection_succeeded: - **connection_succeeded** **(** **)** Emitted when a connection attempt succeeds. - .. _class_NetworkedMultiplayerPeer_peer_connected: +.. _class_NetworkedMultiplayerPeer_peer_connected: - **peer_connected** **(** :ref:`int` id **)** Emitted by the server when a client connects. - .. _class_NetworkedMultiplayerPeer_peer_disconnected: +.. _class_NetworkedMultiplayerPeer_peer_disconnected: - **peer_disconnected** **(** :ref:`int` id **)** Emitted by the server when a client disconnects. - .. _class_NetworkedMultiplayerPeer_server_disconnected: +.. _class_NetworkedMultiplayerPeer_server_disconnected: - **server_disconnected** **(** **)** @@ -78,7 +78,7 @@ Emitted by clients when the server disconnects. Enumerations ------------ - .. _enum_NetworkedMultiplayerPeer_TransferMode: +.. _enum_NetworkedMultiplayerPeer_TransferMode: enum **TransferMode**: @@ -86,7 +86,7 @@ enum **TransferMode**: - **TRANSFER_MODE_UNRELIABLE_ORDERED** = **1** --- Packets are sent via ordered UDP packets. - **TRANSFER_MODE_RELIABLE** = **2** --- Packets are sent via TCP packets. - .. _enum_NetworkedMultiplayerPeer_ConnectionStatus: +.. _enum_NetworkedMultiplayerPeer_ConnectionStatus: enum **ConnectionStatus**: @@ -99,6 +99,7 @@ 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 ----------- @@ -108,10 +109,11 @@ Tutorials --------- - :doc:`../tutorials/networking/high_level_multiplayer` + Property Descriptions --------------------- - .. _class_NetworkedMultiplayerPeer_refuse_new_connections: +.. _class_NetworkedMultiplayerPeer_refuse_new_connections: - :ref:`bool` **refuse_new_connections** @@ -123,7 +125,7 @@ Property Descriptions If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. - .. _class_NetworkedMultiplayerPeer_transfer_mode: +.. _class_NetworkedMultiplayerPeer_transfer_mode: - :ref:`TransferMode` **transfer_mode** @@ -138,31 +140,31 @@ The manner in which to send packets to the ``target_peer``. See :ref:`TransferMo Method Descriptions ------------------- - .. _class_NetworkedMultiplayerPeer_get_connection_status: +.. _class_NetworkedMultiplayerPeer_get_connection_status: - :ref:`ConnectionStatus` **get_connection_status** **(** **)** const Returns the current state of the connection. See :ref:`ConnectionStatus`. - .. _class_NetworkedMultiplayerPeer_get_packet_peer: +.. _class_NetworkedMultiplayerPeer_get_packet_peer: - :ref:`int` **get_packet_peer** **(** **)** const Returns the ID of the ``NetworkedMultiplayerPeer`` who sent the most recent packet. - .. _class_NetworkedMultiplayerPeer_get_unique_id: +.. _class_NetworkedMultiplayerPeer_get_unique_id: - :ref:`int` **get_unique_id** **(** **)** const Returns the ID of this ``NetworkedMultiplayerPeer``. - .. _class_NetworkedMultiplayerPeer_poll: +.. _class_NetworkedMultiplayerPeer_poll: - void **poll** **(** **)** Waits up to 1 second to receive a new network event. - .. _class_NetworkedMultiplayerPeer_set_target_peer: +.. _class_NetworkedMultiplayerPeer_set_target_peer: - void **set_target_peer** **(** :ref:`int` id **)** diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 869137838..9ee55d775 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -74,107 +74,107 @@ Methods Method Descriptions ------------------- - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolColorArray` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolVector3Array` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolVector2Array` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolStringArray` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolRealArray` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolIntArray` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`PoolByteArray` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Array` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Dictionary` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Object` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`RID` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`NodePath` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Color` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Transform` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Basis` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`AABB` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Quat` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Plane` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Transform2D` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Vector3` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Rect2` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`Vector2` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`String` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`float` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`int` from **)** - .. _class_Nil_Nil: +.. _class_Nil_Nil: - void **Nil** **(** :ref:`bool` from **)** diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 0c477e928..6183d2ad7 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -42,7 +42,7 @@ Properties Signals ------- - .. _class_NinePatchRect_texture_changed: +.. _class_NinePatchRect_texture_changed: - **texture_changed** **(** **)** @@ -51,7 +51,7 @@ Fired when the node's texture changes. Enumerations ------------ - .. _enum_NinePatchRect_AxisStretchMode: +.. _enum_NinePatchRect_AxisStretchMode: enum **AxisStretchMode**: @@ -67,7 +67,7 @@ Better known as 9-slice panels, NinePatchRect produces clean panels of any size, Property Descriptions --------------------- - .. _class_NinePatchRect_axis_stretch_horizontal: +.. _class_NinePatchRect_axis_stretch_horizontal: - :ref:`AxisStretchMode` **axis_stretch_horizontal** @@ -79,7 +79,7 @@ Property Descriptions Doesn't do anything at the time of writing. - .. _class_NinePatchRect_axis_stretch_vertical: +.. _class_NinePatchRect_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -91,7 +91,7 @@ Doesn't do anything at the time of writing. Doesn't do anything at the time of writing. - .. _class_NinePatchRect_draw_center: +.. _class_NinePatchRect_draw_center: - :ref:`bool` **draw_center** @@ -103,7 +103,7 @@ Doesn't do anything at the time of writing. If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Default value: ``true`` - .. _class_NinePatchRect_patch_margin_bottom: +.. _class_NinePatchRect_patch_margin_bottom: - :ref:`int` **patch_margin_bottom** @@ -115,7 +115,7 @@ If ``true``, draw the panel's center. Else, only draw the 9-slice's borders. Def The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. - .. _class_NinePatchRect_patch_margin_left: +.. _class_NinePatchRect_patch_margin_left: - :ref:`int` **patch_margin_left** @@ -127,7 +127,7 @@ The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's botto The height of the 9-slice's left column. - .. _class_NinePatchRect_patch_margin_right: +.. _class_NinePatchRect_patch_margin_right: - :ref:`int` **patch_margin_right** @@ -139,7 +139,7 @@ The height of the 9-slice's left column. The height of the 9-slice's right column. - .. _class_NinePatchRect_patch_margin_top: +.. _class_NinePatchRect_patch_margin_top: - :ref:`int` **patch_margin_top** @@ -151,7 +151,7 @@ The height of the 9-slice's right column. The height of the 9-slice's top row. - .. _class_NinePatchRect_region_rect: +.. _class_NinePatchRect_region_rect: - :ref:`Rect2` **region_rect** @@ -163,7 +163,7 @@ The height of the 9-slice's top row. 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: +.. _class_NinePatchRect_texture: - :ref:`Texture` **texture** diff --git a/classes/class_node.rst b/classes/class_node.rst index b2de66cf3..8ab7d269d 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -205,31 +205,31 @@ Methods Signals ------- - .. _class_Node_ready: +.. _class_Node_ready: - **ready** **(** **)** Emitted when the node is ready. - .. _class_Node_renamed: +.. _class_Node_renamed: - **renamed** **(** **)** Emitted when the node is renamed. - .. _class_Node_tree_entered: +.. _class_Node_tree_entered: - **tree_entered** **(** **)** Emitted when the node enters the tree. - .. _class_Node_tree_exited: +.. _class_Node_tree_exited: - **tree_exited** **(** **)** Emitted after the node exits the tree and is no longer active. - .. _class_Node_tree_exiting: +.. _class_Node_tree_exiting: - **tree_exiting** **(** **)** @@ -238,7 +238,7 @@ Emitted when the node is still active but about to exit the tree. This is the ri Enumerations ------------ - .. _enum_Node_PauseMode: +.. _enum_Node_PauseMode: enum **PauseMode**: @@ -246,7 +246,7 @@ enum **PauseMode**: - **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: +.. _enum_Node_DuplicateFlags: enum **DuplicateFlags**: @@ -275,6 +275,7 @@ Constants - **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 ----------- @@ -304,10 +305,11 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/scenes_and_nodes` + Property Descriptions --------------------- - .. _class_Node_custom_multiplayer: +.. _class_Node_custom_multiplayer: - :ref:`MultiplayerAPI` **custom_multiplayer** @@ -319,7 +321,7 @@ Property Descriptions The override to the default :ref:`MultiplayerAPI`. Set to null to use the default SceneTree one. - .. _class_Node_filename: +.. _class_Node_filename: - :ref:`String` **filename** @@ -331,7 +333,7 @@ The override to the default :ref:`MultiplayerAPI`. Set to When a scene is instanced from a file, its topmost node contains the filename from which it was loaded. - .. _class_Node_multiplayer: +.. _class_Node_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -341,7 +343,7 @@ When a scene is instanced from a file, its topmost node contains the filename fr The :ref:`MultiplayerAPI` instance associated with this node. Either the :ref:`custom_multiplayer`, or the default SceneTree one (if inside tree). - .. _class_Node_name: +.. _class_Node_name: - :ref:`String` **name** @@ -353,7 +355,7 @@ The :ref:`MultiplayerAPI` instance associated with this no 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: +.. _class_Node_owner: - :ref:`Node` **owner** @@ -365,7 +367,7 @@ The name of the node. This name is unique among the siblings (other child nodes 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: +.. _class_Node_pause_mode: - :ref:`PauseMode` **pause_mode** @@ -380,7 +382,7 @@ Pause mode. How the node will behave if the :ref:`SceneTree` is Method Descriptions ------------------- - .. _class_Node__enter_tree: +.. _class_Node__enter_tree: - void **_enter_tree** **(** **)** virtual @@ -388,7 +390,7 @@ Called when the node enters the :ref:`SceneTree` (e.g. upon ins Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notification`. - .. _class_Node__exit_tree: +.. _class_Node__exit_tree: - void **_exit_tree** **(** **)** virtual @@ -396,11 +398,11 @@ Called when the node is about to leave the :ref:`SceneTree` (e. 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: +.. _class_Node__get_configuration_warning: - :ref:`String` **_get_configuration_warning** **(** **)** virtual - .. _class_Node__input: +.. _class_Node__input: - void **_input** **(** :ref:`InputEvent` event **)** virtual @@ -412,7 +414,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, :ref:`_unhandled_input` and :ref:`_unhandled_key_input` are usually a better fit as they allow the GUI to intercept the events first. - .. _class_Node__physics_process: +.. _class_Node__physics_process: - void **_physics_process** **(** :ref:`float` delta **)** virtual @@ -422,7 +424,7 @@ It is only called if physics processing is enabled, which is done automatically Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in :ref:`Object._notification`. - .. _class_Node__process: +.. _class_Node__process: - void **_process** **(** :ref:`float` delta **)** virtual @@ -432,7 +434,7 @@ It is only called if processing is enabled, which is done automatically if this Corresponds to the NOTIFICATION_PROCESS notification in :ref:`Object._notification`. - .. _class_Node__ready: +.. _class_Node__ready: - void **_ready** **(** **)** virtual @@ -442,7 +444,7 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification Usually used for initialization. For even earlier initialization, :ref:`Object._init` may be used. Also see :ref:`_enter_tree`. - .. _class_Node__unhandled_input: +.. _class_Node__unhandled_input: - void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual @@ -454,7 +456,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, this and :ref:`_unhandled_key_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. - .. _class_Node__unhandled_key_input: +.. _class_Node__unhandled_key_input: - void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual @@ -466,7 +468,7 @@ To consume the input event and stop it propagating further to other nodes, :ref: For gameplay input, this and :ref:`_unhandled_input` are usually a better fit than :ref:`_input` as they allow the GUI to intercept the events first. - .. _class_Node_add_child: +.. _class_Node_add_child: - void **add_child** **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** @@ -474,7 +476,7 @@ Adds a child node. Nodes can have any number of children, but every child must h Setting "legible_unique_name" ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. - .. _class_Node_add_child_below_node: +.. _class_Node_add_child_below_node: - void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** @@ -482,19 +484,19 @@ Adds a child node. The child is placed below the given node in the list of child Setting "legible_unique_name" ``true`` creates child nodes with human-readable names, based on the name of the node being instanced instead of its type. - .. _class_Node_add_to_group: +.. _class_Node_add_to_group: - 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`. - .. _class_Node_can_process: +.. _class_Node_can_process: - :ref:`bool` **can_process** **(** **)** const Returns ``true`` if the node can process while the scene tree is paused (see :ref:`set_pause_mode`). Always returns ``true`` if the scene tree is not paused, and ``false`` if the node is not in the tree. FIXME: Why FAIL_COND? - .. _class_Node_duplicate: +.. _class_Node_duplicate: - :ref:`Node` **duplicate** **(** :ref:`int` flags=15 **)** const @@ -502,13 +504,13 @@ Duplicates the node, returning a new node. You can fine-tune the behavior using the ``flags``. See DUPLICATE\_\* constants. - .. _class_Node_find_node: +.. _class_Node_find_node: - :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: +.. _class_Node_get_child: - :ref:`Node` **get_child** **(** :ref:`int` idx **)** const @@ -516,37 +518,37 @@ Returns a child node by its index (see :ref:`get_child_count`. - .. _class_Node_get_child_count: +.. _class_Node_get_child_count: - :ref:`int` **get_child_count** **(** **)** const Returns the number of child nodes. - .. _class_Node_get_children: +.. _class_Node_get_children: - :ref:`Array` **get_children** **(** **)** const Returns an array of references to node's children. - .. _class_Node_get_groups: +.. _class_Node_get_groups: - :ref:`Array` **get_groups** **(** **)** const Returns an array listing the groups that the node is a member of. - .. _class_Node_get_index: +.. _class_Node_get_index: - :ref:`int` **get_index** **(** **)** const Returns the node's index, i.e. its position among the siblings of its parent. - .. _class_Node_get_network_master: +.. _class_Node_get_network_master: - :ref:`int` **get_network_master** **(** **)** const Returns the peer ID of the network master for this node. See :ref:`set_network_master`. - .. _class_Node_get_node: +.. _class_Node_get_node: - :ref:`Node` **get_node** **(** :ref:`NodePath` path **)** const @@ -576,165 +578,165 @@ Possible paths are: get_node("../Swamp/Alligator") get_node("/root/MyGame") - .. _class_Node_get_node_and_resource: +.. _class_Node_get_node_and_resource: - :ref:`Array` **get_node_and_resource** **(** :ref:`NodePath` path **)** - .. _class_Node_get_parent: +.. _class_Node_get_parent: - :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: +.. _class_Node_get_path: - :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: +.. _class_Node_get_path_to: - :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. - .. _class_Node_get_physics_process_delta_time: +.. _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`. - .. _class_Node_get_position_in_parent: +.. _class_Node_get_position_in_parent: - :ref:`int` **get_position_in_parent** **(** **)** const Returns the node's order in the scene tree branch. For example, if called on the first child node the position is ``0``. - .. _class_Node_get_process_delta_time: +.. _class_Node_get_process_delta_time: - :ref:`float` **get_process_delta_time** **(** **)** const Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. - .. _class_Node_get_scene_instance_load_placeholder: +.. _class_Node_get_scene_instance_load_placeholder: - :ref:`bool` **get_scene_instance_load_placeholder** **(** **)** const Returns ``true`` if this is an instance load placeholder. See :ref:`InstancePlaceholder`. - .. _class_Node_get_tree: +.. _class_Node_get_tree: - :ref:`SceneTree` **get_tree** **(** **)** const Returns the :ref:`SceneTree` that contains this node. - .. _class_Node_get_viewport: +.. _class_Node_get_viewport: - :ref:`Viewport` **get_viewport** **(** **)** const Returns the node's :ref:`Viewport`. - .. _class_Node_has_node: +.. _class_Node_has_node: - :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const Returns ``true`` if the node that the :ref:`NodePath` points to exists. - .. _class_Node_has_node_and_resource: +.. _class_Node_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const - .. _class_Node_is_a_parent_of: +.. _class_Node_is_a_parent_of: - :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. - .. _class_Node_is_displayed_folded: +.. _class_Node_is_displayed_folded: - :ref:`bool` **is_displayed_folded** **(** **)** const Returns ``true`` if the node is folded (collapsed) in the Scene dock. - .. _class_Node_is_greater_than: +.. _class_Node_is_greater_than: - :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: +.. _class_Node_is_in_group: - :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`. - .. _class_Node_is_inside_tree: +.. _class_Node_is_inside_tree: - :ref:`bool` **is_inside_tree** **(** **)** const Returns ``true`` if this node is currently inside a :ref:`SceneTree`. - .. _class_Node_is_network_master: +.. _class_Node_is_network_master: - :ref:`bool` **is_network_master** **(** **)** const Returns ``true`` if the local system is the master of this node. - .. _class_Node_is_physics_processing: +.. _class_Node_is_physics_processing: - :ref:`bool` **is_physics_processing** **(** **)** const Returns ``true`` if physics processing is enabled (see :ref:`set_physics_process`). - .. _class_Node_is_physics_processing_internal: +.. _class_Node_is_physics_processing_internal: - :ref:`bool` **is_physics_processing_internal** **(** **)** const Returns ``true`` if internal physics processing is enabled (see :ref:`set_physics_process_internal`). - .. _class_Node_is_processing: +.. _class_Node_is_processing: - :ref:`bool` **is_processing** **(** **)** const Returns ``true`` if processing is enabled (see :ref:`set_process`). - .. _class_Node_is_processing_input: +.. _class_Node_is_processing_input: - :ref:`bool` **is_processing_input** **(** **)** const Returns ``true`` if the node is processing input (see :ref:`set_process_input`). - .. _class_Node_is_processing_internal: +.. _class_Node_is_processing_internal: - :ref:`bool` **is_processing_internal** **(** **)** const Returns ``true`` if internal processing is enabled (see :ref:`set_process_internal`). - .. _class_Node_is_processing_unhandled_input: +.. _class_Node_is_processing_unhandled_input: - :ref:`bool` **is_processing_unhandled_input** **(** **)** const Returns ``true`` if the node is processing unhandled input (see :ref:`set_process_unhandled_input`). - .. _class_Node_is_processing_unhandled_key_input: +.. _class_Node_is_processing_unhandled_key_input: - :ref:`bool` **is_processing_unhandled_key_input** **(** **)** const Returns ``true`` if the node is processing unhandled key input (see :ref:`set_process_unhandled_key_input`). - .. _class_Node_move_child: +.. _class_Node_move_child: - 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. - .. _class_Node_print_stray_nodes: +.. _class_Node_print_stray_nodes: - void **print_stray_nodes** **(** **)** Prints all stray nodes (nodes outside the :ref:`SceneTree`). Used for debugging. Works only in debug builds. - .. _class_Node_print_tree: +.. _class_Node_print_tree: - void **print_tree** **(** **)** @@ -749,7 +751,7 @@ Prints the tree to stdout. Used mainly for debugging purposes. This version disp TheGame/SplashScreen TheGame/SplashScreen/Camera2D - .. _class_Node_print_tree_pretty: +.. _class_Node_print_tree_pretty: - void **print_tree_pretty** **(** **)** @@ -764,179 +766,179 @@ Similar to :ref:`print_tree`, this prints the tree to std ┖-SplashScreen ┖╴Camera2D - .. _class_Node_propagate_call: +.. _class_Node_propagate_call: - 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. - .. _class_Node_propagate_notification: +.. _class_Node_propagate_notification: - void **propagate_notification** **(** :ref:`int` what **)** Notifies the current node and all its children recursively by calling notification() on all of them. - .. _class_Node_queue_free: +.. _class_Node_queue_free: - void **queue_free** **(** **)** Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to :ref:`Object.free`. Use :ref:`Object.is_queued_for_deletion` to check whether a node will be deleted at the end of the frame. - .. _class_Node_raise: +.. _class_Node_raise: - 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. - .. _class_Node_remove_and_skip: +.. _class_Node_remove_and_skip: - void **remove_and_skip** **(** **)** Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed. - .. _class_Node_remove_child: +.. _class_Node_remove_child: - 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: +.. _class_Node_remove_from_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`. - .. _class_Node_replace_by: +.. _class_Node_replace_by: - 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. - .. _class_Node_request_ready: +.. _class_Node_request_ready: - void **request_ready** **(** **)** Requests that ``_ready`` be called again. - .. _class_Node_rpc: +.. _class_Node_rpc: - :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``. - .. _class_Node_rpc_config: +.. _class_Node_rpc_config: - 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``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, methods are not exposed to networking (and RPCs). Also see :ref:`rset` and :ref:`rset_config` for properties. - .. _class_Node_rpc_id: +.. _class_Node_rpc_id: - :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`. - .. _class_Node_rpc_unreliable: +.. _class_Node_rpc_unreliable: - :ref:`Variant` **rpc_unreliable** **(** :ref:`String` method **)** vararg Sends a :ref:`rpc` using an unreliable protocol. Returns an empty :ref:`Variant`. - .. _class_Node_rpc_unreliable_id: +.. _class_Node_rpc_unreliable_id: - :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`. - .. _class_Node_rset: +.. _class_Node_rset: - 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: +.. _class_Node_rset_config: - 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``, ``master``, ``puppet``, ``remotesync``, ``mastersync``, ``puppetsync``). By default, properties are not exposed to networking (and RPCs). Also see :ref:`rpc` and :ref:`rpc_config` for methods. - .. _class_Node_rset_id: +.. _class_Node_rset_id: - 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: +.. _class_Node_rset_unreliable: - 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: +.. _class_Node_rset_unreliable_id: - 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`). - .. _class_Node_set_display_folded: +.. _class_Node_set_display_folded: - void **set_display_folded** **(** :ref:`bool` fold **)** Sets the folded state of the node in the Scene dock. - .. _class_Node_set_network_master: +.. _class_Node_set_network_master: - void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the ``master`` and ``puppet`` keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If ``recursive``, the given peer is recursively set as the master for all children of this node. - .. _class_Node_set_physics_process: +.. _class_Node_set_physics_process: - 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. - .. _class_Node_set_physics_process_internal: +.. _class_Node_set_physics_process_internal: - void **set_physics_process_internal** **(** :ref:`bool` enable **)** Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal :ref:`_physics_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting (:ref:`set_physics_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. - .. _class_Node_set_process: +.. _class_Node_set_process: - void **set_process** **(** :ref:`bool` enable **)** Enables or disables processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the :ref:`_process` callback will be called if exists). Enabled automatically if :ref:`_process` is overridden. Any calls to this before :ref:`_ready` will be ignored. - .. _class_Node_set_process_input: +.. _class_Node_set_process_input: - void **set_process_input** **(** :ref:`bool` enable **)** Enables or disables input processing. This is not required for GUI controls! Enabled automatically if :ref:`_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. - .. _class_Node_set_process_internal: +.. _class_Node_set_process_internal: - void **set_process_internal** **(** :ref:`bool` enable **)** Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal :ref:`_process` calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting (:ref:`set_process`). Only useful for advanced uses to manipulate built-in nodes behaviour. - .. _class_Node_set_process_priority: +.. _class_Node_set_process_priority: - void **set_process_priority** **(** :ref:`int` priority **)** - .. _class_Node_set_process_unhandled_input: +.. _class_Node_set_process_unhandled_input: - 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. - .. _class_Node_set_process_unhandled_key_input: +.. _class_Node_set_process_unhandled_key_input: - void **set_process_unhandled_key_input** **(** :ref:`bool` enable **)** Enables unhandled key input processing. Enabled automatically if :ref:`_unhandled_key_input` is overridden. Any calls to this before :ref:`_ready` will be ignored. - .. _class_Node_set_scene_instance_load_placeholder: +.. _class_Node_set_scene_instance_load_placeholder: - void **set_scene_instance_load_placeholder** **(** :ref:`bool` load_placeholder **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 3b5cc8295..0a557d789 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -83,10 +83,11 @@ Tutorials --------- - :doc:`../tutorials/2d/custom_drawing_in_2d` + Property Descriptions --------------------- - .. _class_Node2D_global_position: +.. _class_Node2D_global_position: - :ref:`Vector2` **global_position** @@ -98,7 +99,7 @@ Property Descriptions Global position. - .. _class_Node2D_global_rotation: +.. _class_Node2D_global_rotation: - :ref:`float` **global_rotation** @@ -110,7 +111,7 @@ Global position. Global rotation in radians. - .. _class_Node2D_global_rotation_degrees: +.. _class_Node2D_global_rotation_degrees: - :ref:`float` **global_rotation_degrees** @@ -122,7 +123,7 @@ Global rotation in radians. Global rotation in degrees. - .. _class_Node2D_global_scale: +.. _class_Node2D_global_scale: - :ref:`Vector2` **global_scale** @@ -134,7 +135,7 @@ Global rotation in degrees. Global scale. - .. _class_Node2D_global_transform: +.. _class_Node2D_global_transform: - :ref:`Transform2D` **global_transform** @@ -146,7 +147,7 @@ Global scale. Global :ref:`Transform2D`. - .. _class_Node2D_position: +.. _class_Node2D_position: - :ref:`Vector2` **position** @@ -158,7 +159,7 @@ Global :ref:`Transform2D`. Position, relative to the node's parent. - .. _class_Node2D_rotation: +.. _class_Node2D_rotation: - :ref:`float` **rotation** @@ -170,7 +171,7 @@ Position, relative to the node's parent. Rotation in radians, relative to the node's parent. - .. _class_Node2D_rotation_degrees: +.. _class_Node2D_rotation_degrees: - :ref:`float` **rotation_degrees** @@ -182,7 +183,7 @@ Rotation in radians, relative to the node's parent. Rotation in degrees, relative to the node's parent. - .. _class_Node2D_scale: +.. _class_Node2D_scale: - :ref:`Vector2` **scale** @@ -194,7 +195,7 @@ Rotation in degrees, relative to the node's parent. The node's scale. Unscaled value: ``(1, 1)`` - .. _class_Node2D_transform: +.. _class_Node2D_transform: - :ref:`Transform2D` **transform** @@ -206,7 +207,7 @@ The node's scale. Unscaled value: ``(1, 1)`` Local :ref:`Transform2D`. - .. _class_Node2D_z_as_relative: +.. _class_Node2D_z_as_relative: - :ref:`bool` **z_as_relative** @@ -218,7 +219,7 @@ Local :ref:`Transform2D`. 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: +.. _class_Node2D_z_index: - :ref:`int` **z_index** @@ -233,67 +234,67 @@ Z-index. Controls the order in which the nodes render. A node with a higher Z-in Method Descriptions ------------------- - .. _class_Node2D_apply_scale: +.. _class_Node2D_apply_scale: - void **apply_scale** **(** :ref:`Vector2` ratio **)** Multiplies the current scale by the 'ratio' vector. - .. _class_Node2D_get_angle_to: +.. _class_Node2D_get_angle_to: - :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: +.. _class_Node2D_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const Returns the :ref:`Transform2D` relative to this node's parent. - .. _class_Node2D_global_translate: +.. _class_Node2D_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** Adds the 'offset' vector to the node's global position. - .. _class_Node2D_look_at: +.. _class_Node2D_look_at: - void **look_at** **(** :ref:`Vector2` point **)** Rotates the node so it points towards the 'point'. - .. _class_Node2D_move_local_x: +.. _class_Node2D_move_local_x: - void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. - .. _class_Node2D_move_local_y: +.. _class_Node2D_move_local_y: - void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. - .. _class_Node2D_rotate: +.. _class_Node2D_rotate: - void **rotate** **(** :ref:`float` radians **)** Applies a rotation to the node, in radians, starting from its current rotation. - .. _class_Node2D_to_global: +.. _class_Node2D_to_global: - :ref:`Vector2` **to_global** **(** :ref:`Vector2` local_point **)** const Converts a local point's coordinates to global coordinates. - .. _class_Node2D_to_local: +.. _class_Node2D_to_local: - :ref:`Vector2` **to_local** **(** :ref:`Vector2` global_point **)** const Converts a global point's coordinates to local coordinates. - .. _class_Node2D_translate: +.. _class_Node2D_translate: - void **translate** **(** :ref:`Vector2` offset **)** diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 9c410b6f4..c98408e73 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -49,51 +49,51 @@ A ``NodePath`` is made up of a list of node names, a list of "subnode" (resource Method Descriptions ------------------- - .. _class_NodePath_NodePath: +.. _class_NodePath_NodePath: - :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: +.. _class_NodePath_get_as_property_path: - :ref:`NodePath` **get_as_property_path** **(** **)** - .. _class_NodePath_get_concatenated_subnames: +.. _class_NodePath_get_concatenated_subnames: - :ref:`String` **get_concatenated_subnames** **(** **)** - .. _class_NodePath_get_name: +.. _class_NodePath_get_name: - :ref:`String` **get_name** **(** :ref:`int` idx **)** Get the node name indicated by ``idx`` (0 to :ref:`get_name_count`) - .. _class_NodePath_get_name_count: +.. _class_NodePath_get_name_count: - :ref:`int` **get_name_count** **(** **)** Get the number of node names which make up the path. - .. _class_NodePath_get_subname: +.. _class_NodePath_get_subname: - :ref:`String` **get_subname** **(** :ref:`int` idx **)** Get the resource name indicated by ``idx`` (0 to :ref:`get_subname_count`) - .. _class_NodePath_get_subname_count: +.. _class_NodePath_get_subname_count: - :ref:`int` **get_subname_count** **(** **)** Get the number of resource names in the path. - .. _class_NodePath_is_absolute: +.. _class_NodePath_is_absolute: - :ref:`bool` **is_absolute** **(** **)** Return true if the node path is absolute (not relative). - .. _class_NodePath_is_empty: +.. _class_NodePath_is_empty: - :ref:`bool` **is_empty** **(** **)** diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index bd49a50f0..da373fc70 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -48,7 +48,7 @@ NoiseTexture can also generate normalmap textures. Property Descriptions --------------------- - .. _class_NoiseTexture_as_normalmap: +.. _class_NoiseTexture_as_normalmap: - :ref:`bool` **as_normalmap** @@ -60,7 +60,7 @@ Property Descriptions If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map. - .. _class_NoiseTexture_noise: +.. _class_NoiseTexture_noise: - :ref:`SimplexNoise` **noise** @@ -72,7 +72,7 @@ If true, the resulting texture contains a normal map created from the original n The :ref:`SimplexNoise` instance used to generate the noise. - .. _class_NoiseTexture_seamless: +.. _class_NoiseTexture_seamless: - :ref:`bool` **seamless** @@ -84,7 +84,7 @@ The :ref:`SimplexNoise` instance used to generate the noise. Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. - .. _class_NoiseTexture_size: +.. _class_NoiseTexture_size: - :ref:`Vector2` **size** @@ -99,13 +99,13 @@ Size of the generated texture. Method Descriptions ------------------- - .. _class_NoiseTexture_set_height: +.. _class_NoiseTexture_set_height: - void **set_height** **(** :ref:`int` height **)** Set texture height. - .. _class_NoiseTexture_set_width: +.. _class_NoiseTexture_set_width: - void **set_width** **(** :ref:`int` width **)** diff --git a/classes/class_object.rst b/classes/class_object.rst index b0e3bae7a..513e3e5a5 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -108,7 +108,7 @@ Methods Signals ------- - .. _class_Object_script_changed: +.. _class_Object_script_changed: - **script_changed** **(** **)** @@ -117,7 +117,7 @@ Emitted whenever the script of the Object is changed. Enumerations ------------ - .. _enum_Object_ConnectFlags: +.. _enum_Object_ConnectFlags: enum **ConnectFlags**: @@ -131,6 +131,7 @@ 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 ----------- @@ -147,103 +148,103 @@ Objects also receive notifications (:ref:`_notification` **_get** **(** :ref:`String` property **)** virtual Returns the given property. Returns ``null`` if the ``property`` does not exist. - .. _class_Object__get_property_list: +.. _class_Object__get_property_list: - :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`). - .. _class_Object__init: +.. _class_Object__init: - void **_init** **(** **)** virtual The virtual method called upon initialization. - .. _class_Object__notification: +.. _class_Object__notification: - void **_notification** **(** :ref:`int` what **)** virtual Notify the object internally using an ID. - .. _class_Object__set: +.. _class_Object__set: - :ref:`bool` **_set** **(** :ref:`String` property, :ref:`Variant` value **)** virtual Sets a property. Returns ``true`` if the ``property`` exists. - .. _class_Object_add_user_signal: +.. _class_Object_add_user_signal: - 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\_\*). - .. _class_Object_call: +.. _class_Object_call: - :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: +.. _class_Object_call_deferred: - :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: +.. _class_Object_callv: - :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`. - .. _class_Object_can_translate_messages: +.. _class_Object_can_translate_messages: - :ref:`bool` **can_translate_messages** **(** **)** const Returns ``true`` if the object can translate strings. - .. _class_Object_connect: +.. _class_Object_connect: - :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: +.. _class_Object_disconnect: - 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: +.. _class_Object_emit_signal: - :ref:`Variant` **emit_signal** **(** :ref:`String` signal **)** vararg Emits the given ``signal``. - .. _class_Object_free: +.. _class_Object_free: - void **free** **(** **)** Deletes the object from memory. - .. _class_Object_get: +.. _class_Object_get: - :ref:`Variant` **get** **(** :ref:`String` property **)** const Returns a :ref:`Variant` for a ``property``. - .. _class_Object_get_class: +.. _class_Object_get_class: - :ref:`String` **get_class** **(** **)** const Returns the object's class as a :ref:`String`. - .. _class_Object_get_incoming_connections: +.. _class_Object_get_incoming_connections: - :ref:`Array` **get_incoming_connections** **(** **)** const @@ -257,7 +258,7 @@ Inside each :ref:`Dictionary` there are 3 fields: - "method_name" is a name of method to which signal is connected. - .. _class_Object_get_indexed: +.. _class_Object_get_indexed: - :ref:`Variant` **get_indexed** **(** :ref:`NodePath` property **)** const @@ -265,141 +266,141 @@ Get indexed object property by String. Property indices get accessed with colon separation, for example: ``position:x`` - .. _class_Object_get_instance_id: +.. _class_Object_get_instance_id: - :ref:`int` **get_instance_id** **(** **)** const Returns the object's unique instance ID. - .. _class_Object_get_meta: +.. _class_Object_get_meta: - :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Returns the object's metadata for the given ``name``. - .. _class_Object_get_meta_list: +.. _class_Object_get_meta_list: - :ref:`PoolStringArray` **get_meta_list** **(** **)** const Returns the object's metadata as a :ref:`PoolStringArray`. - .. _class_Object_get_method_list: +.. _class_Object_get_method_list: - :ref:`Array` **get_method_list** **(** **)** const Returns the object's methods and their signatures as an :ref:`Array`. - .. _class_Object_get_property_list: +.. _class_Object_get_property_list: - :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`). - .. _class_Object_get_script: +.. _class_Object_get_script: - :ref:`Reference` **get_script** **(** **)** const Returns the object's :ref:`Script` or ``null`` if one doesn't exist. - .. _class_Object_get_signal_connection_list: +.. _class_Object_get_signal_connection_list: - :ref:`Array` **get_signal_connection_list** **(** :ref:`String` signal **)** const Returns an :ref:`Array` of connections for the given ``signal``. - .. _class_Object_get_signal_list: +.. _class_Object_get_signal_list: - :ref:`Array` **get_signal_list** **(** **)** const Returns the list of signals as an :ref:`Array` of dictionaries. - .. _class_Object_has_meta: +.. _class_Object_has_meta: - :ref:`bool` **has_meta** **(** :ref:`String` name **)** const Returns ``true`` if a metadata is found with the given ``name``. - .. _class_Object_has_method: +.. _class_Object_has_method: - :ref:`bool` **has_method** **(** :ref:`String` method **)** const Returns ``true`` if the object contains the given ``method``. - .. _class_Object_has_user_signal: +.. _class_Object_has_user_signal: - :ref:`bool` **has_user_signal** **(** :ref:`String` signal **)** const Returns ``true`` if the given user-defined ``signal`` exists. - .. _class_Object_is_blocking_signals: +.. _class_Object_is_blocking_signals: - :ref:`bool` **is_blocking_signals** **(** **)** const Returns ``true`` if signal emission blocking is enabled. - .. _class_Object_is_class: +.. _class_Object_is_class: - :ref:`bool` **is_class** **(** :ref:`String` type **)** const Returns ``true`` if the object inherits from the given ``type``. - .. _class_Object_is_connected: +.. _class_Object_is_connected: - :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``. - .. _class_Object_is_queued_for_deletion: +.. _class_Object_is_queued_for_deletion: - :ref:`bool` **is_queued_for_deletion** **(** **)** const Returns ``true`` if the ``queue_free`` method was called for the object. - .. _class_Object_notification: +.. _class_Object_notification: - void **notification** **(** :ref:`int` what, :ref:`bool` reversed=false **)** Notify the object of something. - .. _class_Object_property_list_changed_notify: +.. _class_Object_property_list_changed_notify: - void **property_list_changed_notify** **(** **)** - .. _class_Object_set: +.. _class_Object_set: - void **set** **(** :ref:`String` property, :ref:`Variant` value **)** Set property into the object. - .. _class_Object_set_block_signals: +.. _class_Object_set_block_signals: - void **set_block_signals** **(** :ref:`bool` enable **)** If set to true, signal emission is blocked. - .. _class_Object_set_indexed: +.. _class_Object_set_indexed: - void **set_indexed** **(** :ref:`NodePath` property, :ref:`Variant` value **)** - .. _class_Object_set_message_translation: +.. _class_Object_set_message_translation: - void **set_message_translation** **(** :ref:`bool` enable **)** Define whether the object can translate strings (with calls to :ref:`tr`). Default is true. - .. _class_Object_set_meta: +.. _class_Object_set_meta: - 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: +.. _class_Object_set_script: - void **set_script** **(** :ref:`Reference` script **)** Set a script into the object, scripts extend the object functionality. - .. _class_Object_tr: +.. _class_Object_tr: - :ref:`String` **tr** **(** :ref:`String` message **)** const diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 55e9fb64d..7d43d55d2 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -30,7 +30,7 @@ Properties Enumerations ------------ - .. _enum_OccluderPolygon2D_CullMode: +.. _enum_OccluderPolygon2D_CullMode: enum **CullMode**: @@ -46,7 +46,7 @@ Editor facility that helps you draw a 2D polygon used as resource for :ref:`Ligh Property Descriptions --------------------- - .. _class_OccluderPolygon2D_closed: +.. _class_OccluderPolygon2D_closed: - :ref:`bool` **closed** @@ -58,7 +58,7 @@ Property Descriptions 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: +.. _class_OccluderPolygon2D_cull_mode: - :ref:`CullMode` **cull_mode** @@ -70,7 +70,7 @@ If ``true`` closes the polygon. A closed OccluderPolygon2D occludes the light co Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``. - .. _class_OccluderPolygon2D_polygon: +.. _class_OccluderPolygon2D_polygon: - :ref:`PoolVector2Array` **polygon** diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 151bb4af6..27762571e 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -32,14 +32,14 @@ Properties Enumerations ------------ - .. _enum_OmniLight_ShadowDetail: +.. _enum_OmniLight_ShadowDetail: enum **ShadowDetail**: - **SHADOW_DETAIL_VERTICAL** = **0** - **SHADOW_DETAIL_HORIZONTAL** = **1** - .. _enum_OmniLight_ShadowMode: +.. _enum_OmniLight_ShadowMode: enum **ShadowMode**: @@ -55,10 +55,11 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` + Property Descriptions --------------------- - .. _class_OmniLight_omni_attenuation: +.. _class_OmniLight_omni_attenuation: - :ref:`float` **omni_attenuation** @@ -70,7 +71,7 @@ Property Descriptions The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. - .. _class_OmniLight_omni_range: +.. _class_OmniLight_omni_range: - :ref:`float` **omni_range** @@ -82,7 +83,7 @@ The light's attenuation (drop-off) curve. A number of presets are available in t Maximum distance the light affects. - .. _class_OmniLight_omni_shadow_detail: +.. _class_OmniLight_omni_shadow_detail: - :ref:`ShadowDetail` **omni_shadow_detail** @@ -94,7 +95,7 @@ Maximum distance the light affects. See :ref:`ShadowDetail`. - .. _class_OmniLight_omni_shadow_mode: +.. _class_OmniLight_omni_shadow_mode: - :ref:`ShadowMode` **omni_shadow_mode** diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index c15a6d863..3e1b7ebb3 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -102,13 +102,13 @@ Theme Properties Signals ------- - .. _class_OptionButton_item_focused: +.. _class_OptionButton_item_focused: - **item_focused** **(** :ref:`int` ID **)** This signal is emitted when user navigated to an item using ``ui_up`` or ``ui_down`` action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). - .. _class_OptionButton_item_selected: +.. _class_OptionButton_item_selected: - **item_selected** **(** :ref:`int` ID **)** @@ -122,7 +122,7 @@ OptionButton is a type button that provides a selectable list of items when pres Property Descriptions --------------------- - .. _class_OptionButton_selected: +.. _class_OptionButton_selected: - :ref:`int` **selected** @@ -133,107 +133,107 @@ Property Descriptions Method Descriptions ------------------- - .. _class_OptionButton_add_icon_item: +.. _class_OptionButton_add_icon_item: - 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: +.. _class_OptionButton_add_item: - 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. - .. _class_OptionButton_add_separator: +.. _class_OptionButton_add_separator: - void **add_separator** **(** **)** Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. - .. _class_OptionButton_clear: +.. _class_OptionButton_clear: - void **clear** **(** **)** Clear all the items in the ``OptionButton``. - .. _class_OptionButton_get_item_count: +.. _class_OptionButton_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items in the OptionButton. - .. _class_OptionButton_get_item_icon: +.. _class_OptionButton_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". - .. _class_OptionButton_get_item_id: +.. _class_OptionButton_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the ID of the item at index "idx". - .. _class_OptionButton_get_item_metadata: +.. _class_OptionButton_get_item_metadata: - :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const - .. _class_OptionButton_get_item_text: +.. _class_OptionButton_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". - .. _class_OptionButton_get_popup: +.. _class_OptionButton_get_popup: - :ref:`PopupMenu` **get_popup** **(** **)** const Return the :ref:`PopupMenu` contained in this button. - .. _class_OptionButton_get_selected_id: +.. _class_OptionButton_get_selected_id: - :ref:`int` **get_selected_id** **(** **)** const - .. _class_OptionButton_get_selected_metadata: +.. _class_OptionButton_get_selected_metadata: - :ref:`Variant` **get_selected_metadata** **(** **)** const - .. _class_OptionButton_is_item_disabled: +.. _class_OptionButton_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const - .. _class_OptionButton_remove_item: +.. _class_OptionButton_remove_item: - void **remove_item** **(** :ref:`int` idx **)** - .. _class_OptionButton_select: +.. _class_OptionButton_select: - void **select** **(** :ref:`int` idx **)** Select an item by index and make it the current item. - .. _class_OptionButton_set_item_disabled: +.. _class_OptionButton_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** - .. _class_OptionButton_set_item_icon: +.. _class_OptionButton_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` texture **)** Set the icon of an item at index "idx". - .. _class_OptionButton_set_item_id: +.. _class_OptionButton_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the ID of an item at index "idx". - .. _class_OptionButton_set_item_metadata: +.. _class_OptionButton_set_item_metadata: - void **set_item_metadata** **(** :ref:`int` idx, :ref:`Variant` metadata **)** - .. _class_OptionButton_set_item_text: +.. _class_OptionButton_set_item_text: - void **set_item_text** **(** :ref:`int` idx, :ref:`String` text **)** diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index 39c2d5d18..12713eb2b 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -43,7 +43,7 @@ Make sure to check if the curve of this node's parent :ref:`Path` ha Property Descriptions --------------------- - .. _class_OrientedPathFollow_cubic_interp: +.. _class_OrientedPathFollow_cubic_interp: - :ref:`bool` **cubic_interp** @@ -59,7 +59,7 @@ The points along the :ref:`Curve3D` of the :ref:`Path 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. - .. _class_OrientedPathFollow_h_offset: +.. _class_OrientedPathFollow_h_offset: - :ref:`float` **h_offset** @@ -71,7 +71,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. - .. _class_OrientedPathFollow_loop: +.. _class_OrientedPathFollow_loop: - :ref:`bool` **loop** @@ -83,7 +83,7 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - .. _class_OrientedPathFollow_offset: +.. _class_OrientedPathFollow_offset: - :ref:`float` **offset** @@ -95,7 +95,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. - .. _class_OrientedPathFollow_unit_offset: +.. _class_OrientedPathFollow_unit_offset: - :ref:`float` **unit_offset** @@ -107,7 +107,7 @@ The distance from the first vertex, measured in 3D units along the path. This se The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - .. _class_OrientedPathFollow_v_offset: +.. _class_OrientedPathFollow_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_os.rst b/classes/class_os.rst index f9fb6da43..31e4b8285 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -227,7 +227,7 @@ Methods Enumerations ------------ - .. _enum_OS_SystemDir: +.. _enum_OS_SystemDir: enum **SystemDir**: @@ -240,7 +240,7 @@ enum **SystemDir**: - **SYSTEM_DIR_PICTURES** = **6** --- Pictures directory path. - **SYSTEM_DIR_RINGTONES** = **7** --- Ringtones directory path. - .. _enum_OS_ScreenOrientation: +.. _enum_OS_ScreenOrientation: enum **ScreenOrientation**: @@ -252,7 +252,7 @@ enum **ScreenOrientation**: - **SCREEN_ORIENTATION_SENSOR_PORTRAIT** = **5** --- Uses portrait or reverse portrait based on the hardware sensor. - **SCREEN_ORIENTATION_SENSOR** = **6** --- Uses most suitable orientation based on the hardware sensor. - .. _enum_OS_PowerState: +.. _enum_OS_PowerState: enum **PowerState**: @@ -262,7 +262,7 @@ enum **PowerState**: - **POWERSTATE_CHARGING** = **3** --- Plugged in, battery charging. - **POWERSTATE_CHARGED** = **4** --- Plugged in, battery fully charged. - .. _enum_OS_Weekday: +.. _enum_OS_Weekday: enum **Weekday**: @@ -274,7 +274,7 @@ enum **Weekday**: - **DAY_FRIDAY** = **5** --- Friday. - **DAY_SATURDAY** = **6** --- Saturday. - .. _enum_OS_Month: +.. _enum_OS_Month: enum **Month**: @@ -299,7 +299,7 @@ Operating System functions. OS Wraps the most common functionality to communicat Property Descriptions --------------------- - .. _class_OS_clipboard: +.. _class_OS_clipboard: - :ref:`String` **clipboard** @@ -311,7 +311,7 @@ Property Descriptions The clipboard from the host OS. Might be unavailable on some platforms. - .. _class_OS_current_screen: +.. _class_OS_current_screen: - :ref:`int` **current_screen** @@ -323,7 +323,7 @@ The clipboard from the host OS. Might be unavailable on some platforms. The current screen index (starting from 0). - .. _class_OS_exit_code: +.. _class_OS_exit_code: - :ref:`int` **exit_code** @@ -335,7 +335,7 @@ The current screen index (starting from 0). The exit code passed to the OS when the main loop exits. - .. _class_OS_keep_screen_on: +.. _class_OS_keep_screen_on: - :ref:`bool` **keep_screen_on** @@ -347,7 +347,7 @@ The exit code passed to the OS when the main loop exits. If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. - .. _class_OS_low_processor_usage_mode: +.. _class_OS_low_processor_usage_mode: - :ref:`bool` **low_processor_usage_mode** @@ -359,7 +359,7 @@ If ``true`` the engine tries to keep the screen on while the game is running. Us 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: +.. _class_OS_screen_orientation: - _OS.ScreenOrientation **screen_orientation** @@ -371,7 +371,7 @@ If ``true`` the engine optimizes for low processor usage by only refreshing the The current screen orientation. - .. _class_OS_vsync_enabled: +.. _class_OS_vsync_enabled: - :ref:`bool` **vsync_enabled** @@ -383,7 +383,7 @@ The current screen orientation. If ``true`` vertical synchronization (Vsync) is enabled. - .. _class_OS_window_borderless: +.. _class_OS_window_borderless: - :ref:`bool` **window_borderless** @@ -395,7 +395,7 @@ If ``true`` vertical synchronization (Vsync) is enabled. If ``true`` removes the window frame. - .. _class_OS_window_fullscreen: +.. _class_OS_window_fullscreen: - :ref:`bool` **window_fullscreen** @@ -407,7 +407,7 @@ If ``true`` removes the window frame. If ``true`` the window is fullscreen. - .. _class_OS_window_maximized: +.. _class_OS_window_maximized: - :ref:`bool` **window_maximized** @@ -419,7 +419,7 @@ If ``true`` the window is fullscreen. If ``true`` the window is maximized. - .. _class_OS_window_minimized: +.. _class_OS_window_minimized: - :ref:`bool` **window_minimized** @@ -431,7 +431,7 @@ If ``true`` the window is maximized. If ``true`` the window is minimized. - .. _class_OS_window_per_pixel_transparency_enabled: +.. _class_OS_window_per_pixel_transparency_enabled: - :ref:`bool` **window_per_pixel_transparency_enabled** @@ -441,7 +441,7 @@ If ``true`` the window is minimized. | *Getter* | get_window_per_pixel_transparency_enabled() | +----------+--------------------------------------------------+ - .. _class_OS_window_position: +.. _class_OS_window_position: - :ref:`Vector2` **window_position** @@ -453,7 +453,7 @@ If ``true`` the window is minimized. 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: +.. _class_OS_window_resizable: - :ref:`bool` **window_resizable** @@ -465,7 +465,7 @@ The window position relative to the screen, the origin is the top left corner, + If ``true``, the window is resizable by the user. - .. _class_OS_window_size: +.. _class_OS_window_size: - :ref:`Vector2` **window_size** @@ -480,47 +480,47 @@ The size of the window (without counting window manager decorations). Method Descriptions ------------------- - .. _class_OS_alert: +.. _class_OS_alert: - void **alert** **(** :ref:`String` text, :ref:`String` title="Alert!" **)** Displays a modal dialog box utilizing the host OS. - .. _class_OS_can_draw: +.. _class_OS_can_draw: - :ref:`bool` **can_draw** **(** **)** const Returns ``true`` if the host OS allows drawing. - .. _class_OS_can_use_threads: +.. _class_OS_can_use_threads: - :ref:`bool` **can_use_threads** **(** **)** const Returns ``true`` if the current host platform is using multiple threads. - .. _class_OS_center_window: +.. _class_OS_center_window: - void **center_window** **(** **)** Centers the window on the screen if in windowed mode. - .. _class_OS_close_midi_inputs: +.. _class_OS_close_midi_inputs: - void **close_midi_inputs** **(** **)** - .. _class_OS_delay_msec: +.. _class_OS_delay_msec: - void **delay_msec** **(** :ref:`int` msec **)** const Delay execution of the current thread by given milliseconds. - .. _class_OS_delay_usec: +.. _class_OS_delay_usec: - void **delay_usec** **(** :ref:`int` usec **)** const Delay execution of the current thread by given microseconds. - .. _class_OS_dump_memory_to_file: +.. _class_OS_dump_memory_to_file: - void **dump_memory_to_file** **(** :ref:`String` file **)** @@ -528,7 +528,7 @@ Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". - .. _class_OS_dump_resources_to_file: +.. _class_OS_dump_resources_to_file: - void **dump_resources_to_file** **(** :ref:`String` file **)** @@ -538,7 +538,7 @@ Entry format per line: "Resource Type : Resource Location". At the end of the file is a statistic of all used Resource Types. - .. _class_OS_execute: +.. _class_OS_execute: - :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[ ] **)** @@ -573,47 +573,47 @@ If you wish to access a shell built-in or perform a composite command, a platfor OS.execute('CMD.exe', ['/C', 'cd %TEMP% && dir'], true, output) - .. _class_OS_find_scancode_from_string: +.. _class_OS_find_scancode_from_string: - :ref:`int` **find_scancode_from_string** **(** :ref:`String` string **)** const Returns the scancode of the given string (e.g. "Escape") - .. _class_OS_get_audio_driver_count: +.. _class_OS_get_audio_driver_count: - :ref:`int` **get_audio_driver_count** **(** **)** const Returns the total number of available audio drivers. - .. _class_OS_get_audio_driver_name: +.. _class_OS_get_audio_driver_name: - :ref:`String` **get_audio_driver_name** **(** :ref:`int` driver **)** const Returns the audio driver name for the given index. - .. _class_OS_get_cmdline_args: +.. _class_OS_get_cmdline_args: - :ref:`PoolStringArray` **get_cmdline_args** **(** **)** Returns the command line arguments passed to the engine. - .. _class_OS_get_connected_midi_inputs: +.. _class_OS_get_connected_midi_inputs: - :ref:`PoolStringArray` **get_connected_midi_inputs** **(** **)** - .. _class_OS_get_date: +.. _class_OS_get_date: - :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: +.. _class_OS_get_datetime: - :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: +.. _class_OS_get_datetime_from_unix_time: - :ref:`Dictionary` **get_datetime_from_unix_time** **(** :ref:`int` unix_time_val **)** const @@ -621,25 +621,25 @@ Get a dictionary of time values when given epoch time. Dictionary Time values will be a union of values from :ref:`get_time` and :ref:`get_date` dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). - .. _class_OS_get_dynamic_memory_usage: +.. _class_OS_get_dynamic_memory_usage: - :ref:`int` **get_dynamic_memory_usage** **(** **)** const Returns the total amount of dynamic memory used (only works in debug). - .. _class_OS_get_environment: +.. _class_OS_get_environment: - :ref:`String` **get_environment** **(** :ref:`String` environment **)** const Returns an environment variable. - .. _class_OS_get_executable_path: +.. _class_OS_get_executable_path: - :ref:`String` **get_executable_path** **(** **)** const Returns the path to the current engine executable. - .. _class_OS_get_latin_keyboard_variant: +.. _class_OS_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -647,73 +647,73 @@ Returns the current latin keyboard variant as a String. Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO", "COLEMAK" or "ERROR". - .. _class_OS_get_locale: +.. _class_OS_get_locale: - :ref:`String` **get_locale** **(** **)** const Returns the host OS locale. - .. _class_OS_get_model_name: +.. _class_OS_get_model_name: - :ref:`String` **get_model_name** **(** **)** const Returns the model name of the current device. - .. _class_OS_get_name: +.. _class_OS_get_name: - :ref:`String` **get_name** **(** **)** const Returns the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". - .. _class_OS_get_power_percent_left: +.. _class_OS_get_power_percent_left: - :ref:`int` **get_power_percent_left** **(** **)** Returns the amount of battery left in the device as a percentage. - .. _class_OS_get_power_seconds_left: +.. _class_OS_get_power_seconds_left: - :ref:`int` **get_power_seconds_left** **(** **)** Returns the time in seconds before the device runs out of battery. - .. _class_OS_get_power_state: +.. _class_OS_get_power_state: - :ref:`PowerState` **get_power_state** **(** **)** Returns the current state of the device regarding battery and power. See ``POWERSTATE_*`` constants. - .. _class_OS_get_process_id: +.. _class_OS_get_process_id: - :ref:`int` **get_process_id** **(** **)** const Returns the game process ID - .. _class_OS_get_processor_count: +.. _class_OS_get_processor_count: - :ref:`int` **get_processor_count** **(** **)** const Returns the number of cores available in the host machine. - .. _class_OS_get_real_window_size: +.. _class_OS_get_real_window_size: - :ref:`Vector2` **get_real_window_size** **(** **)** const Returns the window size including decorations like window borders. - .. _class_OS_get_scancode_string: +.. _class_OS_get_scancode_string: - :ref:`String` **get_scancode_string** **(** :ref:`int` code **)** const Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). - .. _class_OS_get_screen_count: +.. _class_OS_get_screen_count: - :ref:`int` **get_screen_count** **(** **)** const Returns the number of displays attached to the host machine. - .. _class_OS_get_screen_dpi: +.. _class_OS_get_screen_dpi: - :ref:`int` **get_screen_dpi** **(** :ref:`int` screen=-1 **)** const @@ -733,71 +733,71 @@ xxhdpi - 480 dpi xxxhdpi - 640 dpi - .. _class_OS_get_screen_position: +.. _class_OS_get_screen_position: - :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: +.. _class_OS_get_screen_size: - :ref:`Vector2` **get_screen_size** **(** :ref:`int` screen=-1 **)** const Returns the dimensions in pixels of the specified screen. - .. _class_OS_get_splash_tick_msec: +.. _class_OS_get_splash_tick_msec: - :ref:`int` **get_splash_tick_msec** **(** **)** const - .. _class_OS_get_static_memory_peak_usage: +.. _class_OS_get_static_memory_peak_usage: - :ref:`int` **get_static_memory_peak_usage** **(** **)** const Returns the max amount of static memory used (only works in debug). - .. _class_OS_get_static_memory_usage: +.. _class_OS_get_static_memory_usage: - :ref:`int` **get_static_memory_usage** **(** **)** const Returns the amount of static memory being used by the program in bytes. - .. _class_OS_get_system_dir: +.. _class_OS_get_system_dir: - :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. - .. _class_OS_get_system_time_secs: +.. _class_OS_get_system_time_secs: - :ref:`int` **get_system_time_secs** **(** **)** const Returns the epoch time of the operating system in seconds. - .. _class_OS_get_ticks_msec: +.. _class_OS_get_ticks_msec: - :ref:`int` **get_ticks_msec** **(** **)** const Returns the amount of time passed in milliseconds since the engine started. - .. _class_OS_get_ticks_usec: +.. _class_OS_get_ticks_usec: - :ref:`int` **get_ticks_usec** **(** **)** const Returns the amount of time passed in microseconds since the engine started. - .. _class_OS_get_time: +.. _class_OS_get_time: - :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: +.. _class_OS_get_time_zone_info: - :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: +.. _class_OS_get_unique_id: - :ref:`String` **get_unique_id** **(** **)** const @@ -805,13 +805,13 @@ Returns a string that is unique to the device. Returns empty string on HTML5 and UWP which are not supported yet. - .. _class_OS_get_unix_time: +.. _class_OS_get_unix_time: - :ref:`int` **get_unix_time** **(** **)** const Returns the current unix epoch timestamp. - .. _class_OS_get_unix_time_from_datetime: +.. _class_OS_get_unix_time_from_datetime: - :ref:`int` **get_unix_time_from_datetime** **(** :ref:`Dictionary` datetime **)** const @@ -821,7 +821,7 @@ Get an epoch time value from a dictionary of time values. You can pass the output from :ref:`get_datetime_from_unix_time` directly into this function. Daylight savings time (dst), if present, is ignored. - .. _class_OS_get_user_data_dir: +.. _class_OS_get_user_data_dir: - :ref:`String` **get_user_data_dir** **(** **)** const @@ -835,55 +835,55 @@ On Windows, this is ``%APPDATA%/Godot/app_userdata/[project_name]``, or ``%APPDA If the project name is empty, ``user://`` falls back to ``res://``. - .. _class_OS_get_video_driver_count: +.. _class_OS_get_video_driver_count: - :ref:`int` **get_video_driver_count** **(** **)** const - .. _class_OS_get_video_driver_name: +.. _class_OS_get_video_driver_name: - :ref:`String` **get_video_driver_name** **(** :ref:`int` driver **)** const - .. _class_OS_get_virtual_keyboard_height: +.. _class_OS_get_virtual_keyboard_height: - :ref:`int` **get_virtual_keyboard_height** **(** **)** Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or it is currently hidden. - .. _class_OS_get_window_safe_area: +.. _class_OS_get_window_safe_area: - :ref:`Rect2` **get_window_safe_area** **(** **)** const - .. _class_OS_has_environment: +.. _class_OS_has_environment: - :ref:`bool` **has_environment** **(** :ref:`String` environment **)** const Returns ``true`` if an environment variable exists. - .. _class_OS_has_feature: +.. _class_OS_has_feature: - :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. - .. _class_OS_has_touchscreen_ui_hint: +.. _class_OS_has_touchscreen_ui_hint: - :ref:`bool` **has_touchscreen_ui_hint** **(** **)** const Returns ``true`` if the device has a touchscreen or emulates one. - .. _class_OS_has_virtual_keyboard: +.. _class_OS_has_virtual_keyboard: - :ref:`bool` **has_virtual_keyboard** **(** **)** const Returns ``true`` if the platform has a virtual keyboard, ``false`` otherwise. - .. _class_OS_hide_virtual_keyboard: +.. _class_OS_hide_virtual_keyboard: - void **hide_virtual_keyboard** **(** **)** Hides the virtual keyboard if it is shown, does nothing otherwise. - .. _class_OS_is_debug_build: +.. _class_OS_is_debug_build: - :ref:`bool` **is_debug_build** **(** **)** const @@ -893,37 +893,37 @@ Returns ``true`` when running in the editor. Returns ``false`` if the build is a release build. - .. _class_OS_is_ok_left_and_cancel_right: +.. _class_OS_is_ok_left_and_cancel_right: - :ref:`bool` **is_ok_left_and_cancel_right** **(** **)** const Returns ``true`` if the "Okay" button should appear on the left and "Cancel" on the right. - .. _class_OS_is_scancode_unicode: +.. _class_OS_is_scancode_unicode: - :ref:`bool` **is_scancode_unicode** **(** :ref:`int` code **)** const Returns ``true`` if the input code has a unicode character. - .. _class_OS_is_stdout_verbose: +.. _class_OS_is_stdout_verbose: - :ref:`bool` **is_stdout_verbose** **(** **)** const Returns ``true`` if the engine was executed with -v (verbose stdout). - .. _class_OS_is_userfs_persistent: +.. _class_OS_is_userfs_persistent: - :ref:`bool` **is_userfs_persistent** **(** **)** const If ``true``, the ``user://`` file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. - .. _class_OS_is_window_always_on_top: +.. _class_OS_is_window_always_on_top: - :ref:`bool` **is_window_always_on_top** **(** **)** const Returns ``true`` if the window should always be on top of other windows. - .. _class_OS_kill: +.. _class_OS_kill: - :ref:`Error` **kill** **(** :ref:`int` pid **)** @@ -931,105 +931,105 @@ Kill (terminate) the process identified by the given process ID (``pid``), e.g. Note that this method can also be used to kill processes that were not spawned by the game. - .. _class_OS_native_video_is_playing: +.. _class_OS_native_video_is_playing: - :ref:`bool` **native_video_is_playing** **(** **)** Returns ``true`` if native video is playing. - .. _class_OS_native_video_pause: +.. _class_OS_native_video_pause: - void **native_video_pause** **(** **)** Pauses native video playback. - .. _class_OS_native_video_play: +.. _class_OS_native_video_play: - :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. - .. _class_OS_native_video_stop: +.. _class_OS_native_video_stop: - void **native_video_stop** **(** **)** Stops native video playback. - .. _class_OS_native_video_unpause: +.. _class_OS_native_video_unpause: - void **native_video_unpause** **(** **)** Resumes native video playback. - .. _class_OS_open_midi_inputs: +.. _class_OS_open_midi_inputs: - void **open_midi_inputs** **(** **)** - .. _class_OS_print_all_resources: +.. _class_OS_print_all_resources: - void **print_all_resources** **(** :ref:`String` tofile="" **)** Shows all resources in the game. Optionally the list can be written to a file. - .. _class_OS_print_all_textures_by_size: +.. _class_OS_print_all_textures_by_size: - void **print_all_textures_by_size** **(** **)** Shows the list of loaded textures sorted by size in memory. - .. _class_OS_print_resources_by_type: +.. _class_OS_print_resources_by_type: - void **print_resources_by_type** **(** :ref:`PoolStringArray` types **)** Shows the number of resources loaded by the game of the given types. - .. _class_OS_print_resources_in_use: +.. _class_OS_print_resources_in_use: - void **print_resources_in_use** **(** :ref:`bool` short=false **)** Shows all resources currently used by the game. - .. _class_OS_request_attention: +.. _class_OS_request_attention: - void **request_attention** **(** **)** Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. - .. _class_OS_set_icon: +.. _class_OS_set_icon: - void **set_icon** **(** :ref:`Image` icon **)** Sets the game's icon. - .. _class_OS_set_ime_position: +.. _class_OS_set_ime_position: - void **set_ime_position** **(** :ref:`Vector2` position **)** - .. _class_OS_set_thread_name: +.. _class_OS_set_thread_name: - :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** Sets the name of the current thread. - .. _class_OS_set_use_file_access_save_and_swap: +.. _class_OS_set_use_file_access_save_and_swap: - void **set_use_file_access_save_and_swap** **(** :ref:`bool` enabled **)** Enables backup saves if ``enabled`` is ``true``. - .. _class_OS_set_window_always_on_top: +.. _class_OS_set_window_always_on_top: - void **set_window_always_on_top** **(** :ref:`bool` enabled **)** Sets whether the window should always be on top. - .. _class_OS_set_window_title: +.. _class_OS_set_window_title: - void **set_window_title** **(** :ref:`String` title **)** Sets the window title to the specified string. - .. _class_OS_shell_open: +.. _class_OS_shell_open: - :ref:`Error` **shell_open** **(** :ref:`String` uri **)** @@ -1039,7 +1039,7 @@ Requests the OS to open a resource with the most appropriate program. For exampl ``OS.shell_open("http://godotengine.org")`` opens the default web browser on the official Godot website. - .. _class_OS_show_virtual_keyboard: +.. _class_OS_show_virtual_keyboard: - void **show_virtual_keyboard** **(** :ref:`String` existing_text="" **)** diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index b62f14dd3..47fc00e95 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -35,18 +35,18 @@ Methods Property Descriptions --------------------- - .. _class_PackedDataContainer___data__: +.. _class_PackedDataContainer___data__: - :ref:`PoolByteArray` **__data__** Method Descriptions ------------------- - .. _class_PackedDataContainer_pack: +.. _class_PackedDataContainer_pack: - :ref:`Error` **pack** **(** :ref:`Variant` value **)** - .. _class_PackedDataContainer_size: +.. _class_PackedDataContainer_size: - :ref:`int` **size** **(** **)** const diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index dce391db6..ecf565e77 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -26,7 +26,7 @@ Methods Method Descriptions ------------------- - .. _class_PackedDataContainerRef_size: +.. _class_PackedDataContainerRef_size: - :ref:`int` **size** **(** **)** const diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 8e0497dd9..2eb429339 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -39,7 +39,7 @@ Methods Enumerations ------------ - .. _enum_PackedScene_GenEditState: +.. _enum_PackedScene_GenEditState: enum **GenEditState**: @@ -66,7 +66,7 @@ Example of saving a node: Property Descriptions --------------------- - .. _class_PackedScene__bundled: +.. _class_PackedScene__bundled: - :ref:`Dictionary` **_bundled** @@ -77,25 +77,25 @@ Available keys include "rnames" and "variants" for resources, "node_count", "nod Method Descriptions ------------------- - .. _class_PackedScene_can_instance: +.. _class_PackedScene_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the scene file has nodes. - .. _class_PackedScene_get_state: +.. _class_PackedScene_get_state: - :ref:`SceneState` **get_state** **(** **)** Returns the ``SceneState`` representing the scene file contents. - .. _class_PackedScene_instance: +.. _class_PackedScene_instance: - :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. - .. _class_PackedScene_pack: +.. _class_PackedScene_pack: - :ref:`Error` **pack** **(** :ref:`Node` path **)** diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 05f06e9c6..277bf8aa1 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -50,7 +50,7 @@ PacketPeer is an abstraction and base class for packet-based protocols (such as Property Descriptions --------------------- - .. _class_PacketPeer_allow_object_decoding: +.. _class_PacketPeer_allow_object_decoding: - :ref:`bool` **allow_object_decoding** @@ -63,37 +63,37 @@ Property Descriptions Method Descriptions ------------------- - .. _class_PacketPeer_get_available_packet_count: +.. _class_PacketPeer_get_available_packet_count: - :ref:`int` **get_available_packet_count** **(** **)** const Return the number of packets currently available in the ring-buffer. - .. _class_PacketPeer_get_packet: +.. _class_PacketPeer_get_packet: - :ref:`PoolByteArray` **get_packet** **(** **)** Get a raw packet. - .. _class_PacketPeer_get_packet_error: +.. _class_PacketPeer_get_packet_error: - :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: +.. _class_PacketPeer_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant. - .. _class_PacketPeer_put_packet: +.. _class_PacketPeer_put_packet: - :ref:`Error` **put_packet** **(** :ref:`PoolByteArray` buffer **)** Send a raw packet. - .. _class_PacketPeer_put_var: +.. _class_PacketPeer_put_var: - :ref:`Error` **put_var** **(** :ref:`Variant` var **)** diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 3bc4a0b00..2a539d16e 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -35,7 +35,7 @@ PacketStreamPeer provides a wrapper for working using packets over a stream. Thi Property Descriptions --------------------- - .. _class_PacketPeerStream_input_buffer_max_size: +.. _class_PacketPeerStream_input_buffer_max_size: - :ref:`int` **input_buffer_max_size** @@ -45,7 +45,7 @@ Property Descriptions | *Getter* | get_input_buffer_max_size() | +----------+----------------------------------+ - .. _class_PacketPeerStream_output_buffer_max_size: +.. _class_PacketPeerStream_output_buffer_max_size: - :ref:`int` **output_buffer_max_size** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | get_output_buffer_max_size() | +----------+-----------------------------------+ - .. _class_PacketPeerStream_stream_peer: +.. _class_PacketPeerStream_stream_peer: - :ref:`StreamPeer` **stream_peer** diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 517cfc80f..0a2b8067e 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -43,31 +43,31 @@ UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant` **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`). - .. _class_PacketPeerUDP_get_packet_port: +.. _class_PacketPeerUDP_get_packet_port: - :ref:`int` **get_packet_port** **(** **)** const Return the port of the remote peer that sent the last packet(that was received with :ref:`PacketPeer.get_packet` or :ref:`PacketPeer.get_var`). - .. _class_PacketPeerUDP_is_listening: +.. _class_PacketPeerUDP_is_listening: - :ref:`bool` **is_listening** **(** **)** const Return whether this ``PacketPeerUDP`` is listening. - .. _class_PacketPeerUDP_listen: +.. _class_PacketPeerUDP_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`int` recv_buf_size=65536 **)** @@ -79,13 +79,13 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer wi If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). - .. _class_PacketPeerUDP_set_dest_address: +.. _class_PacketPeerUDP_set_dest_address: - :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: +.. _class_PacketPeerUDP_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 753909788..4455cd828 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -31,7 +31,7 @@ A resource referenced in an :ref:`Environment` that is used t Property Descriptions --------------------- - .. _class_PanoramaSky_panorama: +.. _class_PanoramaSky_panorama: - :ref:`Texture` **panorama** diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 2c5d7da73..1d08034c1 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -41,7 +41,7 @@ A ParallaxBackground uses one or more :ref:`ParallaxLayer` Property Descriptions --------------------- - .. _class_ParallaxBackground_scroll_base_offset: +.. _class_ParallaxBackground_scroll_base_offset: - :ref:`Vector2` **scroll_base_offset** @@ -53,7 +53,7 @@ Property Descriptions Base position offset of all :ref:`ParallaxLayer` children. - .. _class_ParallaxBackground_scroll_base_scale: +.. _class_ParallaxBackground_scroll_base_scale: - :ref:`Vector2` **scroll_base_scale** @@ -65,7 +65,7 @@ Base position offset of all :ref:`ParallaxLayer` children. Base motion scale of all :ref:`ParallaxLayer` children. - .. _class_ParallaxBackground_scroll_ignore_camera_zoom: +.. _class_ParallaxBackground_scroll_ignore_camera_zoom: - :ref:`bool` **scroll_ignore_camera_zoom** @@ -77,7 +77,7 @@ Base motion scale of all :ref:`ParallaxLayer` children. If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. - .. _class_ParallaxBackground_scroll_limit_begin: +.. _class_ParallaxBackground_scroll_limit_begin: - :ref:`Vector2` **scroll_limit_begin** @@ -89,7 +89,7 @@ If ``true`` elements in :ref:`ParallaxLayer` child aren't a 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: +.. _class_ParallaxBackground_scroll_limit_end: - :ref:`Vector2` **scroll_limit_end** @@ -101,7 +101,7 @@ Top left limits for scrolling to begin. If the camera is outside of this limit t 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: +.. _class_ParallaxBackground_scroll_offset: - :ref:`Vector2` **scroll_offset** diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 413544140..74d6ea2cb 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -37,7 +37,7 @@ This node's children will be affected by its scroll offset. Property Descriptions --------------------- - .. _class_ParallaxLayer_motion_mirroring: +.. _class_ParallaxLayer_motion_mirroring: - :ref:`Vector2` **motion_mirroring** @@ -49,7 +49,7 @@ Property Descriptions 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: +.. _class_ParallaxLayer_motion_offset: - :ref:`Vector2` **motion_offset** @@ -61,7 +61,7 @@ The ParallaxLayer's :ref:`Texture` mirroring. Useful for creating The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. - .. _class_ParallaxLayer_motion_scale: +.. _class_ParallaxLayer_motion_scale: - :ref:`Vector2` **motion_scale** diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 8ad5034f4..a091069f2 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -71,7 +71,7 @@ Methods Enumerations ------------ - .. _enum_Particles_DrawOrder: +.. _enum_Particles_DrawOrder: enum **DrawOrder**: @@ -83,6 +83,7 @@ Constants --------- - **MAX_DRAW_PASSES** = **4** --- Maximum number of draw passes supported. + Description ----------- @@ -93,7 +94,7 @@ Use the ``process_material`` property to add a :ref:`ParticlesMaterial` **amount** @@ -105,7 +106,7 @@ Property Descriptions Number of particles to emit. - .. _class_Particles_draw_order: +.. _class_Particles_draw_order: - :ref:`DrawOrder` **draw_order** @@ -117,7 +118,7 @@ Number of particles to emit. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. - .. _class_Particles_draw_pass_1: +.. _class_Particles_draw_pass_1: - :ref:`Mesh` **draw_pass_1** @@ -129,7 +130,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the first draw pass. - .. _class_Particles_draw_pass_2: +.. _class_Particles_draw_pass_2: - :ref:`Mesh` **draw_pass_2** @@ -141,7 +142,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the second draw pass. - .. _class_Particles_draw_pass_3: +.. _class_Particles_draw_pass_3: - :ref:`Mesh` **draw_pass_3** @@ -153,7 +154,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the third draw pass. - .. _class_Particles_draw_pass_4: +.. _class_Particles_draw_pass_4: - :ref:`Mesh` **draw_pass_4** @@ -165,7 +166,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I :ref:`Mesh` that is drawn for the fourth draw pass. - .. _class_Particles_draw_passes: +.. _class_Particles_draw_passes: - :ref:`int` **draw_passes** @@ -177,7 +178,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I The number of draw passes when rendering particles. - .. _class_Particles_emitting: +.. _class_Particles_emitting: - :ref:`bool` **emitting** @@ -189,7 +190,7 @@ The number of draw passes when rendering particles. If ``true`` particles are being emitted. Default value: ``true``. - .. _class_Particles_explosiveness: +.. _class_Particles_explosiveness: - :ref:`float` **explosiveness** @@ -201,7 +202,7 @@ If ``true`` particles are being emitted. Default value: ``true``. Time ratio between each emission. If ``0`` particles are emitted continuously. If ``1`` all particles are emitted simultaneously. Default value: ``0``. - .. _class_Particles_fixed_fps: +.. _class_Particles_fixed_fps: - :ref:`int` **fixed_fps** @@ -211,7 +212,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I | *Getter* | get_fixed_fps() | +----------+----------------------+ - .. _class_Particles_fract_delta: +.. _class_Particles_fract_delta: - :ref:`bool` **fract_delta** @@ -221,7 +222,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I | *Getter* | get_fractional_delta() | +----------+-----------------------------+ - .. _class_Particles_lifetime: +.. _class_Particles_lifetime: - :ref:`float` **lifetime** @@ -233,7 +234,7 @@ Time ratio between each emission. If ``0`` particles are emitted continuously. I Amount of time each particle will exist. Default value: ``1``. - .. _class_Particles_local_coords: +.. _class_Particles_local_coords: - :ref:`bool` **local_coords** @@ -245,7 +246,7 @@ Amount of time each particle will exist. Default value: ``1``. If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. - .. _class_Particles_one_shot: +.. _class_Particles_one_shot: - :ref:`bool` **one_shot** @@ -257,7 +258,7 @@ If ``true`` particles use the parent node's coordinate space. If ``false`` they If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. - .. _class_Particles_preprocess: +.. _class_Particles_preprocess: - :ref:`float` **preprocess** @@ -269,7 +270,7 @@ If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. - .. _class_Particles_process_material: +.. _class_Particles_process_material: - :ref:`Material` **process_material** @@ -281,7 +282,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. - .. _class_Particles_randomness: +.. _class_Particles_randomness: - :ref:`float` **randomness** @@ -293,7 +294,7 @@ Amount of time to preprocess the particles before animation starts. Lets you sta Emission randomness ratio. Default value: ``0``. - .. _class_Particles_speed_scale: +.. _class_Particles_speed_scale: - :ref:`float` **speed_scale** @@ -305,7 +306,7 @@ Emission randomness ratio. Default value: ``0``. Speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. - .. _class_Particles_visibility_aabb: +.. _class_Particles_visibility_aabb: - :ref:`AABB` **visibility_aabb** @@ -320,11 +321,11 @@ The :ref:`AABB` that determines the area of the world part of which Method Descriptions ------------------- - .. _class_Particles_capture_aabb: +.. _class_Particles_capture_aabb: - :ref:`AABB` **capture_aabb** **(** **)** const - .. _class_Particles_restart: +.. _class_Particles_restart: - void **restart** **(** **)** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 29bf4f7a1..43fac07be 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -69,7 +69,7 @@ Methods Enumerations ------------ - .. _enum_Particles2D_DrawOrder: +.. _enum_Particles2D_DrawOrder: enum **DrawOrder**: @@ -86,7 +86,7 @@ Use the ``process_material`` property to add a :ref:`ParticlesMaterial` **amount** @@ -98,7 +98,7 @@ Property Descriptions Number of particles emitted in one emission cycle. - .. _class_Particles2D_draw_order: +.. _class_Particles2D_draw_order: - :ref:`DrawOrder` **draw_order** @@ -110,7 +110,7 @@ Number of particles emitted in one emission cycle. Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_INDEX``. - .. _class_Particles2D_emitting: +.. _class_Particles2D_emitting: - :ref:`bool` **emitting** @@ -122,7 +122,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I If ``true`` particles are being emitted. Default value: ``true``. - .. _class_Particles2D_explosiveness: +.. _class_Particles2D_explosiveness: - :ref:`float` **explosiveness** @@ -134,7 +134,7 @@ If ``true`` particles are being emitted. Default value: ``true``. How rapidly particles in an emission cycle are emitted. If greater than ``0``, there will be a gap in emissions before the next cycle begins. Default value: ``0``. - .. _class_Particles2D_fixed_fps: +.. _class_Particles2D_fixed_fps: - :ref:`int` **fixed_fps** @@ -144,7 +144,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t | *Getter* | get_fixed_fps() | +----------+----------------------+ - .. _class_Particles2D_fract_delta: +.. _class_Particles2D_fract_delta: - :ref:`bool` **fract_delta** @@ -154,7 +154,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t | *Getter* | get_fractional_delta() | +----------+-----------------------------+ - .. _class_Particles2D_h_frames: +.. _class_Particles2D_h_frames: - :ref:`int` **h_frames** @@ -166,7 +166,7 @@ How rapidly particles in an emission cycle are emitted. If greater than ``0``, t Number of horizontal frames in ``texture``. - .. _class_Particles2D_lifetime: +.. _class_Particles2D_lifetime: - :ref:`float` **lifetime** @@ -178,7 +178,7 @@ Number of horizontal frames in ``texture``. Amount of time each particle will exist. Default value: ``1``. - .. _class_Particles2D_local_coords: +.. _class_Particles2D_local_coords: - :ref:`bool` **local_coords** @@ -190,7 +190,7 @@ Amount of time each particle will exist. Default value: ``1``. If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. - .. _class_Particles2D_normal_map: +.. _class_Particles2D_normal_map: - :ref:`Texture` **normal_map** @@ -200,7 +200,7 @@ If ``true`` particles use the parent node's coordinate space. If ``false`` they | *Getter* | get_normal_map() | +----------+-----------------------+ - .. _class_Particles2D_one_shot: +.. _class_Particles2D_one_shot: - :ref:`bool` **one_shot** @@ -212,7 +212,7 @@ If ``true`` particles use the parent node's coordinate space. If ``false`` they If ``true`` only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. - .. _class_Particles2D_preprocess: +.. _class_Particles2D_preprocess: - :ref:`float` **preprocess** @@ -224,7 +224,7 @@ If ``true`` only one emission cycle occurs. If set ``true`` during a cycle, emis Particle system starts as if it had already run for this many seconds. - .. _class_Particles2D_process_material: +.. _class_Particles2D_process_material: - :ref:`Material` **process_material** @@ -236,7 +236,7 @@ Particle system starts as if it had already run for this many seconds. :ref:`Material` for processing particles. Can be a :ref:`ParticlesMaterial` or a :ref:`ShaderMaterial`. - .. _class_Particles2D_randomness: +.. _class_Particles2D_randomness: - :ref:`float` **randomness** @@ -248,7 +248,7 @@ Particle system starts as if it had already run for this many seconds. Emission lifetime randomness ratio. Default value: ``0``. - .. _class_Particles2D_speed_scale: +.. _class_Particles2D_speed_scale: - :ref:`float` **speed_scale** @@ -260,7 +260,7 @@ Emission lifetime randomness ratio. Default value: ``0``. Particle system's running speed scaling ratio. Default value: ``1``. A value of ``0`` can be used to pause the particles. - .. _class_Particles2D_texture: +.. _class_Particles2D_texture: - :ref:`Texture` **texture** @@ -272,7 +272,7 @@ Particle system's running speed scaling ratio. Default value: ``1``. A value of Particle texture. If ``null`` particles will be squares. - .. _class_Particles2D_v_frames: +.. _class_Particles2D_v_frames: - :ref:`int` **v_frames** @@ -284,7 +284,7 @@ Particle texture. If ``null`` particles will be squares. Number of vertical frames in ``texture``. - .. _class_Particles2D_visibility_rect: +.. _class_Particles2D_visibility_rect: - :ref:`Rect2` **visibility_rect** @@ -299,11 +299,11 @@ Editor visibility helper. Method Descriptions ------------------- - .. _class_Particles2D_capture_rect: +.. _class_Particles2D_capture_rect: - :ref:`Rect2` **capture_rect** **(** **)** const - .. _class_Particles2D_restart: +.. _class_Particles2D_restart: - void **restart** **(** **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 2657e3523..acefef0b9 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -132,7 +132,7 @@ Properties Enumerations ------------ - .. _enum_ParticlesMaterial_Flags: +.. _enum_ParticlesMaterial_Flags: enum **Flags**: @@ -140,7 +140,7 @@ enum **Flags**: - **FLAG_ROTATE_Y** = **1** --- Use with :ref:`set_flag` to set :ref:`flag_rotate_y` - **FLAG_MAX** = **4** - .. _enum_ParticlesMaterial_Parameter: +.. _enum_ParticlesMaterial_Parameter: enum **Parameter**: @@ -158,7 +158,7 @@ enum **Parameter**: - **PARAM_ANIM_OFFSET** = **11** --- Use with :ref:`set_param`, :ref:`set_param_randomness`, and :ref:`set_param_texture` to set animation offset properties. - **PARAM_MAX** = **12** - .. _enum_ParticlesMaterial_EmissionShape: +.. _enum_ParticlesMaterial_EmissionShape: enum **EmissionShape**: @@ -178,7 +178,7 @@ Some of this material's properties are applied to each particle when emitted, wh Property Descriptions --------------------- - .. _class_ParticlesMaterial_angle: +.. _class_ParticlesMaterial_angle: - :ref:`float` **angle** @@ -190,7 +190,7 @@ Property Descriptions Initial rotation applied to each particle. - .. _class_ParticlesMaterial_angle_curve: +.. _class_ParticlesMaterial_angle_curve: - :ref:`Texture` **angle_curve** @@ -202,7 +202,7 @@ Initial rotation applied to each particle. Each particle's rotation will be animated along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_angle_random: +.. _class_ParticlesMaterial_angle_random: - :ref:`float` **angle_random** @@ -214,7 +214,7 @@ Each particle's rotation will be animated along this :ref:`CurveTexture` **angular_velocity** @@ -226,7 +226,7 @@ Rotation randomness ratio. Default value: ``0``. Initial angular velocity applied to each particle. - .. _class_ParticlesMaterial_angular_velocity_curve: +.. _class_ParticlesMaterial_angular_velocity_curve: - :ref:`Texture` **angular_velocity_curve** @@ -238,7 +238,7 @@ Initial angular velocity applied to each particle. Each particle's angular velocity will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_angular_velocity_random: +.. _class_ParticlesMaterial_angular_velocity_random: - :ref:`float` **angular_velocity_random** @@ -250,7 +250,7 @@ Each particle's angular velocity will vary along this :ref:`CurveTexture` **anim_loop** @@ -262,7 +262,7 @@ Angular velocity randomness ratio. Default value: ``0``. If ``true`` animation will loop. Default value: ``false``. - .. _class_ParticlesMaterial_anim_offset: +.. _class_ParticlesMaterial_anim_offset: - :ref:`float` **anim_offset** @@ -274,7 +274,7 @@ If ``true`` animation will loop. Default value: ``false``. Particle animation offset. - .. _class_ParticlesMaterial_anim_offset_curve: +.. _class_ParticlesMaterial_anim_offset_curve: - :ref:`Texture` **anim_offset_curve** @@ -286,7 +286,7 @@ Particle animation offset. Each particle's animation offset will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_anim_offset_random: +.. _class_ParticlesMaterial_anim_offset_random: - :ref:`float` **anim_offset_random** @@ -298,7 +298,7 @@ Each particle's animation offset will vary along this :ref:`CurveTexture` **anim_speed** @@ -310,7 +310,7 @@ Animation offset randomness ratio. Default value: ``0``. Particle animation speed. - .. _class_ParticlesMaterial_anim_speed_curve: +.. _class_ParticlesMaterial_anim_speed_curve: - :ref:`Texture` **anim_speed_curve** @@ -322,7 +322,7 @@ Particle animation speed. Each particle's animation speed will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_anim_speed_random: +.. _class_ParticlesMaterial_anim_speed_random: - :ref:`float` **anim_speed_random** @@ -334,7 +334,7 @@ Each particle's animation speed will vary along this :ref:`CurveTexture` **color** @@ -346,7 +346,7 @@ Animation speed randomness ratio. Default value: ``0``. Each particle's initial color. If the Particle2D's ``texture`` is defined, it will be multiplied by this color. - .. _class_ParticlesMaterial_color_ramp: +.. _class_ParticlesMaterial_color_ramp: - :ref:`Texture` **color_ramp** @@ -358,7 +358,7 @@ Each particle's initial color. If the Particle2D's ``texture`` is defined, it wi Each particle's color will vary along this :ref:`GradientTexture`. - .. _class_ParticlesMaterial_damping: +.. _class_ParticlesMaterial_damping: - :ref:`float` **damping** @@ -370,7 +370,7 @@ Each particle's color will vary along this :ref:`GradientTexture` **damping_curve** @@ -382,7 +382,7 @@ The rate at which particles lose velocity. Damping will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_damping_random: +.. _class_ParticlesMaterial_damping_random: - :ref:`float` **damping_random** @@ -394,7 +394,7 @@ Damping will vary along this :ref:`CurveTexture`. Damping randomness ratio. Default value: ``0``. - .. _class_ParticlesMaterial_emission_box_extents: +.. _class_ParticlesMaterial_emission_box_extents: - :ref:`Vector3` **emission_box_extents** @@ -406,7 +406,7 @@ Damping randomness ratio. Default value: ``0``. The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. - .. _class_ParticlesMaterial_emission_color_texture: +.. _class_ParticlesMaterial_emission_color_texture: - :ref:`Texture` **emission_color_texture** @@ -416,7 +416,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. | *Getter* | get_emission_color_texture() | +----------+-----------------------------------+ - .. _class_ParticlesMaterial_emission_normal_texture: +.. _class_ParticlesMaterial_emission_normal_texture: - :ref:`Texture` **emission_normal_texture** @@ -426,7 +426,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. | *Getter* | get_emission_normal_texture() | +----------+------------------------------------+ - .. _class_ParticlesMaterial_emission_point_count: +.. _class_ParticlesMaterial_emission_point_count: - :ref:`int` **emission_point_count** @@ -438,7 +438,7 @@ The box's extents if ``emission_shape`` is set to ``EMISSION_SHAPE_BOX``. The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_POINTS`` or ``EMISSION_SHAPE_DIRECTED_POINTS``. - .. _class_ParticlesMaterial_emission_point_texture: +.. _class_ParticlesMaterial_emission_point_texture: - :ref:`Texture` **emission_point_texture** @@ -448,7 +448,7 @@ The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_P | *Getter* | get_emission_point_texture() | +----------+-----------------------------------+ - .. _class_ParticlesMaterial_emission_shape: +.. _class_ParticlesMaterial_emission_shape: - :ref:`EmissionShape` **emission_shape** @@ -460,7 +460,7 @@ The number of emission points if ``emission_shape`` is set to ``EMISSION_SHAPE_P Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants for values. Default value: ``EMISSION_SHAPE_POINT``. - .. _class_ParticlesMaterial_emission_sphere_radius: +.. _class_ParticlesMaterial_emission_sphere_radius: - :ref:`float` **emission_sphere_radius** @@ -472,7 +472,7 @@ Particles will be emitted inside this region. Use ``EMISSION_SHAPE_*`` constants The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. - .. _class_ParticlesMaterial_flag_align_y: +.. _class_ParticlesMaterial_flag_align_y: - :ref:`bool` **flag_align_y** @@ -482,7 +482,7 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. | *Getter* | get_flag() | +----------+-----------------+ - .. _class_ParticlesMaterial_flag_disable_z: +.. _class_ParticlesMaterial_flag_disable_z: - :ref:`bool` **flag_disable_z** @@ -494,7 +494,7 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. 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: +.. _class_ParticlesMaterial_flag_rotate_y: - :ref:`bool` **flag_rotate_y** @@ -504,7 +504,7 @@ If ``true`` particles will not move on the z axis. Default value: ``true`` for : | *Getter* | get_flag() | +----------+-----------------+ - .. _class_ParticlesMaterial_flatness: +.. _class_ParticlesMaterial_flatness: - :ref:`float` **flatness** @@ -514,7 +514,7 @@ If ``true`` particles will not move on the z axis. Default value: ``true`` for : | *Getter* | get_flatness() | +----------+---------------------+ - .. _class_ParticlesMaterial_gravity: +.. _class_ParticlesMaterial_gravity: - :ref:`Vector3` **gravity** @@ -526,7 +526,7 @@ If ``true`` particles will not move on the z axis. Default value: ``true`` for : Gravity applied to every particle. Default value: ``(0, 98, 0)``. - .. _class_ParticlesMaterial_hue_variation: +.. _class_ParticlesMaterial_hue_variation: - :ref:`float` **hue_variation** @@ -538,7 +538,7 @@ Gravity applied to every particle. Default value: ``(0, 98, 0)``. Initial hue variation applied to each particle. - .. _class_ParticlesMaterial_hue_variation_curve: +.. _class_ParticlesMaterial_hue_variation_curve: - :ref:`Texture` **hue_variation_curve** @@ -550,7 +550,7 @@ Initial hue variation applied to each particle. Each particle's hue will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_hue_variation_random: +.. _class_ParticlesMaterial_hue_variation_random: - :ref:`float` **hue_variation_random** @@ -562,7 +562,7 @@ Each particle's hue will vary along this :ref:`CurveTexture` Hue variation randomness ratio. Default value: ``0``. - .. _class_ParticlesMaterial_initial_velocity: +.. _class_ParticlesMaterial_initial_velocity: - :ref:`float` **initial_velocity** @@ -574,7 +574,7 @@ Hue variation randomness ratio. Default value: ``0``. Initial velocity for each particle. - .. _class_ParticlesMaterial_initial_velocity_random: +.. _class_ParticlesMaterial_initial_velocity_random: - :ref:`float` **initial_velocity_random** @@ -586,7 +586,7 @@ Initial velocity for each particle. Initial velocity randomness ratio. Default value: ``0``. - .. _class_ParticlesMaterial_linear_accel: +.. _class_ParticlesMaterial_linear_accel: - :ref:`float` **linear_accel** @@ -598,7 +598,7 @@ Initial velocity randomness ratio. Default value: ``0``. Linear acceleration applied to each particle. - .. _class_ParticlesMaterial_linear_accel_curve: +.. _class_ParticlesMaterial_linear_accel_curve: - :ref:`Texture` **linear_accel_curve** @@ -610,7 +610,7 @@ Linear acceleration applied to each particle. Each particle's linear acceleration will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_linear_accel_random: +.. _class_ParticlesMaterial_linear_accel_random: - :ref:`float` **linear_accel_random** @@ -622,7 +622,7 @@ Each particle's linear acceleration will vary along this :ref:`CurveTexture` **orbit_velocity** @@ -634,7 +634,7 @@ Linear acceleration randomness ratio. Default value: ``0``. Orbital velocity applied to each particle. - .. _class_ParticlesMaterial_orbit_velocity_curve: +.. _class_ParticlesMaterial_orbit_velocity_curve: - :ref:`Texture` **orbit_velocity_curve** @@ -646,7 +646,7 @@ Orbital velocity applied to each particle. Each particle's orbital velocity will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_orbit_velocity_random: +.. _class_ParticlesMaterial_orbit_velocity_random: - :ref:`float` **orbit_velocity_random** @@ -658,7 +658,7 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **radial_accel** @@ -670,7 +670,7 @@ Orbital velocity randomness ratio. Default value: ``0``. Radial acceleration applied to each particle. - .. _class_ParticlesMaterial_radial_accel_curve: +.. _class_ParticlesMaterial_radial_accel_curve: - :ref:`Texture` **radial_accel_curve** @@ -682,7 +682,7 @@ Radial acceleration applied to each particle. Each particle's radial acceleration will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_radial_accel_random: +.. _class_ParticlesMaterial_radial_accel_random: - :ref:`float` **radial_accel_random** @@ -694,7 +694,7 @@ Each particle's radial acceleration will vary along this :ref:`CurveTexture` **scale** @@ -706,7 +706,7 @@ Radial acceleration randomness ratio. Default value: ``0``. Initial scale applied to each particle. - .. _class_ParticlesMaterial_scale_curve: +.. _class_ParticlesMaterial_scale_curve: - :ref:`Texture` **scale_curve** @@ -718,7 +718,7 @@ Initial scale applied to each particle. Each particle's scale will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_scale_random: +.. _class_ParticlesMaterial_scale_random: - :ref:`float` **scale_random** @@ -730,7 +730,7 @@ Each particle's scale will vary along this :ref:`CurveTexture` **spread** @@ -742,7 +742,7 @@ Scale randomness ratio. Default value: ``0``. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Default value: ``45``. - .. _class_ParticlesMaterial_tangential_accel: +.. _class_ParticlesMaterial_tangential_accel: - :ref:`float` **tangential_accel** @@ -754,7 +754,7 @@ Each particle's initial direction range from ``+spread`` to ``-spread`` degrees. Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity. - .. _class_ParticlesMaterial_tangential_accel_curve: +.. _class_ParticlesMaterial_tangential_accel_curve: - :ref:`Texture` **tangential_accel_curve** @@ -766,7 +766,7 @@ Tangential acceleration applied to each particle. Tangential acceleration is per Each particle's tangential acceleration will vary along this :ref:`CurveTexture`. - .. _class_ParticlesMaterial_tangential_accel_random: +.. _class_ParticlesMaterial_tangential_accel_random: - :ref:`float` **tangential_accel_random** @@ -778,7 +778,7 @@ Each particle's tangential acceleration will vary along this :ref:`CurveTexture< Tangential acceleration randomness ratio. Default value: ``0``. - .. _class_ParticlesMaterial_trail_color_modifier: +.. _class_ParticlesMaterial_trail_color_modifier: - :ref:`GradientTexture` **trail_color_modifier** @@ -790,7 +790,7 @@ Tangential acceleration randomness ratio. Default value: ``0``. Trail particles' color will vary along this :ref:`GradientTexture`. - .. _class_ParticlesMaterial_trail_divisor: +.. _class_ParticlesMaterial_trail_divisor: - :ref:`int` **trail_divisor** @@ -802,7 +802,7 @@ Trail particles' color will vary along this :ref:`GradientTexture` **trail_size_modifier** diff --git a/classes/class_path.rst b/classes/class_path.rst index c84526064..424b3062f 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -26,7 +26,7 @@ Properties Signals ------- - .. _class_Path_curve_changed: +.. _class_Path_curve_changed: - **curve_changed** **(** **)** @@ -38,7 +38,7 @@ This class is a container/Node-ification of a :ref:`Curve3D`, so Property Descriptions --------------------- - .. _class_Path_curve: +.. _class_Path_curve: - :ref:`Curve3D` **curve** diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index 82c099297..e74461f64 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -31,7 +31,7 @@ Can have :ref:`PathFollow2D` child-nodes moving along the :r Property Descriptions --------------------- - .. _class_Path2D_curve: +.. _class_Path2D_curve: - :ref:`Curve2D` **curve** diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index 94a0742e3..a0146e3ea 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -38,7 +38,7 @@ Properties Enumerations ------------ - .. _enum_PathFollow_RotationMode: +.. _enum_PathFollow_RotationMode: enum **RotationMode**: @@ -57,7 +57,7 @@ It is useful for making other nodes follow a path, without coding the movement p Property Descriptions --------------------- - .. _class_PathFollow_cubic_interp: +.. _class_PathFollow_cubic_interp: - :ref:`bool` **cubic_interp** @@ -73,7 +73,7 @@ The points along the :ref:`Curve3D` of the :ref:`Path 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. - .. _class_PathFollow_h_offset: +.. _class_PathFollow_h_offset: - :ref:`float` **h_offset** @@ -85,7 +85,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. - .. _class_PathFollow_loop: +.. _class_PathFollow_loop: - :ref:`bool` **loop** @@ -97,7 +97,7 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - .. _class_PathFollow_offset: +.. _class_PathFollow_offset: - :ref:`float` **offset** @@ -109,7 +109,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. - .. _class_PathFollow_rotation_mode: +.. _class_PathFollow_rotation_mode: - :ref:`RotationMode` **rotation_mode** @@ -121,7 +121,7 @@ The distance from the first vertex, measured in 3D units along the path. This se Allows or forbids rotation on one or more axes, depending on the constants being used. - .. _class_PathFollow_unit_offset: +.. _class_PathFollow_unit_offset: - :ref:`float` **unit_offset** @@ -133,7 +133,7 @@ Allows or forbids rotation on one or more axes, depending on the constants being The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - .. _class_PathFollow_v_offset: +.. _class_PathFollow_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 8ae704c3b..54e80ce8e 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -47,7 +47,7 @@ It is useful for making other nodes follow a path, without coding the movement p Property Descriptions --------------------- - .. _class_PathFollow2D_cubic_interp: +.. _class_PathFollow2D_cubic_interp: - :ref:`bool` **cubic_interp** @@ -63,7 +63,7 @@ The points along the :ref:`Curve2D` of the :ref:`Path2D` **h_offset** @@ -75,7 +75,7 @@ There are two answers to this problem: Either increase the number of cached poin The node's offset along the curve. - .. _class_PathFollow2D_lookahead: +.. _class_PathFollow2D_lookahead: - :ref:`float` **lookahead** @@ -85,7 +85,7 @@ The node's offset along the curve. | *Getter* | get_lookahead() | +----------+----------------------+ - .. _class_PathFollow2D_loop: +.. _class_PathFollow2D_loop: - :ref:`bool` **loop** @@ -97,7 +97,7 @@ The node's offset along the curve. If ``true``, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths. - .. _class_PathFollow2D_offset: +.. _class_PathFollow2D_offset: - :ref:`float` **offset** @@ -109,7 +109,7 @@ If ``true``, any offset outside the path's length will wrap around, instead of s The distance along the path in pixels. - .. _class_PathFollow2D_rotate: +.. _class_PathFollow2D_rotate: - :ref:`bool` **rotate** @@ -121,7 +121,7 @@ The distance along the path in pixels. If ``true``, this node rotates to follow the path, making its descendants rotate. - .. _class_PathFollow2D_unit_offset: +.. _class_PathFollow2D_unit_offset: - :ref:`float` **unit_offset** @@ -133,7 +133,7 @@ If ``true``, this node rotates to follow the path, making its descendants rotate The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. - .. _class_PathFollow2D_v_offset: +.. _class_PathFollow2D_v_offset: - :ref:`float` **v_offset** diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index 00c8f8ac9..935c14826 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -30,15 +30,15 @@ Methods Method Descriptions ------------------- - .. _class_PCKPacker_add_file: +.. _class_PCKPacker_add_file: - :ref:`Error` **add_file** **(** :ref:`String` pck_path, :ref:`String` source_path **)** - .. _class_PCKPacker_flush: +.. _class_PCKPacker_flush: - :ref:`Error` **flush** **(** :ref:`bool` verbose **)** - .. _class_PCKPacker_pck_start: +.. _class_PCKPacker_pck_start: - :ref:`Error` **pck_start** **(** :ref:`String` pck_name, :ref:`int` alignment **)** diff --git a/classes/class_performance.rst b/classes/class_performance.rst index b51287e20..7a4989899 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -26,7 +26,7 @@ Methods Enumerations ------------ - .. _enum_Performance_Monitor: +.. _enum_Performance_Monitor: enum **Monitor**: @@ -70,7 +70,7 @@ Many of these monitors are not updated in real-time, so there may be a short del Method Descriptions ------------------- - .. _class_Performance_get_monitor: +.. _class_Performance_get_monitor: - :ref:`float` **get_monitor** **(** :ref:`Monitor` monitor **)** const diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index b58fc80cc..7ad6116ac 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -31,7 +31,7 @@ Optimized translation. Uses real-time compressed translations, which results in Method Descriptions ------------------- - .. _class_PHashTranslation_generate: +.. _class_PHashTranslation_generate: - void **generate** **(** :ref:`Translation` from **)** diff --git a/classes/class_physicalbone.rst b/classes/class_physicalbone.rst index d9269b224..2b8f0359a 100644 --- a/classes/class_physicalbone.rst +++ b/classes/class_physicalbone.rst @@ -53,7 +53,7 @@ Methods Enumerations ------------ - .. _enum_PhysicalBone_JointType: +.. _enum_PhysicalBone_JointType: enum **JointType**: @@ -67,7 +67,7 @@ enum **JointType**: Property Descriptions --------------------- - .. _class_PhysicalBone_body_offset: +.. _class_PhysicalBone_body_offset: - :ref:`Transform` **body_offset** @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_body_offset() | +----------+------------------------+ - .. _class_PhysicalBone_bounce: +.. _class_PhysicalBone_bounce: - :ref:`float` **bounce** @@ -87,7 +87,7 @@ Property Descriptions | *Getter* | get_bounce() | +----------+-------------------+ - .. _class_PhysicalBone_friction: +.. _class_PhysicalBone_friction: - :ref:`float` **friction** @@ -97,7 +97,7 @@ Property Descriptions | *Getter* | get_friction() | +----------+---------------------+ - .. _class_PhysicalBone_gravity_scale: +.. _class_PhysicalBone_gravity_scale: - :ref:`float` **gravity_scale** @@ -107,7 +107,7 @@ Property Descriptions | *Getter* | get_gravity_scale() | +----------+--------------------------+ - .. _class_PhysicalBone_joint_offset: +.. _class_PhysicalBone_joint_offset: - :ref:`Transform` **joint_offset** @@ -117,7 +117,7 @@ Property Descriptions | *Getter* | get_joint_offset() | +----------+-------------------------+ - .. _class_PhysicalBone_joint_type: +.. _class_PhysicalBone_joint_type: - :ref:`JointType` **joint_type** @@ -127,7 +127,7 @@ Property Descriptions | *Getter* | get_joint_type() | +----------+-----------------------+ - .. _class_PhysicalBone_mass: +.. _class_PhysicalBone_mass: - :ref:`float` **mass** @@ -137,7 +137,7 @@ Property Descriptions | *Getter* | get_mass() | +----------+-----------------+ - .. _class_PhysicalBone_weight: +.. _class_PhysicalBone_weight: - :ref:`float` **weight** @@ -150,19 +150,19 @@ Property Descriptions Method Descriptions ------------------- - .. _class_PhysicalBone_get_bone_id: +.. _class_PhysicalBone_get_bone_id: - :ref:`int` **get_bone_id** **(** **)** const - .. _class_PhysicalBone_get_simulate_physics: +.. _class_PhysicalBone_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** - .. _class_PhysicalBone_is_simulating_physics: +.. _class_PhysicalBone_is_simulating_physics: - :ref:`bool` **is_simulating_physics** **(** **)** - .. _class_PhysicalBone_is_static_body: +.. _class_PhysicalBone_is_static_body: - :ref:`bool` **is_static_body** **(** **)** diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 51ea000a1..4e1cae62e 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -94,7 +94,7 @@ Direct access object to a physics body in the :ref:`Physics2DServer` **angular_velocity** @@ -106,7 +106,7 @@ Property Descriptions The angular velocity of the body. - .. _class_Physics2DDirectBodyState_inverse_inertia: +.. _class_Physics2DDirectBodyState_inverse_inertia: - :ref:`float` **inverse_inertia** @@ -116,7 +116,7 @@ The angular velocity of the body. The inverse of the inertia of the body. - .. _class_Physics2DDirectBodyState_inverse_mass: +.. _class_Physics2DDirectBodyState_inverse_mass: - :ref:`float` **inverse_mass** @@ -126,7 +126,7 @@ The inverse of the inertia of the body. The inverse of the mass of the body. - .. _class_Physics2DDirectBodyState_linear_velocity: +.. _class_Physics2DDirectBodyState_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -138,7 +138,7 @@ The inverse of the mass of the body. The linear velocity of the body. - .. _class_Physics2DDirectBodyState_sleeping: +.. _class_Physics2DDirectBodyState_sleeping: - :ref:`bool` **sleeping** @@ -150,7 +150,7 @@ The linear velocity of the body. ``true`` if this body is currently sleeping (not active). - .. _class_Physics2DDirectBodyState_step: +.. _class_Physics2DDirectBodyState_step: - :ref:`float` **step** @@ -160,7 +160,7 @@ The linear velocity of the body. The timestep (delta) used for the simulation. - .. _class_Physics2DDirectBodyState_total_angular_damp: +.. _class_Physics2DDirectBodyState_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -170,7 +170,7 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. - .. _class_Physics2DDirectBodyState_total_gravity: +.. _class_Physics2DDirectBodyState_total_gravity: - :ref:`Vector2` **total_gravity** @@ -180,7 +180,7 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. - .. _class_Physics2DDirectBodyState_total_linear_damp: +.. _class_Physics2DDirectBodyState_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -190,7 +190,7 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. - .. _class_Physics2DDirectBodyState_transform: +.. _class_Physics2DDirectBodyState_transform: - :ref:`Transform2D` **transform** @@ -205,103 +205,103 @@ The transformation matrix of the body. Method Descriptions ------------------- - .. _class_Physics2DDirectBodyState_add_central_force: +.. _class_Physics2DDirectBodyState_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** - .. _class_Physics2DDirectBodyState_add_force: +.. _class_Physics2DDirectBodyState_add_force: - void **add_force** **(** :ref:`Vector2` offset, :ref:`Vector2` force **)** - .. _class_Physics2DDirectBodyState_add_torque: +.. _class_Physics2DDirectBodyState_add_torque: - void **add_torque** **(** :ref:`float` torque **)** - .. _class_Physics2DDirectBodyState_apply_central_impulse: +.. _class_Physics2DDirectBodyState_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** - .. _class_Physics2DDirectBodyState_apply_impulse: +.. _class_Physics2DDirectBodyState_apply_impulse: - void **apply_impulse** **(** :ref:`Vector2` offset, :ref:`Vector2` impulse **)** - .. _class_Physics2DDirectBodyState_apply_torque_impulse: +.. _class_Physics2DDirectBodyState_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` impulse **)** - .. _class_Physics2DDirectBodyState_get_contact_collider: +.. _class_Physics2DDirectBodyState_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const Return the :ref:`RID` of the collider. - .. _class_Physics2DDirectBodyState_get_contact_collider_id: +.. _class_Physics2DDirectBodyState_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const Return the object id of the collider. - .. _class_Physics2DDirectBodyState_get_contact_collider_object: +.. _class_Physics2DDirectBodyState_get_contact_collider_object: - :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: +.. _class_Physics2DDirectBodyState_get_contact_collider_position: - :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Return the contact position in the collider. - .. _class_Physics2DDirectBodyState_get_contact_collider_shape: +.. _class_Physics2DDirectBodyState_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const Return the collider shape index. - .. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata: +.. _class_Physics2DDirectBodyState_get_contact_collider_shape_metadata: - :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: +.. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: - :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Return the linear velocity vector at contact point of the collider. - .. _class_Physics2DDirectBodyState_get_contact_count: +.. _class_Physics2DDirectBodyState_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. - .. _class_Physics2DDirectBodyState_get_contact_local_normal: +.. _class_Physics2DDirectBodyState_get_contact_local_normal: - :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: +.. _class_Physics2DDirectBodyState_get_contact_local_position: - :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Return the local position (of this body) of the contact point. - .. _class_Physics2DDirectBodyState_get_contact_local_shape: +.. _class_Physics2DDirectBodyState_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const Return the local shape index of the collision. - .. _class_Physics2DDirectBodyState_get_space_state: +.. _class_Physics2DDirectBodyState_get_space_state: - :ref:`Physics2DDirectSpaceState` **get_space_state** **(** **)** Return the current state of space, useful for queries. - .. _class_Physics2DDirectBodyState_integrate_forces: +.. _class_Physics2DDirectBodyState_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index fea0eb38b..d4a5eebcf 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -42,10 +42,11 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` + Method Descriptions ------------------- - .. _class_Physics2DDirectSpaceState_cast_motion: +.. _class_Physics2DDirectSpaceState_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -53,13 +54,13 @@ Checks how far the shape can travel toward a point. Note that both the shape and If the shape can not move, the array will be empty. - .. _class_Physics2DDirectSpaceState_collide_shape: +.. _class_Physics2DDirectSpaceState_collide_shape: - :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. - .. _class_Physics2DDirectSpaceState_get_rest_info: +.. _class_Physics2DDirectSpaceState_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters` shape **)** @@ -81,7 +82,7 @@ Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryPa If the shape did not intersect anything, then an empty dictionary is returned instead. - .. _class_Physics2DDirectSpaceState_intersect_point: +.. _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:`bool` collide_with_bodies=true, :ref:`bool` collide_with_areas=false **)** @@ -99,7 +100,7 @@ Checks whether a point is inside any shape. The shapes the point is inside of ar 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: +.. _class_Physics2DDirectSpaceState_intersect_ray: - :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 **)** @@ -123,7 +124,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst 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: +.. _class_Physics2DDirectSpaceState_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index e754b89f1..0b128be9f 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -222,7 +222,7 @@ Methods Enumerations ------------ - .. _enum_Physics2DServer_CCDMode: +.. _enum_Physics2DServer_CCDMode: enum **CCDMode**: @@ -230,7 +230,7 @@ enum **CCDMode**: - **CCD_MODE_CAST_RAY** = **1** --- Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. - **CCD_MODE_CAST_SHAPE** = **2** --- Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. - .. _enum_Physics2DServer_BodyState: +.. _enum_Physics2DServer_BodyState: enum **BodyState**: @@ -240,7 +240,7 @@ enum **BodyState**: - **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. - .. _enum_Physics2DServer_ProcessInfo: +.. _enum_Physics2DServer_ProcessInfo: enum **ProcessInfo**: @@ -248,7 +248,7 @@ enum **ProcessInfo**: - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. - **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. - .. _enum_Physics2DServer_JointParam: +.. _enum_Physics2DServer_JointParam: enum **JointParam**: @@ -256,7 +256,7 @@ enum **JointParam**: - **JOINT_PARAM_MAX_BIAS** = **1** - **JOINT_PARAM_MAX_FORCE** = **2** - .. _enum_Physics2DServer_ShapeType: +.. _enum_Physics2DServer_ShapeType: enum **ShapeType**: @@ -270,7 +270,7 @@ enum **ShapeType**: - **SHAPE_CONCAVE_POLYGON** = **7** --- This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. - **SHAPE_CUSTOM** = **8** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. - .. _enum_Physics2DServer_AreaParameter: +.. _enum_Physics2DServer_AreaParameter: enum **AreaParameter**: @@ -283,14 +283,14 @@ enum **AreaParameter**: - **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. - .. _enum_Physics2DServer_AreaBodyStatus: +.. _enum_Physics2DServer_AreaBodyStatus: enum **AreaBodyStatus**: - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. - .. _enum_Physics2DServer_BodyParameter: +.. _enum_Physics2DServer_BodyParameter: enum **BodyParameter**: @@ -303,7 +303,7 @@ enum **BodyParameter**: - **BODY_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get a body's angular dampening factor. - **BODY_PARAM_MAX** = **7** --- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. - .. _enum_Physics2DServer_BodyMode: +.. _enum_Physics2DServer_BodyMode: enum **BodyMode**: @@ -312,7 +312,7 @@ enum **BodyMode**: - **BODY_MODE_RIGID** = **2** --- Constant for rigid bodies. - **BODY_MODE_CHARACTER** = **3** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. - .. _enum_Physics2DServer_DampedStringParam: +.. _enum_Physics2DServer_DampedStringParam: enum **DampedStringParam**: @@ -320,7 +320,7 @@ enum **DampedStringParam**: - **DAMPED_STRING_STIFFNESS** = **1** --- Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. - **DAMPED_STRING_DAMPING** = **2** --- Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). - .. _enum_Physics2DServer_SpaceParameter: +.. _enum_Physics2DServer_SpaceParameter: enum **SpaceParameter**: @@ -332,7 +332,7 @@ enum **SpaceParameter**: - **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. - .. _enum_Physics2DServer_AreaSpaceOverrideMode: +.. _enum_Physics2DServer_AreaSpaceOverrideMode: enum **AreaSpaceOverrideMode**: @@ -342,7 +342,7 @@ enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - .. _enum_Physics2DServer_JointType: +.. _enum_Physics2DServer_JointType: enum **JointType**: @@ -358,101 +358,101 @@ Physics 2D Server is the server responsible for all 2D physics. It can create ma Method Descriptions ------------------- - .. _class_Physics2DServer_area_add_shape: +.. _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 ) **)** 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: +.. _class_Physics2DServer_area_attach_object_instance_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. - .. _class_Physics2DServer_area_clear_shapes: +.. _class_Physics2DServer_area_clear_shapes: - 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: +.. _class_Physics2DServer_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area2D`. - .. _class_Physics2DServer_area_get_object_instance_id: +.. _class_Physics2DServer_area_get_object_instance_id: - :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: +.. _class_Physics2DServer_area_get_param: - :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: +.. _class_Physics2DServer_area_get_shape: - :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. - .. _class_Physics2DServer_area_get_shape_count: +.. _class_Physics2DServer_area_get_shape_count: - :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: +.. _class_Physics2DServer_area_get_shape_transform: - :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: +.. _class_Physics2DServer_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. - .. _class_Physics2DServer_area_get_space_override_mode: +.. _class_Physics2DServer_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. - .. _class_Physics2DServer_area_get_transform: +.. _class_Physics2DServer_area_get_transform: - :ref:`Transform2D` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. - .. _class_Physics2DServer_area_remove_shape: +.. _class_Physics2DServer_area_remove_shape: - 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: +.. _class_Physics2DServer_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** - .. _class_Physics2DServer_area_set_collision_layer: +.. _class_Physics2DServer_area_set_collision_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: +.. _class_Physics2DServer_area_set_collision_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: +.. _class_Physics2DServer_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -468,231 +468,231 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. - .. _class_Physics2DServer_area_set_monitorable: +.. _class_Physics2DServer_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** - .. _class_Physics2DServer_area_set_param: +.. _class_Physics2DServer_area_set_param: - 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: +.. _class_Physics2DServer_area_set_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`. - .. _class_Physics2DServer_area_set_shape_disabled: +.. _class_Physics2DServer_area_set_shape_disabled: - 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: +.. _class_Physics2DServer_area_set_shape_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: +.. _class_Physics2DServer_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. - .. _class_Physics2DServer_area_set_space_override_mode: +.. _class_Physics2DServer_area_set_space_override_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: +.. _class_Physics2DServer_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** Sets the transform matrix for an area. - .. _class_Physics2DServer_body_add_central_force: +.. _class_Physics2DServer_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** - .. _class_Physics2DServer_body_add_collision_exception: +.. _class_Physics2DServer_body_add_collision_exception: - 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: +.. _class_Physics2DServer_body_add_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: +.. _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 ) **)** 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: +.. _class_Physics2DServer_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`float` torque **)** - .. _class_Physics2DServer_body_apply_central_impulse: +.. _class_Physics2DServer_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** - .. _class_Physics2DServer_body_apply_impulse: +.. _class_Physics2DServer_body_apply_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: +.. _class_Physics2DServer_body_apply_torque_impulse: - void **body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** - .. _class_Physics2DServer_body_attach_object_instance_id: +.. _class_Physics2DServer_body_attach_object_instance_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. - .. _class_Physics2DServer_body_clear_shapes: +.. _class_Physics2DServer_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. - .. _class_Physics2DServer_body_create: +.. _class_Physics2DServer_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: +.. _class_Physics2DServer_body_get_collision_layer: - :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: +.. _class_Physics2DServer_body_get_collision_mask: - :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: +.. _class_Physics2DServer_body_get_continuous_collision_detection_mode: - :ref:`CCDMode` **body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** const Returns the continuous collision detection mode. - .. _class_Physics2DServer_body_get_direct_state: +.. _class_Physics2DServer_body_get_direct_state: - :ref:`Physics2DDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`Physics2DDirectBodyState` of the body. - .. _class_Physics2DServer_body_get_max_contacts_reported: +.. _class_Physics2DServer_body_get_max_contacts_reported: - :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: +.. _class_Physics2DServer_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. - .. _class_Physics2DServer_body_get_object_instance_id: +.. _class_Physics2DServer_body_get_object_instance_id: - :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: +.. _class_Physics2DServer_body_get_param: - :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: +.. _class_Physics2DServer_body_get_shape: - :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. - .. _class_Physics2DServer_body_get_shape_count: +.. _class_Physics2DServer_body_get_shape_count: - :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: +.. _class_Physics2DServer_body_get_shape_metadata: - :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: +.. _class_Physics2DServer_body_get_shape_transform: - :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: +.. _class_Physics2DServer_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. - .. _class_Physics2DServer_body_get_state: +.. _class_Physics2DServer_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. - .. _class_Physics2DServer_body_is_omitting_force_integration: +.. _class_Physics2DServer_body_is_omitting_force_integration: - :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: +.. _class_Physics2DServer_body_remove_collision_exception: - 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: +.. _class_Physics2DServer_body_remove_shape: - 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: +.. _class_Physics2DServer_body_set_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: +.. _class_Physics2DServer_body_set_collision_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: +.. _class_Physics2DServer_body_set_collision_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: +.. _class_Physics2DServer_body_set_continuous_collision_detection_mode: - void **body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** @@ -700,231 +700,231 @@ Sets the continuous collision detection mode from any of the CCD_MODE\_\* consta Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - .. _class_Physics2DServer_body_set_force_integration_callback: +.. _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 **)** 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: +.. _class_Physics2DServer_body_set_max_contacts_reported: - 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: +.. _class_Physics2DServer_body_set_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: +.. _class_Physics2DServer_body_set_omit_force_integration: - 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: +.. _class_Physics2DServer_body_set_param: - 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: +.. _class_Physics2DServer_body_set_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`. - .. _class_Physics2DServer_body_set_shape_as_one_way_collision: +.. _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 **)** Enables one way collision on body if ``enable`` is ``true``. - .. _class_Physics2DServer_body_set_shape_disabled: +.. _class_Physics2DServer_body_set_shape_disabled: - 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: +.. _class_Physics2DServer_body_set_shape_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: +.. _class_Physics2DServer_body_set_shape_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: +.. _class_Physics2DServer_body_set_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: +.. _class_Physics2DServer_body_set_state: - 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: +.. _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 **)** 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: +.. _class_Physics2DServer_capsule_shape_create: - :ref:`RID` **capsule_shape_create** **(** **)** - .. _class_Physics2DServer_circle_shape_create: +.. _class_Physics2DServer_circle_shape_create: - :ref:`RID` **circle_shape_create** **(** **)** - .. _class_Physics2DServer_concave_polygon_shape_create: +.. _class_Physics2DServer_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** - .. _class_Physics2DServer_convex_polygon_shape_create: +.. _class_Physics2DServer_convex_polygon_shape_create: - :ref:`RID` **convex_polygon_shape_create** **(** **)** - .. _class_Physics2DServer_damped_spring_joint_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 **)** 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: +.. _class_Physics2DServer_damped_string_joint_get_param: - :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: +.. _class_Physics2DServer_damped_string_joint_set_param: - 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: +.. _class_Physics2DServer_free_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. - .. _class_Physics2DServer_get_process_info: +.. _class_Physics2DServer_get_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: +.. _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 **)** Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. - .. _class_Physics2DServer_joint_get_param: +.. _class_Physics2DServer_joint_get_param: - :ref:`float` **joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** const Returns the value of a joint parameter. - .. _class_Physics2DServer_joint_get_type: +.. _class_Physics2DServer_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of a joint (see JOINT\_\* constants). - .. _class_Physics2DServer_joint_set_param: +.. _class_Physics2DServer_joint_set_param: - 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: +.. _class_Physics2DServer_line_shape_create: - :ref:`RID` **line_shape_create** **(** **)** - .. _class_Physics2DServer_pin_joint_create: +.. _class_Physics2DServer_pin_joint_create: - :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: +.. _class_Physics2DServer_ray_shape_create: - :ref:`RID` **ray_shape_create** **(** **)** - .. _class_Physics2DServer_rectangle_shape_create: +.. _class_Physics2DServer_rectangle_shape_create: - :ref:`RID` **rectangle_shape_create** **(** **)** - .. _class_Physics2DServer_segment_shape_create: +.. _class_Physics2DServer_segment_shape_create: - :ref:`RID` **segment_shape_create** **(** **)** - .. _class_Physics2DServer_set_active: +.. _class_Physics2DServer_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 2D physics engine. - .. _class_Physics2DServer_shape_get_data: +.. _class_Physics2DServer_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. - .. _class_Physics2DServer_shape_get_type: +.. _class_Physics2DServer_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). - .. _class_Physics2DServer_shape_set_data: +.. _class_Physics2DServer_shape_set_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: +.. _class_Physics2DServer_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: +.. _class_Physics2DServer_space_get_direct_state: - :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. - .. _class_Physics2DServer_space_get_param: +.. _class_Physics2DServer_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. - .. _class_Physics2DServer_space_is_active: +.. _class_Physics2DServer_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. - .. _class_Physics2DServer_space_set_active: +.. _class_Physics2DServer_space_set_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: +.. _class_Physics2DServer_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index e99aa69eb..6b7c349e2 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -52,7 +52,7 @@ This class contains the shape and other parameters for intersection/collision qu Property Descriptions --------------------- - .. _class_Physics2DShapeQueryParameters_collide_with_areas: +.. _class_Physics2DShapeQueryParameters_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -62,7 +62,7 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ - .. _class_Physics2DShapeQueryParameters_collide_with_bodies: +.. _class_Physics2DShapeQueryParameters_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -72,7 +72,7 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ - .. _class_Physics2DShapeQueryParameters_collision_layer: +.. _class_Physics2DShapeQueryParameters_collision_layer: - :ref:`int` **collision_layer** @@ -84,7 +84,7 @@ Property Descriptions The physics layer the query should be made on. - .. _class_Physics2DShapeQueryParameters_exclude: +.. _class_Physics2DShapeQueryParameters_exclude: - :ref:`Array` **exclude** @@ -96,7 +96,7 @@ The physics layer the query should be made on. The list of objects or object :ref:`RID`\ s, that will be excluded from collisions. - .. _class_Physics2DShapeQueryParameters_margin: +.. _class_Physics2DShapeQueryParameters_margin: - :ref:`float` **margin** @@ -108,7 +108,7 @@ The list of objects or object :ref:`RID`\ s, that will be excluded fr The collision margin for the shape. - .. _class_Physics2DShapeQueryParameters_motion: +.. _class_Physics2DShapeQueryParameters_motion: - :ref:`Vector2` **motion** @@ -120,7 +120,7 @@ The collision margin for the shape. The motion of the shape being queried for. - .. _class_Physics2DShapeQueryParameters_shape_rid: +.. _class_Physics2DShapeQueryParameters_shape_rid: - :ref:`RID` **shape_rid** @@ -132,7 +132,7 @@ The motion of the shape being queried for. The :ref:`RID` of the queried shape. See :ref:`set_shape` also. - .. _class_Physics2DShapeQueryParameters_transform: +.. _class_Physics2DShapeQueryParameters_transform: - :ref:`Transform2D` **transform** @@ -147,7 +147,7 @@ the transform matrix of the queried shape. Method Descriptions ------------------- - .. _class_Physics2DShapeQueryParameters_set_shape: +.. _class_Physics2DShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index bb3d91945..f642ce5d7 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -34,23 +34,23 @@ Methods Method Descriptions ------------------- - .. _class_Physics2DShapeQueryResult_get_result_count: +.. _class_Physics2DShapeQueryResult_get_result_count: - :ref:`int` **get_result_count** **(** **)** const - .. _class_Physics2DShapeQueryResult_get_result_object: +.. _class_Physics2DShapeQueryResult_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const - .. _class_Physics2DShapeQueryResult_get_result_object_id: +.. _class_Physics2DShapeQueryResult_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const - .. _class_Physics2DShapeQueryResult_get_result_object_shape: +.. _class_Physics2DShapeQueryResult_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const - .. _class_Physics2DShapeQueryResult_get_result_rid: +.. _class_Physics2DShapeQueryResult_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index 742c39c1e..7fe0ade0f 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -42,7 +42,7 @@ Properties Property Descriptions --------------------- - .. _class_Physics2DTestMotionResult_collider: +.. _class_Physics2DTestMotionResult_collider: - :ref:`Object` **collider** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_collider() | +----------+----------------+ - .. _class_Physics2DTestMotionResult_collider_id: +.. _class_Physics2DTestMotionResult_collider_id: - :ref:`int` **collider_id** @@ -58,7 +58,7 @@ Property Descriptions | *Getter* | get_collider_id() | +----------+-------------------+ - .. _class_Physics2DTestMotionResult_collider_rid: +.. _class_Physics2DTestMotionResult_collider_rid: - :ref:`RID` **collider_rid** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_collider_rid() | +----------+--------------------+ - .. _class_Physics2DTestMotionResult_collider_shape: +.. _class_Physics2DTestMotionResult_collider_shape: - :ref:`int` **collider_shape** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_collider_shape() | +----------+----------------------+ - .. _class_Physics2DTestMotionResult_collider_velocity: +.. _class_Physics2DTestMotionResult_collider_velocity: - :ref:`Vector2` **collider_velocity** @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | get_collider_velocity() | +----------+-------------------------+ - .. _class_Physics2DTestMotionResult_collision_normal: +.. _class_Physics2DTestMotionResult_collision_normal: - :ref:`Vector2` **collision_normal** @@ -90,7 +90,7 @@ Property Descriptions | *Getter* | get_collision_normal() | +----------+------------------------+ - .. _class_Physics2DTestMotionResult_collision_point: +.. _class_Physics2DTestMotionResult_collision_point: - :ref:`Vector2` **collision_point** @@ -98,7 +98,7 @@ Property Descriptions | *Getter* | get_collision_point() | +----------+-----------------------+ - .. _class_Physics2DTestMotionResult_motion: +.. _class_Physics2DTestMotionResult_motion: - :ref:`Vector2` **motion** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | get_motion() | +----------+--------------+ - .. _class_Physics2DTestMotionResult_motion_remainder: +.. _class_Physics2DTestMotionResult_motion_remainder: - :ref:`Vector2` **motion_remainder** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 1a337f750..81c085830 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -53,10 +53,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_PhysicsBody_collision_layer: +.. _class_PhysicsBody_collision_layer: - :ref:`int` **collision_layer** @@ -72,7 +73,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_PhysicsBody_collision_mask: +.. _class_PhysicsBody_collision_mask: - :ref:`int` **collision_mask** @@ -87,37 +88,37 @@ The physics layers this area scans for collisions. Method Descriptions ------------------- - .. _class_PhysicsBody_add_collision_exception_with: +.. _class_PhysicsBody_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. - .. _class_PhysicsBody_get_collision_layer_bit: +.. _class_PhysicsBody_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_PhysicsBody_get_collision_mask_bit: +.. _class_PhysicsBody_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_PhysicsBody_remove_collision_exception_with: +.. _class_PhysicsBody_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. - .. _class_PhysicsBody_set_collision_layer_bit: +.. _class_PhysicsBody_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - .. _class_PhysicsBody_set_collision_mask_bit: +.. _class_PhysicsBody_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index f788efd88..b9d1202ba 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -55,10 +55,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_PhysicsBody2D_collision_layer: +.. _class_PhysicsBody2D_collision_layer: - :ref:`int` **collision_layer** @@ -74,7 +75,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_PhysicsBody2D_collision_mask: +.. _class_PhysicsBody2D_collision_mask: - :ref:`int` **collision_mask** @@ -86,7 +87,7 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this area scans for collisions. - .. _class_PhysicsBody2D_layers: +.. _class_PhysicsBody2D_layers: - :ref:`int` **layers** @@ -95,37 +96,37 @@ Both :ref:`collision_layer` and :ref:`colli Method Descriptions ------------------- - .. _class_PhysicsBody2D_add_collision_exception_with: +.. _class_PhysicsBody2D_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. - .. _class_PhysicsBody2D_get_collision_layer_bit: +.. _class_PhysicsBody2D_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_PhysicsBody2D_get_collision_mask_bit: +.. _class_PhysicsBody2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_PhysicsBody2D_remove_collision_exception_with: +.. _class_PhysicsBody2D_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. - .. _class_PhysicsBody2D_set_collision_layer_bit: +.. _class_PhysicsBody2D_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - .. _class_PhysicsBody2D_set_collision_mask_bit: +.. _class_PhysicsBody2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index a7ee229ab..108327f64 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -93,7 +93,7 @@ Methods Property Descriptions --------------------- - .. _class_PhysicsDirectBodyState_angular_velocity: +.. _class_PhysicsDirectBodyState_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -105,7 +105,7 @@ Property Descriptions The angular velocity of the body. - .. _class_PhysicsDirectBodyState_center_of_mass: +.. _class_PhysicsDirectBodyState_center_of_mass: - :ref:`Vector3` **center_of_mass** @@ -113,7 +113,7 @@ The angular velocity of the body. | *Getter* | get_center_of_mass() | +----------+----------------------+ - .. _class_PhysicsDirectBodyState_inverse_inertia: +.. _class_PhysicsDirectBodyState_inverse_inertia: - :ref:`Vector3` **inverse_inertia** @@ -123,7 +123,7 @@ The angular velocity of the body. The inverse of the inertia of the body. - .. _class_PhysicsDirectBodyState_inverse_mass: +.. _class_PhysicsDirectBodyState_inverse_mass: - :ref:`float` **inverse_mass** @@ -133,7 +133,7 @@ The inverse of the inertia of the body. The inverse of the mass of the body. - .. _class_PhysicsDirectBodyState_linear_velocity: +.. _class_PhysicsDirectBodyState_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -145,7 +145,7 @@ The inverse of the mass of the body. The linear velocity of the body. - .. _class_PhysicsDirectBodyState_principal_inertia_axes: +.. _class_PhysicsDirectBodyState_principal_inertia_axes: - :ref:`Basis` **principal_inertia_axes** @@ -153,7 +153,7 @@ The linear velocity of the body. | *Getter* | get_principal_inertia_axes() | +----------+------------------------------+ - .. _class_PhysicsDirectBodyState_sleeping: +.. _class_PhysicsDirectBodyState_sleeping: - :ref:`bool` **sleeping** @@ -165,7 +165,7 @@ The linear velocity of the body. ``true`` if this body is currently sleeping (not active). - .. _class_PhysicsDirectBodyState_step: +.. _class_PhysicsDirectBodyState_step: - :ref:`float` **step** @@ -175,7 +175,7 @@ The linear velocity of the body. The timestep (delta) used for the simulation. - .. _class_PhysicsDirectBodyState_total_angular_damp: +.. _class_PhysicsDirectBodyState_total_angular_damp: - :ref:`float` **total_angular_damp** @@ -185,7 +185,7 @@ The timestep (delta) used for the simulation. The rate at which the body stops rotating, if there are not any other forces moving it. - .. _class_PhysicsDirectBodyState_total_gravity: +.. _class_PhysicsDirectBodyState_total_gravity: - :ref:`Vector3` **total_gravity** @@ -195,7 +195,7 @@ The rate at which the body stops rotating, if there are not any other forces mov The total gravity vector being currently applied to this body. - .. _class_PhysicsDirectBodyState_total_linear_damp: +.. _class_PhysicsDirectBodyState_total_linear_damp: - :ref:`float` **total_linear_damp** @@ -205,7 +205,7 @@ The total gravity vector being currently applied to this body. The rate at which the body stops moving, if there are not any other forces moving it. - .. _class_PhysicsDirectBodyState_transform: +.. _class_PhysicsDirectBodyState_transform: - :ref:`Transform` **transform** @@ -220,7 +220,7 @@ The transformation matrix of the body. Method Descriptions ------------------- - .. _class_PhysicsDirectBodyState_add_central_force: +.. _class_PhysicsDirectBodyState_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -228,19 +228,19 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. - .. _class_PhysicsDirectBodyState_add_force: +.. _class_PhysicsDirectBodyState_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). - .. _class_PhysicsDirectBodyState_add_torque: +.. _class_PhysicsDirectBodyState_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force (i.e. a motor) without affecting position. - .. _class_PhysicsDirectBodyState_apply_central_impulse: +.. _class_PhysicsDirectBodyState_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` j **)** @@ -248,69 +248,69 @@ Applies a single directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. - .. _class_PhysicsDirectBodyState_apply_impulse: +.. _class_PhysicsDirectBodyState_apply_impulse: - 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: +.. _class_PhysicsDirectBodyState_apply_torque_impulse: - 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: +.. _class_PhysicsDirectBodyState_get_contact_collider: - :ref:`RID` **get_contact_collider** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_collider_id: +.. _class_PhysicsDirectBodyState_get_contact_collider_id: - :ref:`int` **get_contact_collider_id** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_collider_object: +.. _class_PhysicsDirectBodyState_get_contact_collider_object: - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_collider_position: +.. _class_PhysicsDirectBodyState_get_contact_collider_position: - :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_collider_shape: +.. _class_PhysicsDirectBodyState_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: +.. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: - :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_count: +.. _class_PhysicsDirectBodyState_get_contact_count: - :ref:`int` **get_contact_count** **(** **)** const - .. _class_PhysicsDirectBodyState_get_contact_impulse: +.. _class_PhysicsDirectBodyState_get_contact_impulse: - :ref:`float` **get_contact_impulse** **(** :ref:`int` contact_idx **)** const Impulse created by the contact. Only implemented for Bullet physics. - .. _class_PhysicsDirectBodyState_get_contact_local_normal: +.. _class_PhysicsDirectBodyState_get_contact_local_normal: - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_local_position: +.. _class_PhysicsDirectBodyState_get_contact_local_position: - :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_contact_local_shape: +.. _class_PhysicsDirectBodyState_get_contact_local_shape: - :ref:`int` **get_contact_local_shape** **(** :ref:`int` contact_idx **)** const - .. _class_PhysicsDirectBodyState_get_space_state: +.. _class_PhysicsDirectBodyState_get_space_state: - :ref:`PhysicsDirectSpaceState` **get_space_state** **(** **)** - .. _class_PhysicsDirectBodyState_integrate_forces: +.. _class_PhysicsDirectBodyState_integrate_forces: - void **integrate_forces** **(** **)** diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 0672a4ab7..115900f45 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -40,10 +40,11 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` + Method Descriptions ------------------- - .. _class_PhysicsDirectSpaceState_cast_motion: +.. _class_PhysicsDirectSpaceState_cast_motion: - :ref:`Array` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`Vector3` motion **)** @@ -51,13 +52,13 @@ Checks whether the shape can travel to a point. The method will return an array If the shape can not move, the array will be empty. - .. _class_PhysicsDirectSpaceState_collide_shape: +.. _class_PhysicsDirectSpaceState_collide_shape: - :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. - .. _class_PhysicsDirectSpaceState_get_rest_info: +.. _class_PhysicsDirectSpaceState_get_rest_info: - :ref:`Dictionary` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters` shape **)** @@ -77,7 +78,7 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara If the shape did not intersect anything, then an empty dictionary is returned instead. - .. _class_PhysicsDirectSpaceState_intersect_ray: +.. _class_PhysicsDirectSpaceState_intersect_ray: - :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 **)** @@ -99,7 +100,7 @@ If the ray did not intersect anything, then an empty dictionary is returned inst 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: +.. _class_PhysicsDirectSpaceState_intersect_shape: - :ref:`Array` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** diff --git a/classes/class_physicsmaterial.rst b/classes/class_physicsmaterial.rst index 977150482..3db1d1a58 100644 --- a/classes/class_physicsmaterial.rst +++ b/classes/class_physicsmaterial.rst @@ -37,7 +37,7 @@ Provides a means of modifying the collision properties of a :ref:`PhysicsBody` **absorbent** @@ -47,7 +47,7 @@ Property Descriptions | *Getter* | is_absorbent() | +----------+----------------------+ - .. _class_PhysicsMaterial_bounce: +.. _class_PhysicsMaterial_bounce: - :ref:`float` **bounce** @@ -59,7 +59,7 @@ Property Descriptions The body's bounciness. Default value: ``0``. - .. _class_PhysicsMaterial_friction: +.. _class_PhysicsMaterial_friction: - :ref:`float` **friction** @@ -71,7 +71,7 @@ The body's bounciness. Default value: ``0``. The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. - .. _class_PhysicsMaterial_rough: +.. _class_PhysicsMaterial_rough: - :ref:`bool` **rough** diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 9d4fa12ea..e04c5921b 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -248,7 +248,7 @@ Methods Enumerations ------------ - .. _enum_PhysicsServer_BodyState: +.. _enum_PhysicsServer_BodyState: enum **BodyState**: @@ -258,7 +258,7 @@ enum **BodyState**: - **BODY_STATE_SLEEPING** = **3** --- Constant to sleep/wake up a body, or to get whether it is sleeping. - **BODY_STATE_CAN_SLEEP** = **4** --- Constant to set/get whether the body can sleep. - .. _enum_PhysicsServer_G6DOFJointAxisParam: +.. _enum_PhysicsServer_G6DOFJointAxisParam: enum **G6DOFJointAxisParam**: @@ -279,7 +279,7 @@ enum **G6DOFJointAxisParam**: - **G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY** = **14** --- Target speed for the motor at the axes. - **G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT** = **15** --- Maximum acceleration for the motor at the axes. - .. _enum_PhysicsServer_ProcessInfo: +.. _enum_PhysicsServer_ProcessInfo: enum **ProcessInfo**: @@ -287,7 +287,7 @@ enum **ProcessInfo**: - **INFO_COLLISION_PAIRS** = **1** --- Constant to get the number of possible collisions. - **INFO_ISLAND_COUNT** = **2** --- Constant to get the number of space regions where a collision could occur. - .. _enum_PhysicsServer_ShapeType: +.. _enum_PhysicsServer_ShapeType: enum **ShapeType**: @@ -302,14 +302,14 @@ enum **ShapeType**: - **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: +.. _enum_PhysicsServer_HingeJointFlag: enum **HingeJointFlag**: - **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true`` the Hinge has a maximum and a minimum rotation. - **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true`` a motor turns the Hinge - .. _enum_PhysicsServer_AreaParameter: +.. _enum_PhysicsServer_AreaParameter: enum **AreaParameter**: @@ -322,7 +322,7 @@ enum **AreaParameter**: - **AREA_PARAM_ANGULAR_DAMP** = **6** --- Constant to set/get the angular dampening factor of an area. - **AREA_PARAM_PRIORITY** = **7** --- Constant to set/get the priority (order of processing) of an area. - .. _enum_PhysicsServer_PinJointParam: +.. _enum_PhysicsServer_PinJointParam: enum **PinJointParam**: @@ -334,7 +334,7 @@ The higher, the stronger. The higher, the stronger. - **PIN_JOINT_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends. - .. _enum_PhysicsServer_BodyParameter: +.. _enum_PhysicsServer_BodyParameter: enum **BodyParameter**: @@ -346,7 +346,7 @@ enum **BodyParameter**: - **BODY_PARAM_ANGULAR_DAMP** = **5** --- Constant to set/get a body's angular dampening factor. - **BODY_PARAM_MAX** = **6** --- This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. - .. _enum_PhysicsServer_BodyMode: +.. _enum_PhysicsServer_BodyMode: enum **BodyMode**: @@ -356,7 +356,7 @@ enum **BodyMode**: - **BODY_MODE_SOFT** = **3** - **BODY_MODE_CHARACTER** = **4** --- Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. - .. _enum_PhysicsServer_SpaceParameter: +.. _enum_PhysicsServer_SpaceParameter: enum **SpaceParameter**: @@ -369,14 +369,14 @@ enum **SpaceParameter**: - **SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO** = **6** - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **7** --- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. - .. _enum_PhysicsServer_AreaBodyStatus: +.. _enum_PhysicsServer_AreaBodyStatus: enum **AreaBodyStatus**: - **AREA_BODY_ADDED** = **0** --- The value of the first parameter and area callback function receives, when an object enters one of its shapes. - **AREA_BODY_REMOVED** = **1** --- The value of the first parameter and area callback function receives, when an object exits one of its shapes. - .. _enum_PhysicsServer_BodyAxis: +.. _enum_PhysicsServer_BodyAxis: enum **BodyAxis**: @@ -387,7 +387,7 @@ enum **BodyAxis**: - **BODY_AXIS_ANGULAR_Y** = **16** - **BODY_AXIS_ANGULAR_Z** = **32** - .. _enum_PhysicsServer_JointType: +.. _enum_PhysicsServer_JointType: enum **JointType**: @@ -397,7 +397,7 @@ enum **JointType**: - **JOINT_CONE_TWIST** = **3** --- The :ref:`Joint` is a :ref:`ConeTwistJoint`. - **JOINT_6DOF** = **4** --- The :ref:`Joint` is a :ref:`Generic6DOFJoint`. - .. _enum_PhysicsServer_AreaSpaceOverrideMode: +.. _enum_PhysicsServer_AreaSpaceOverrideMode: enum **AreaSpaceOverrideMode**: @@ -407,7 +407,7 @@ enum **AreaSpaceOverrideMode**: - **AREA_SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. - **AREA_SPACE_OVERRIDE_REPLACE_COMBINE** = **4** --- This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. - .. _enum_PhysicsServer_G6DOFJointAxisFlag: +.. _enum_PhysicsServer_G6DOFJointAxisFlag: enum **G6DOFJointAxisFlag**: @@ -416,7 +416,7 @@ enum **G6DOFJointAxisFlag**: - **G6DOF_JOINT_FLAG_ENABLE_MOTOR** = **2** --- If ``set`` there is a rotational motor across these axes. - **G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR** = **3** --- If ``set`` there is a linear motor on this axis that targets a specific velocity. - .. _enum_PhysicsServer_SliderJointParam: +.. _enum_PhysicsServer_SliderJointParam: enum **SliderJointParam**: @@ -444,7 +444,7 @@ enum **SliderJointParam**: - **SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING** = **21** --- The amount of damping of the rotation across axes orthogonal to the slider. - **SLIDER_JOINT_MAX** = **22** --- End flag of SLIDER_JOINT\_\* constants, used internally. - .. _enum_PhysicsServer_ConeTwistJointParam: +.. _enum_PhysicsServer_ConeTwistJointParam: enum **ConeTwistJointParam**: @@ -464,7 +464,7 @@ The higher, the faster. - **CONE_TWIST_JOINT_SOFTNESS** = **3** --- The ease with which the Joint twists, if it's too low, it takes more force to twist the joint. - **CONE_TWIST_JOINT_RELAXATION** = **4** --- Defines, how fast the swing- and twist-speed-difference on both sides gets synced. - .. _enum_PhysicsServer_HingeJointParam: +.. _enum_PhysicsServer_HingeJointParam: enum **HingeJointParam**: @@ -485,107 +485,107 @@ Everything related to physics in 3D. Method Descriptions ------------------- - .. _class_PhysicsServer_area_add_shape: +.. _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 ) **)** 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: +.. _class_PhysicsServer_area_attach_object_instance_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. - .. _class_PhysicsServer_area_clear_shapes: +.. _class_PhysicsServer_area_clear_shapes: - 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: +.. _class_PhysicsServer_area_create: - :ref:`RID` **area_create** **(** **)** Creates an :ref:`Area`. - .. _class_PhysicsServer_area_get_object_instance_id: +.. _class_PhysicsServer_area_get_object_instance_id: - :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: +.. _class_PhysicsServer_area_get_param: - :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: +.. _class_PhysicsServer_area_get_shape: - :ref:`RID` **area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of an area. - .. _class_PhysicsServer_area_get_shape_count: +.. _class_PhysicsServer_area_get_shape_count: - :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: +.. _class_PhysicsServer_area_get_shape_transform: - :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: +.. _class_PhysicsServer_area_get_space: - :ref:`RID` **area_get_space** **(** :ref:`RID` area **)** const Returns the space assigned to the area. - .. _class_PhysicsServer_area_get_space_override_mode: +.. _class_PhysicsServer_area_get_space_override_mode: - :ref:`AreaSpaceOverrideMode` **area_get_space_override_mode** **(** :ref:`RID` area **)** const Returns the space override mode for the area. - .. _class_PhysicsServer_area_get_transform: +.. _class_PhysicsServer_area_get_transform: - :ref:`Transform` **area_get_transform** **(** :ref:`RID` area **)** const Returns the transform matrix for an area. - .. _class_PhysicsServer_area_is_ray_pickable: +.. _class_PhysicsServer_area_is_ray_pickable: - :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const If ``true`` area collides with rays. - .. _class_PhysicsServer_area_remove_shape: +.. _class_PhysicsServer_area_remove_shape: - 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: +.. _class_PhysicsServer_area_set_area_monitor_callback: - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** - .. _class_PhysicsServer_area_set_collision_layer: +.. _class_PhysicsServer_area_set_collision_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: +.. _class_PhysicsServer_area_set_collision_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: +.. _class_PhysicsServer_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -601,117 +601,117 @@ Sets the function to call when any body/area enters or exits the area. This call 5: The shape index of the area where the object entered/exited. - .. _class_PhysicsServer_area_set_monitorable: +.. _class_PhysicsServer_area_set_monitorable: - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** - .. _class_PhysicsServer_area_set_param: +.. _class_PhysicsServer_area_set_param: - 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: +.. _class_PhysicsServer_area_set_ray_pickable: - void **area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** Sets object pickable with rays. - .. _class_PhysicsServer_area_set_shape: +.. _class_PhysicsServer_area_set_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`. - .. _class_PhysicsServer_area_set_shape_transform: +.. _class_PhysicsServer_area_set_shape_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: +.. _class_PhysicsServer_area_set_space: - void **area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** Assigns a space to the area. - .. _class_PhysicsServer_area_set_space_override_mode: +.. _class_PhysicsServer_area_set_space_override_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: +.. _class_PhysicsServer_area_set_transform: - void **area_set_transform** **(** :ref:`RID` area, :ref:`Transform` transform **)** Sets the transform matrix for an area. - .. _class_PhysicsServer_body_add_central_force: +.. _class_PhysicsServer_body_add_central_force: - void **body_add_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** - .. _class_PhysicsServer_body_add_collision_exception: +.. _class_PhysicsServer_body_add_collision_exception: - 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: +.. _class_PhysicsServer_body_add_force: - void **body_add_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** - .. _class_PhysicsServer_body_add_shape: +.. _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 ) **)** 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: +.. _class_PhysicsServer_body_add_torque: - void **body_add_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** - .. _class_PhysicsServer_body_apply_central_impulse: +.. _class_PhysicsServer_body_apply_central_impulse: - void **body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** - .. _class_PhysicsServer_body_apply_impulse: +.. _class_PhysicsServer_body_apply_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: +.. _class_PhysicsServer_body_apply_torque_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: +.. _class_PhysicsServer_body_attach_object_instance_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. - .. _class_PhysicsServer_body_clear_shapes: +.. _class_PhysicsServer_body_clear_shapes: - void **body_clear_shapes** **(** :ref:`RID` body **)** Removes all shapes from a body. - .. _class_PhysicsServer_body_create: +.. _class_PhysicsServer_body_create: - :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: +.. _class_PhysicsServer_body_get_collision_layer: - :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: +.. _class_PhysicsServer_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const @@ -719,93 +719,93 @@ Returns the physics layer or layers a body can collide with. - - .. _class_PhysicsServer_body_get_direct_state: +.. _class_PhysicsServer_body_get_direct_state: - :ref:`PhysicsDirectBodyState` **body_get_direct_state** **(** :ref:`RID` body **)** Returns the :ref:`PhysicsDirectBodyState` of the body. - .. _class_PhysicsServer_body_get_kinematic_safe_margin: +.. _class_PhysicsServer_body_get_kinematic_safe_margin: - :ref:`float` **body_get_kinematic_safe_margin** **(** :ref:`RID` body **)** const - .. _class_PhysicsServer_body_get_max_contacts_reported: +.. _class_PhysicsServer_body_get_max_contacts_reported: - :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: +.. _class_PhysicsServer_body_get_mode: - :ref:`BodyMode` **body_get_mode** **(** :ref:`RID` body **)** const Returns the body mode. - .. _class_PhysicsServer_body_get_object_instance_id: +.. _class_PhysicsServer_body_get_object_instance_id: - :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: +.. _class_PhysicsServer_body_get_param: - :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: +.. _class_PhysicsServer_body_get_shape: - :ref:`RID` **body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const Returns the :ref:`RID` of the nth shape of a body. - .. _class_PhysicsServer_body_get_shape_count: +.. _class_PhysicsServer_body_get_shape_count: - :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: +.. _class_PhysicsServer_body_get_shape_transform: - :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: +.. _class_PhysicsServer_body_get_space: - :ref:`RID` **body_get_space** **(** :ref:`RID` body **)** const Returns the :ref:`RID` of the space assigned to a body. - .. _class_PhysicsServer_body_get_state: +.. _class_PhysicsServer_body_get_state: - :ref:`Variant` **body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** const Returns a body state. - .. _class_PhysicsServer_body_is_axis_locked: +.. _class_PhysicsServer_body_is_axis_locked: - :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** const - .. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: +.. _class_PhysicsServer_body_is_continuous_collision_detection_enabled: - :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: +.. _class_PhysicsServer_body_is_omitting_force_integration: - :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: +.. _class_PhysicsServer_body_is_ray_pickable: - :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: +.. _class_PhysicsServer_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -813,35 +813,35 @@ Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - .. _class_PhysicsServer_body_remove_shape: +.. _class_PhysicsServer_body_remove_shape: - 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: +.. _class_PhysicsServer_body_set_axis_lock: - void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** - .. _class_PhysicsServer_body_set_axis_velocity: +.. _class_PhysicsServer_body_set_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: +.. _class_PhysicsServer_body_set_collision_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: +.. _class_PhysicsServer_body_set_collision_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: +.. _class_PhysicsServer_body_set_enable_continuous_collision_detection: - void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** @@ -849,299 +849,299 @@ If ``true`` the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - .. _class_PhysicsServer_body_set_force_integration_callback: +.. _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 **)** 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: +.. _class_PhysicsServer_body_set_kinematic_safe_margin: - void **body_set_kinematic_safe_margin** **(** :ref:`RID` body, :ref:`float` margin **)** - .. _class_PhysicsServer_body_set_max_contacts_reported: +.. _class_PhysicsServer_body_set_max_contacts_reported: - 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: +.. _class_PhysicsServer_body_set_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: +.. _class_PhysicsServer_body_set_omit_force_integration: - 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: +.. _class_PhysicsServer_body_set_param: - 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: +.. _class_PhysicsServer_body_set_ray_pickable: - 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: +.. _class_PhysicsServer_body_set_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`. - .. _class_PhysicsServer_body_set_shape_transform: +.. _class_PhysicsServer_body_set_shape_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: +.. _class_PhysicsServer_body_set_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: +.. _class_PhysicsServer_body_set_state: - 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: +.. _class_PhysicsServer_cone_twist_joint_get_param: - :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: +.. _class_PhysicsServer_cone_twist_joint_set_param: - 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: +.. _class_PhysicsServer_free_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. - .. _class_PhysicsServer_generic_6dof_joint_get_flag: +.. _class_PhysicsServer_generic_6dof_joint_get_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: +.. _class_PhysicsServer_generic_6dof_joint_get_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: +.. _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 **)** Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG\* constants). - .. _class_PhysicsServer_generic_6dof_joint_set_param: +.. _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 **)** Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT\* constants without the G6DOF_JOINT_FLAG\*). - .. _class_PhysicsServer_get_process_info: +.. _class_PhysicsServer_get_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: +.. _class_PhysicsServer_hinge_joint_get_flag: - :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: +.. _class_PhysicsServer_hinge_joint_get_param: - :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: +.. _class_PhysicsServer_hinge_joint_set_flag: - 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: +.. _class_PhysicsServer_hinge_joint_set_param: - 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: +.. _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 **)** Creates a :ref:`ConeTwistJoint`. - .. _class_PhysicsServer_joint_create_generic_6dof: +.. _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 **)** Creates a :ref:`Generic6DOFJoint`. - .. _class_PhysicsServer_joint_create_hinge: +.. _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 **)** Creates a :ref:`HingeJoint`. - .. _class_PhysicsServer_joint_create_pin: +.. _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 **)** Creates a :ref:`PinJoint`. - .. _class_PhysicsServer_joint_create_slider: +.. _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 **)** Creates a :ref:`SliderJoint`. - .. _class_PhysicsServer_joint_get_solver_priority: +.. _class_PhysicsServer_joint_get_solver_priority: - :ref:`int` **joint_get_solver_priority** **(** :ref:`RID` joint **)** const Gets the priority value of the Joint. - .. _class_PhysicsServer_joint_get_type: +.. _class_PhysicsServer_joint_get_type: - :ref:`JointType` **joint_get_type** **(** :ref:`RID` joint **)** const Returns the type of the Joint. - .. _class_PhysicsServer_joint_set_solver_priority: +.. _class_PhysicsServer_joint_set_solver_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: +.. _class_PhysicsServer_pin_joint_get_local_a: - :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: +.. _class_PhysicsServer_pin_joint_get_local_b: - :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: +.. _class_PhysicsServer_pin_joint_get_param: - :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: +.. _class_PhysicsServer_pin_joint_set_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: +.. _class_PhysicsServer_pin_joint_set_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: +.. _class_PhysicsServer_pin_joint_set_param: - void **pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** Sets a pin_joint parameter (see PIN_JOINT\* constants). - .. _class_PhysicsServer_set_active: +.. _class_PhysicsServer_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates or deactivates the 3D physics engine. - .. _class_PhysicsServer_shape_create: +.. _class_PhysicsServer_shape_create: - :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: +.. _class_PhysicsServer_shape_get_data: - :ref:`Variant` **shape_get_data** **(** :ref:`RID` shape **)** const Returns the shape data. - .. _class_PhysicsServer_shape_get_type: +.. _class_PhysicsServer_shape_get_type: - :ref:`ShapeType` **shape_get_type** **(** :ref:`RID` shape **)** const Returns the type of shape (see SHAPE\_\* constants). - .. _class_PhysicsServer_shape_set_data: +.. _class_PhysicsServer_shape_set_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: +.. _class_PhysicsServer_slider_joint_get_param: - :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: +.. _class_PhysicsServer_slider_joint_set_param: - 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: +.. _class_PhysicsServer_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: +.. _class_PhysicsServer_space_get_direct_state: - :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. - .. _class_PhysicsServer_space_get_param: +.. _class_PhysicsServer_space_get_param: - :ref:`float` **space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** const Returns the value of a space parameter. - .. _class_PhysicsServer_space_is_active: +.. _class_PhysicsServer_space_is_active: - :ref:`bool` **space_is_active** **(** :ref:`RID` space **)** const Returns whether the space is active. - .. _class_PhysicsServer_space_set_active: +.. _class_PhysicsServer_space_set_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: +.. _class_PhysicsServer_space_set_param: - void **space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 838787858..c6fa6d5fc 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -45,7 +45,7 @@ Methods Property Descriptions --------------------- - .. _class_PhysicsShapeQueryParameters_collide_with_areas: +.. _class_PhysicsShapeQueryParameters_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | is_collide_with_areas_enabled() | +----------+---------------------------------+ - .. _class_PhysicsShapeQueryParameters_collide_with_bodies: +.. _class_PhysicsShapeQueryParameters_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | is_collide_with_bodies_enabled() | +----------+----------------------------------+ - .. _class_PhysicsShapeQueryParameters_collision_mask: +.. _class_PhysicsShapeQueryParameters_collision_mask: - :ref:`int` **collision_mask** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ - .. _class_PhysicsShapeQueryParameters_exclude: +.. _class_PhysicsShapeQueryParameters_exclude: - :ref:`Array` **exclude** @@ -85,7 +85,7 @@ Property Descriptions | *Getter* | get_exclude() | +----------+--------------------+ - .. _class_PhysicsShapeQueryParameters_margin: +.. _class_PhysicsShapeQueryParameters_margin: - :ref:`float` **margin** @@ -95,7 +95,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ - .. _class_PhysicsShapeQueryParameters_shape_rid: +.. _class_PhysicsShapeQueryParameters_shape_rid: - :ref:`RID` **shape_rid** @@ -105,7 +105,7 @@ Property Descriptions | *Getter* | get_shape_rid() | +----------+----------------------+ - .. _class_PhysicsShapeQueryParameters_transform: +.. _class_PhysicsShapeQueryParameters_transform: - :ref:`Transform` **transform** @@ -118,7 +118,7 @@ Property Descriptions Method Descriptions ------------------- - .. _class_PhysicsShapeQueryParameters_set_shape: +.. _class_PhysicsShapeQueryParameters_set_shape: - void **set_shape** **(** :ref:`Resource` shape **)** diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 9388afc6b..2d15ffa16 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -34,23 +34,23 @@ Methods Method Descriptions ------------------- - .. _class_PhysicsShapeQueryResult_get_result_count: +.. _class_PhysicsShapeQueryResult_get_result_count: - :ref:`int` **get_result_count** **(** **)** const - .. _class_PhysicsShapeQueryResult_get_result_object: +.. _class_PhysicsShapeQueryResult_get_result_object: - :ref:`Object` **get_result_object** **(** :ref:`int` idx **)** const - .. _class_PhysicsShapeQueryResult_get_result_object_id: +.. _class_PhysicsShapeQueryResult_get_result_object_id: - :ref:`int` **get_result_object_id** **(** :ref:`int` idx **)** const - .. _class_PhysicsShapeQueryResult_get_result_object_shape: +.. _class_PhysicsShapeQueryResult_get_result_object_shape: - :ref:`int` **get_result_object_shape** **(** :ref:`int` idx **)** const - .. _class_PhysicsShapeQueryResult_get_result_rid: +.. _class_PhysicsShapeQueryResult_get_result_rid: - :ref:`RID` **get_result_rid** **(** :ref:`int` idx **)** const diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index a8221d8de..b4a10ae3d 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -30,7 +30,7 @@ Properties Enumerations ------------ - .. _enum_PinJoint_Param: +.. _enum_PinJoint_Param: enum **Param**: @@ -50,7 +50,7 @@ Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. Property Descriptions --------------------- - .. _class_PinJoint_params/bias: +.. _class_PinJoint_params/bias: - :ref:`float` **params/bias** @@ -64,7 +64,7 @@ The force with which the pinned objects stay in positional relation to each othe The higher, the stronger. - .. _class_PinJoint_params/damping: +.. _class_PinJoint_params/damping: - :ref:`float` **params/damping** @@ -78,7 +78,7 @@ The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. - .. _class_PinJoint_params/impulse_clamp: +.. _class_PinJoint_params/impulse_clamp: - :ref:`float` **params/impulse_clamp** diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 3c0e3d03b..2fbd7a540 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -31,7 +31,7 @@ Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together. Property Descriptions --------------------- - .. _class_PinJoint2D_softness: +.. _class_PinJoint2D_softness: - :ref:`float` **softness** diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 2a47aa211..6aceeabab 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -66,6 +66,7 @@ Constants - **PLANE_YZ** = **Plane( 1, 0, 0, 0 )** - **PLANE_XZ** = **Plane( 0, 1, 0, 0 )** - **PLANE_XY** = **Plane( 0, 0, 1, 0 )** + Description ----------- @@ -75,105 +76,106 @@ Tutorials --------- - :doc:`../tutorials/math/index` + Property Descriptions --------------------- - .. _class_Plane_d: +.. _class_Plane_d: - :ref:`float` **d** - .. _class_Plane_normal: +.. _class_Plane_normal: - :ref:`Vector3` **normal** - .. _class_Plane_x: +.. _class_Plane_x: - :ref:`float` **x** - .. _class_Plane_y: +.. _class_Plane_y: - :ref:`float` **y** - .. _class_Plane_z: +.. _class_Plane_z: - :ref:`float` **z** Method Descriptions ------------------- - .. _class_Plane_Plane: +.. _class_Plane_Plane: - :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: +.. _class_Plane_Plane: - :ref:`Plane` **Plane** **(** :ref:`Vector3` v1, :ref:`Vector3` v2, :ref:`Vector3` v3 **)** Creates a plane from three points. - .. _class_Plane_Plane: +.. _class_Plane_Plane: - :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: +.. _class_Plane_center: - :ref:`Vector3` **center** **(** **)** Returns the center of the plane. - .. _class_Plane_distance_to: +.. _class_Plane_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** Returns the shortest distance from the plane to the position "point". - .. _class_Plane_get_any_point: +.. _class_Plane_get_any_point: - :ref:`Vector3` **get_any_point** **(** **)** Returns a point on the plane. - .. _class_Plane_has_point: +.. _class_Plane_has_point: - :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: +.. _class_Plane_intersect_3: - :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: +.. _class_Plane_intersects_ray: - :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: +.. _class_Plane_intersects_segment: - :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: +.. _class_Plane_is_point_over: - :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** Returns true if "point" is located above the plane. - .. _class_Plane_normalized: +.. _class_Plane_normalized: - :ref:`Plane` **normalized** **(** **)** Returns a copy of the plane, normalized. - .. _class_Plane_project: +.. _class_Plane_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 0ce72c6f9..9926a243b 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -35,7 +35,7 @@ Class representing a planar :ref:`PrimitiveMesh`. This flat Property Descriptions --------------------- - .. _class_PlaneMesh_size: +.. _class_PlaneMesh_size: - :ref:`Vector2` **size** @@ -47,7 +47,7 @@ Property Descriptions Size of the generated plane. Defaults to (2.0, 2.0). - .. _class_PlaneMesh_subdivide_depth: +.. _class_PlaneMesh_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -59,7 +59,7 @@ Size of the generated plane. Defaults to (2.0, 2.0). Number of subdivision along the z-axis. Defaults to 0. - .. _class_PlaneMesh_subdivide_width: +.. _class_PlaneMesh_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index 2e58bd26b..8eb7ba135 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_PlaneShape_plane: +.. _class_PlaneShape_plane: - :ref:`Plane` **plane** diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index fd3f2cdac..1c76c9ded 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -82,7 +82,7 @@ A Polygon2D is defined by a set of points. Each point is connected to the next, Property Descriptions --------------------- - .. _class_Polygon2D_antialiased: +.. _class_Polygon2D_antialiased: - :ref:`bool` **antialiased** @@ -94,11 +94,11 @@ Property Descriptions If ``true`` polygon edges will be anti-aliased. Default value: ``false``. - .. _class_Polygon2D_bones: +.. _class_Polygon2D_bones: - :ref:`Array` **bones** - .. _class_Polygon2D_color: +.. _class_Polygon2D_color: - :ref:`Color` **color** @@ -110,7 +110,7 @@ If ``true`` polygon edges will be anti-aliased. Default value: ``false``. 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: +.. _class_Polygon2D_invert_border: - :ref:`float` **invert_border** @@ -122,7 +122,7 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``. - .. _class_Polygon2D_invert_enable: +.. _class_Polygon2D_invert_enable: - :ref:`bool` **invert_enable** @@ -134,7 +134,7 @@ Added padding applied to the bounding box when using ``invert``. Setting this va If ``true`` polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. - .. _class_Polygon2D_offset: +.. _class_Polygon2D_offset: - :ref:`Vector2` **offset** @@ -146,7 +146,7 @@ If ``true`` polygon will be inverted, containing the area outside the defined po The offset applied to each vertex. - .. _class_Polygon2D_polygon: +.. _class_Polygon2D_polygon: - :ref:`PoolVector2Array` **polygon** @@ -158,7 +158,7 @@ The offset applied to each vertex. The polygon's list of vertices. The final point will be connected to the first. - .. _class_Polygon2D_skeleton: +.. _class_Polygon2D_skeleton: - :ref:`NodePath` **skeleton** @@ -168,7 +168,7 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_skeleton() | +----------+---------------------+ - .. _class_Polygon2D_splits: +.. _class_Polygon2D_splits: - :ref:`PoolIntArray` **splits** @@ -178,7 +178,7 @@ The polygon's list of vertices. The final point will be connected to the first. | *Getter* | get_splits() | +----------+-------------------+ - .. _class_Polygon2D_texture: +.. _class_Polygon2D_texture: - :ref:`Texture` **texture** @@ -190,7 +190,7 @@ The polygon's list of vertices. The final point will be connected to the first. The polygon's fill texture. Use ``uv`` to set texture coordinates. - .. _class_Polygon2D_texture_offset: +.. _class_Polygon2D_texture_offset: - :ref:`Vector2` **texture_offset** @@ -202,7 +202,7 @@ The polygon's fill texture. Use ``uv`` to set texture coordinates. 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: +.. _class_Polygon2D_texture_rotation: - :ref:`float` **texture_rotation** @@ -214,7 +214,7 @@ Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin ( The texture's rotation in radians. - .. _class_Polygon2D_texture_rotation_degrees: +.. _class_Polygon2D_texture_rotation_degrees: - :ref:`float` **texture_rotation_degrees** @@ -226,7 +226,7 @@ The texture's rotation in radians. The texture's rotation in degrees. - .. _class_Polygon2D_texture_scale: +.. _class_Polygon2D_texture_scale: - :ref:`Vector2` **texture_scale** @@ -238,7 +238,7 @@ The texture's rotation in degrees. Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. - .. _class_Polygon2D_uv: +.. _class_Polygon2D_uv: - :ref:`PoolVector2Array` **uv** @@ -250,7 +250,7 @@ Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger value 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: +.. _class_Polygon2D_vertex_colors: - :ref:`PoolColorArray` **vertex_colors** @@ -265,35 +265,35 @@ Color for each vertex. Colors are interpolated between vertices, resulting in sm Method Descriptions ------------------- - .. _class_Polygon2D_add_bone: +.. _class_Polygon2D_add_bone: - void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** - .. _class_Polygon2D_clear_bones: +.. _class_Polygon2D_clear_bones: - void **clear_bones** **(** **)** - .. _class_Polygon2D_erase_bone: +.. _class_Polygon2D_erase_bone: - void **erase_bone** **(** :ref:`int` index **)** - .. _class_Polygon2D_get_bone_count: +.. _class_Polygon2D_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const - .. _class_Polygon2D_get_bone_path: +.. _class_Polygon2D_get_bone_path: - :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** const - .. _class_Polygon2D_get_bone_weights: +.. _class_Polygon2D_get_bone_weights: - :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** const - .. _class_Polygon2D_set_bone_path: +.. _class_Polygon2D_set_bone_path: - void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** - .. _class_Polygon2D_set_bone_weights: +.. _class_Polygon2D_set_bone_weights: - void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 432f56712..e566e83b7 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -40,35 +40,35 @@ Methods Method Descriptions ------------------- - .. _class_PolygonPathFinder_find_path: +.. _class_PolygonPathFinder_find_path: - :ref:`PoolVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** - .. _class_PolygonPathFinder_get_bounds: +.. _class_PolygonPathFinder_get_bounds: - :ref:`Rect2` **get_bounds** **(** **)** const - .. _class_PolygonPathFinder_get_closest_point: +.. _class_PolygonPathFinder_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** const - .. _class_PolygonPathFinder_get_intersections: +.. _class_PolygonPathFinder_get_intersections: - :ref:`PoolVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** const - .. _class_PolygonPathFinder_get_point_penalty: +.. _class_PolygonPathFinder_get_point_penalty: - :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** const - .. _class_PolygonPathFinder_is_point_inside: +.. _class_PolygonPathFinder_is_point_inside: - :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** const - .. _class_PolygonPathFinder_set_point_penalty: +.. _class_PolygonPathFinder_set_point_penalty: - void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** - .. _class_PolygonPathFinder_setup: +.. _class_PolygonPathFinder_setup: - void **setup** **(** :ref:`PoolVector2Array` points, :ref:`PoolIntArray` connections **)** diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index c11cf99f3..5501f6679 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -57,91 +57,91 @@ Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the m Method Descriptions ------------------- - .. _class_PoolByteArray_PoolByteArray: +.. _class_PoolByteArray_PoolByteArray: - :ref:`PoolByteArray` **PoolByteArray** **(** :ref:`Array` from **)** Create from a generic array. - .. _class_PoolByteArray_append: +.. _class_PoolByteArray_append: - void **append** **(** :ref:`int` byte **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolByteArray_append_array: +.. _class_PoolByteArray_append_array: - void **append_array** **(** :ref:`PoolByteArray` array **)** Append a ``PoolByteArray`` at the end of this array. - .. _class_PoolByteArray_compress: +.. _class_PoolByteArray_compress: - :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. - .. _class_PoolByteArray_decompress: +.. _class_PoolByteArray_decompress: - :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. - .. _class_PoolByteArray_get_string_from_ascii: +.. _class_PoolByteArray_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`. - .. _class_PoolByteArray_get_string_from_utf8: +.. _class_PoolByteArray_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. - .. _class_PoolByteArray_insert: +.. _class_PoolByteArray_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` byte **)** 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_PoolByteArray_invert: +.. _class_PoolByteArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolByteArray_push_back: +.. _class_PoolByteArray_push_back: - void **push_back** **(** :ref:`int` byte **)** Append an element at the end of the array. - .. _class_PoolByteArray_remove: +.. _class_PoolByteArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolByteArray_resize: +.. _class_PoolByteArray_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolByteArray_set: +.. _class_PoolByteArray_set: - void **set** **(** :ref:`int` idx, :ref:`int` byte **)** Change the byte at the given index. - .. _class_PoolByteArray_size: +.. _class_PoolByteArray_size: - :ref:`int` **size** **(** **)** Return the size of the array. - .. _class_PoolByteArray_subarray: +.. _class_PoolByteArray_subarray: - :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 6e1cfe128..055479e19 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -47,61 +47,61 @@ Array of Color, Contains colors. Optimized for memory usage, can't fragment the Method Descriptions ------------------- - .. _class_PoolColorArray_PoolColorArray: +.. _class_PoolColorArray_PoolColorArray: - :ref:`PoolColorArray` **PoolColorArray** **(** :ref:`Array` from **)** Create from a generic array. - .. _class_PoolColorArray_append: +.. _class_PoolColorArray_append: - void **append** **(** :ref:`Color` color **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolColorArray_append_array: +.. _class_PoolColorArray_append_array: - void **append_array** **(** :ref:`PoolColorArray` array **)** Append a ``PoolColorArray`` at the end of this array. - .. _class_PoolColorArray_insert: +.. _class_PoolColorArray_insert: - :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()). - .. _class_PoolColorArray_invert: +.. _class_PoolColorArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolColorArray_push_back: +.. _class_PoolColorArray_push_back: - void **push_back** **(** :ref:`Color` color **)** Append a value to the array. - .. _class_PoolColorArray_remove: +.. _class_PoolColorArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolColorArray_resize: +.. _class_PoolColorArray_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolColorArray_set: +.. _class_PoolColorArray_set: - void **set** **(** :ref:`int` idx, :ref:`Color` color **)** Change the :ref:`Color` at the given index. - .. _class_PoolColorArray_size: +.. _class_PoolColorArray_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 58ece41e8..7b1f3e522 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -47,61 +47,61 @@ Integer Array. Contains integers. Optimized for memory usage, can't fragment the Method Descriptions ------------------- - .. _class_PoolIntArray_PoolIntArray: +.. _class_PoolIntArray_PoolIntArray: - :ref:`PoolIntArray` **PoolIntArray** **(** :ref:`Array` from **)** Create from a generic array. - .. _class_PoolIntArray_append: +.. _class_PoolIntArray_append: - void **append** **(** :ref:`int` integer **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolIntArray_append_array: +.. _class_PoolIntArray_append_array: - void **append_array** **(** :ref:`PoolIntArray` array **)** Append an ``PoolIntArray`` at the end of this array. - .. _class_PoolIntArray_insert: +.. _class_PoolIntArray_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`int` integer **)** Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - .. _class_PoolIntArray_invert: +.. _class_PoolIntArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolIntArray_push_back: +.. _class_PoolIntArray_push_back: - void **push_back** **(** :ref:`int` integer **)** Append a value to the array. - .. _class_PoolIntArray_remove: +.. _class_PoolIntArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolIntArray_resize: +.. _class_PoolIntArray_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolIntArray_set: +.. _class_PoolIntArray_set: - void **set** **(** :ref:`int` idx, :ref:`int` integer **)** Change the int at the given index. - .. _class_PoolIntArray_size: +.. _class_PoolIntArray_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index b6cebccc6..67de258f5 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -47,61 +47,61 @@ Real Array. Array of floating point values. Can only contain floats. Optimized f Method Descriptions ------------------- - .. _class_PoolRealArray_PoolRealArray: +.. _class_PoolRealArray_PoolRealArray: - :ref:`PoolRealArray` **PoolRealArray** **(** :ref:`Array` from **)** Create from a generic array. - .. _class_PoolRealArray_append: +.. _class_PoolRealArray_append: - void **append** **(** :ref:`float` value **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolRealArray_append_array: +.. _class_PoolRealArray_append_array: - void **append_array** **(** :ref:`PoolRealArray` array **)** Append an RealArray at the end of this array. - .. _class_PoolRealArray_insert: +.. _class_PoolRealArray_insert: - :ref:`int` **insert** **(** :ref:`int` idx, :ref:`float` 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()). - .. _class_PoolRealArray_invert: +.. _class_PoolRealArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolRealArray_push_back: +.. _class_PoolRealArray_push_back: - void **push_back** **(** :ref:`float` value **)** Append an element at the end of the array. - .. _class_PoolRealArray_remove: +.. _class_PoolRealArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolRealArray_resize: +.. _class_PoolRealArray_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolRealArray_set: +.. _class_PoolRealArray_set: - void **set** **(** :ref:`int` idx, :ref:`float` value **)** Change the float at the given index. - .. _class_PoolRealArray_size: +.. _class_PoolRealArray_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 84bae2500..f9cf76154 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -49,67 +49,67 @@ String Array. Array of strings. Can only contain strings. Optimized for memory u Method Descriptions ------------------- - .. _class_PoolStringArray_PoolStringArray: +.. _class_PoolStringArray_PoolStringArray: - :ref:`PoolStringArray` **PoolStringArray** **(** :ref:`Array` from **)** Create from a generic array. - .. _class_PoolStringArray_append: +.. _class_PoolStringArray_append: - void **append** **(** :ref:`String` string **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolStringArray_append_array: +.. _class_PoolStringArray_append_array: - void **append_array** **(** :ref:`PoolStringArray` array **)** Append an StringArray at the end of this array. - .. _class_PoolStringArray_insert: +.. _class_PoolStringArray_insert: - :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()). - .. _class_PoolStringArray_invert: +.. _class_PoolStringArray_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolStringArray_join: +.. _class_PoolStringArray_join: - :ref:`String` **join** **(** :ref:`String` delimiter **)** Returns a :ref:`String` with each element of the array joined with the delimiter. - .. _class_PoolStringArray_push_back: +.. _class_PoolStringArray_push_back: - void **push_back** **(** :ref:`String` string **)** Append a string element at end of the array. - .. _class_PoolStringArray_remove: +.. _class_PoolStringArray_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolStringArray_resize: +.. _class_PoolStringArray_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolStringArray_set: +.. _class_PoolStringArray_set: - void **set** **(** :ref:`int` idx, :ref:`String` string **)** Change the :ref:`String` at the given index. - .. _class_PoolStringArray_size: +.. _class_PoolStringArray_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index de9166971..36239cb35 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -47,61 +47,61 @@ An Array specifically designed to hold Vector2. Note that this type is passed by Method Descriptions ------------------- - .. _class_PoolVector2Array_PoolVector2Array: +.. _class_PoolVector2Array_PoolVector2Array: - :ref:`PoolVector2Array` **PoolVector2Array** **(** :ref:`Array` from **)** Construct a new ``PoolVector2Array``. Optionally, you can pass in an Array that will be converted. - .. _class_PoolVector2Array_append: +.. _class_PoolVector2Array_append: - void **append** **(** :ref:`Vector2` vector2 **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolVector2Array_append_array: +.. _class_PoolVector2Array_append_array: - void **append_array** **(** :ref:`PoolVector2Array` array **)** Append an ``PoolVector2Array`` at the end of this array. - .. _class_PoolVector2Array_insert: +.. _class_PoolVector2Array_insert: - :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()). - .. _class_PoolVector2Array_invert: +.. _class_PoolVector2Array_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolVector2Array_push_back: +.. _class_PoolVector2Array_push_back: - void **push_back** **(** :ref:`Vector2` vector2 **)** Insert a :ref:`Vector2` at the end. - .. _class_PoolVector2Array_remove: +.. _class_PoolVector2Array_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolVector2Array_resize: +.. _class_PoolVector2Array_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolVector2Array_set: +.. _class_PoolVector2Array_set: - void **set** **(** :ref:`int` idx, :ref:`Vector2` vector2 **)** Change the :ref:`Vector2` at the given index. - .. _class_PoolVector2Array_size: +.. _class_PoolVector2Array_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 0f2743caf..245c1ef85 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -47,61 +47,61 @@ An Array specifically designed to hold Vector3. Note that this type is passed by Method Descriptions ------------------- - .. _class_PoolVector3Array_PoolVector3Array: +.. _class_PoolVector3Array_PoolVector3Array: - :ref:`PoolVector3Array` **PoolVector3Array** **(** :ref:`Array` from **)** Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. - .. _class_PoolVector3Array_append: +.. _class_PoolVector3Array_append: - void **append** **(** :ref:`Vector3` vector3 **)** Append an element at the end of the array (alias of :ref:`push_back`). - .. _class_PoolVector3Array_append_array: +.. _class_PoolVector3Array_append_array: - void **append_array** **(** :ref:`PoolVector3Array` array **)** Append an ``PoolVector3Array`` at the end of this array. - .. _class_PoolVector3Array_insert: +.. _class_PoolVector3Array_insert: - :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()). - .. _class_PoolVector3Array_invert: +.. _class_PoolVector3Array_invert: - void **invert** **(** **)** Reverse the order of the elements in the array. - .. _class_PoolVector3Array_push_back: +.. _class_PoolVector3Array_push_back: - void **push_back** **(** :ref:`Vector3` vector3 **)** Insert a :ref:`Vector3` at the end. - .. _class_PoolVector3Array_remove: +.. _class_PoolVector3Array_remove: - void **remove** **(** :ref:`int` idx **)** Remove an element from the array by index. - .. _class_PoolVector3Array_resize: +.. _class_PoolVector3Array_resize: - void **resize** **(** :ref:`int` idx **)** Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size. - .. _class_PoolVector3Array_set: +.. _class_PoolVector3Array_set: - void **set** **(** :ref:`int` idx, :ref:`Vector3` vector3 **)** Change the :ref:`Vector3` at the given index. - .. _class_PoolVector3Array_size: +.. _class_PoolVector3Array_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 66ae0f493..4d5a12dbc 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -41,13 +41,13 @@ Methods Signals ------- - .. _class_Popup_about_to_show: +.. _class_Popup_about_to_show: - **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). - .. _class_Popup_popup_hide: +.. _class_Popup_popup_hide: - **popup_hide** **(** **)** @@ -58,6 +58,7 @@ 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. + Description ----------- @@ -66,7 +67,7 @@ Popup is a base :ref:`Control` used to show dialogs and popups. I Property Descriptions --------------------- - .. _class_Popup_popup_exclusive: +.. _class_Popup_popup_exclusive: - :ref:`bool` **popup_exclusive** @@ -81,25 +82,25 @@ If ``true`` the popup will not be hidden when a click event occurs outside of it Method Descriptions ------------------- - .. _class_Popup_popup: +.. _class_Popup_popup: - void **popup** **(** :ref:`Rect2` bounds=Rect2( 0, 0, 0, 0 ) **)** Popup (show the control in modal form). - .. _class_Popup_popup_centered: +.. _class_Popup_popup_centered: - 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: +.. _class_Popup_popup_centered_minsize: - 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``. - .. _class_Popup_popup_centered_ratio: +.. _class_Popup_popup_centered_ratio: - void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index f153a0afb..bd9aca7ca 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -176,19 +176,19 @@ Theme Properties Signals ------- - .. _class_PopupMenu_id_focused: +.. _class_PopupMenu_id_focused: - **id_focused** **(** :ref:`int` ID **)** This event is emitted when user navigated to an item of some id using ``ui_up`` or ``ui_down`` action. - .. _class_PopupMenu_id_pressed: +.. _class_PopupMenu_id_pressed: - **id_pressed** **(** :ref:`int` ID **)** This event is emitted when an item of some id is pressed or its accelerator is activated. - .. _class_PopupMenu_index_pressed: +.. _class_PopupMenu_index_pressed: - **index_pressed** **(** :ref:`int` index **)** @@ -202,7 +202,7 @@ PopupMenu is the typical Control that displays a list of options. They are popul Property Descriptions --------------------- - .. _class_PopupMenu_hide_on_checkable_item_selection: +.. _class_PopupMenu_hide_on_checkable_item_selection: - :ref:`bool` **hide_on_checkable_item_selection** @@ -212,7 +212,7 @@ Property Descriptions | *Getter* | is_hide_on_checkable_item_selection() | +----------+---------------------------------------------+ - .. _class_PopupMenu_hide_on_item_selection: +.. _class_PopupMenu_hide_on_item_selection: - :ref:`bool` **hide_on_item_selection** @@ -222,7 +222,7 @@ Property Descriptions | *Getter* | is_hide_on_item_selection() | +----------+-----------------------------------+ - .. _class_PopupMenu_hide_on_state_item_selection: +.. _class_PopupMenu_hide_on_state_item_selection: - :ref:`bool` **hide_on_state_item_selection** @@ -232,7 +232,7 @@ Property Descriptions | *Getter* | is_hide_on_state_item_selection() | +----------+-----------------------------------------+ - .. _class_PopupMenu_submenu_popup_delay: +.. _class_PopupMenu_submenu_popup_delay: - :ref:`float` **submenu_popup_delay** @@ -247,17 +247,17 @@ Sets the delay time for the submenu item to popup on mouse hovering. If the popu Method Descriptions ------------------- - .. _class_PopupMenu_add_check_item: +.. _class_PopupMenu_add_check_item: - 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: +.. _class_PopupMenu_add_check_shortcut: - void **add_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** - .. _class_PopupMenu_add_icon_check_item: +.. _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 **)** @@ -265,175 +265,175 @@ Add a new checkable item with text "label" and icon "texture". An id can optiona 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_icon_check_shortcut: +.. _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 **)** - .. _class_PopupMenu_add_icon_item: +.. _class_PopupMenu_add_icon_item: - 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: +.. _class_PopupMenu_add_icon_shortcut: - void **add_icon_shortcut** **(** :ref:`Texture` texture, :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** - .. _class_PopupMenu_add_item: +.. _class_PopupMenu_add_item: - 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: +.. _class_PopupMenu_add_radio_check_item: - 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: +.. _class_PopupMenu_add_radio_check_shortcut: - void **add_radio_check_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** - .. _class_PopupMenu_add_separator: +.. _class_PopupMenu_add_separator: - void **add_separator** **(** :ref:`String` label="" **)** Add a separator between items. Separators also occupy an index. - .. _class_PopupMenu_add_shortcut: +.. _class_PopupMenu_add_shortcut: - void **add_shortcut** **(** :ref:`ShortCut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** - .. _class_PopupMenu_add_submenu_item: +.. _class_PopupMenu_add_submenu_item: - 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. - .. _class_PopupMenu_clear: +.. _class_PopupMenu_clear: - void **clear** **(** **)** Clear the popup menu, in effect removing all items. - .. _class_PopupMenu_get_item_accelerator: +.. _class_PopupMenu_get_item_accelerator: - :ref:`int` **get_item_accelerator** **(** :ref:`int` idx **)** const Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. - .. _class_PopupMenu_get_item_count: +.. _class_PopupMenu_get_item_count: - :ref:`int` **get_item_count** **(** **)** const Return the amount of items. - .. _class_PopupMenu_get_item_icon: +.. _class_PopupMenu_get_item_icon: - :ref:`Texture` **get_item_icon** **(** :ref:`int` idx **)** const Return the icon of the item at index "idx". - .. _class_PopupMenu_get_item_id: +.. _class_PopupMenu_get_item_id: - :ref:`int` **get_item_id** **(** :ref:`int` idx **)** const Return the id of the item at index "idx". - .. _class_PopupMenu_get_item_index: +.. _class_PopupMenu_get_item_index: - :ref:`int` **get_item_index** **(** :ref:`int` id **)** const Find and return the index of the item containing a given id. - .. _class_PopupMenu_get_item_metadata: +.. _class_PopupMenu_get_item_metadata: - :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: +.. _class_PopupMenu_get_item_shortcut: - :ref:`ShortCut` **get_item_shortcut** **(** :ref:`int` idx **)** const - .. _class_PopupMenu_get_item_submenu: +.. _class_PopupMenu_get_item_submenu: - :ref:`String` **get_item_submenu** **(** :ref:`int` idx **)** const Return the submenu name of the item at index "idx". - .. _class_PopupMenu_get_item_text: +.. _class_PopupMenu_get_item_text: - :ref:`String` **get_item_text** **(** :ref:`int` idx **)** const Return the text of the item at index "idx". - .. _class_PopupMenu_get_item_tooltip: +.. _class_PopupMenu_get_item_tooltip: - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const - .. _class_PopupMenu_is_hide_on_window_lose_focus: +.. _class_PopupMenu_is_hide_on_window_lose_focus: - :ref:`bool` **is_hide_on_window_lose_focus** **(** **)** const - .. _class_PopupMenu_is_item_checkable: +.. _class_PopupMenu_is_item_checkable: - :ref:`bool` **is_item_checkable** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is checkable in some way, i.e., whether has a checkbox or radio button. Note that checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. - .. _class_PopupMenu_is_item_checked: +.. _class_PopupMenu_is_item_checked: - :ref:`bool` **is_item_checked** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is checked. - .. _class_PopupMenu_is_item_disabled: +.. _class_PopupMenu_is_item_disabled: - :ref:`bool` **is_item_disabled** **(** :ref:`int` idx **)** const Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. - .. _class_PopupMenu_is_item_radio_checkable: +.. _class_PopupMenu_is_item_radio_checkable: - :ref:`bool` **is_item_radio_checkable** **(** :ref:`int` idx **)** const Return whether the item at index "idx" has radio-button-style checkability. Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. - .. _class_PopupMenu_is_item_separator: +.. _class_PopupMenu_is_item_separator: - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** const Return whether the item is a separator. If it is, it would be displayed as a line. - .. _class_PopupMenu_is_item_shortcut_disabled: +.. _class_PopupMenu_is_item_shortcut_disabled: - :ref:`bool` **is_item_shortcut_disabled** **(** :ref:`int` idx **)** const - .. _class_PopupMenu_remove_item: +.. _class_PopupMenu_remove_item: - void **remove_item** **(** :ref:`int` idx **)** Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. - .. _class_PopupMenu_set_hide_on_window_lose_focus: +.. _class_PopupMenu_set_hide_on_window_lose_focus: - void **set_hide_on_window_lose_focus** **(** :ref:`bool` enable **)** - .. _class_PopupMenu_set_item_accelerator: +.. _class_PopupMenu_set_item_accelerator: - void **set_item_accelerator** **(** :ref:`int` idx, :ref:`int` accel **)** Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. - .. _class_PopupMenu_set_item_as_checkable: +.. _class_PopupMenu_set_item_as_checkable: - void **set_item_as_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** Set whether the item at index "idx" has a checkbox. 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_set_item_as_radio_checkable: +.. _class_PopupMenu_set_item_as_radio_checkable: - void **set_item_as_radio_checkable** **(** :ref:`int` idx, :ref:`bool` enable **)** @@ -441,73 +441,73 @@ The same as :ref:`set_item_as_checkable` Remember this is just cosmetic and you have to add the logic for checking/unchecking items in radio groups. - .. _class_PopupMenu_set_item_as_separator: +.. _class_PopupMenu_set_item_as_separator: - void **set_item_as_separator** **(** :ref:`int` idx, :ref:`bool` enable **)** Mark the item at index "idx" as a separator, which means that it would be displayed as a mere line. - .. _class_PopupMenu_set_item_checked: +.. _class_PopupMenu_set_item_checked: - void **set_item_checked** **(** :ref:`int` idx, :ref:`bool` checked **)** Set the checkstate status of the item at index "idx". - .. _class_PopupMenu_set_item_disabled: +.. _class_PopupMenu_set_item_disabled: - void **set_item_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. - .. _class_PopupMenu_set_item_icon: +.. _class_PopupMenu_set_item_icon: - void **set_item_icon** **(** :ref:`int` idx, :ref:`Texture` icon **)** - .. _class_PopupMenu_set_item_id: +.. _class_PopupMenu_set_item_id: - void **set_item_id** **(** :ref:`int` idx, :ref:`int` id **)** Set the id of the item at index "idx". - .. _class_PopupMenu_set_item_metadata: +.. _class_PopupMenu_set_item_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. - .. _class_PopupMenu_set_item_multistate: +.. _class_PopupMenu_set_item_multistate: - void **set_item_multistate** **(** :ref:`int` idx, :ref:`int` state **)** - .. _class_PopupMenu_set_item_shortcut: +.. _class_PopupMenu_set_item_shortcut: - void **set_item_shortcut** **(** :ref:`int` idx, :ref:`ShortCut` shortcut, :ref:`bool` global=false **)** - .. _class_PopupMenu_set_item_shortcut_disabled: +.. _class_PopupMenu_set_item_shortcut_disabled: - void **set_item_shortcut_disabled** **(** :ref:`int` idx, :ref:`bool` disabled **)** - .. _class_PopupMenu_set_item_submenu: +.. _class_PopupMenu_set_item_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: +.. _class_PopupMenu_set_item_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: +.. _class_PopupMenu_set_item_tooltip: - void **set_item_tooltip** **(** :ref:`int` idx, :ref:`String` tooltip **)** - .. _class_PopupMenu_toggle_item_checked: +.. _class_PopupMenu_toggle_item_checked: - void **toggle_item_checked** **(** :ref:`int` idx **)** - .. _class_PopupMenu_toggle_item_multistate: +.. _class_PopupMenu_toggle_item_multistate: - void **toggle_item_multistate** **(** :ref:`int` idx **)** diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index c15b21d5a..d7e50ec27 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -44,7 +44,7 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` **custom_aabb** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_custom_aabb() | +----------+------------------------+ - .. _class_PrimitiveMesh_flip_faces: +.. _class_PrimitiveMesh_flip_faces: - :ref:`bool` **flip_faces** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_flip_faces() | +----------+-----------------------+ - .. _class_PrimitiveMesh_material: +.. _class_PrimitiveMesh_material: - :ref:`Material` **material** @@ -79,7 +79,7 @@ The current :ref:`Material` of the primitive mesh. Method Descriptions ------------------- - .. _class_PrimitiveMesh_get_mesh_arrays: +.. _class_PrimitiveMesh_get_mesh_arrays: - :ref:`Array` **get_mesh_arrays** **(** **)** const diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 83c128358..5df067def 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -39,7 +39,7 @@ Class representing a prism-shaped :ref:`PrimitiveMesh`. Property Descriptions --------------------- - .. _class_PrismMesh_left_to_right: +.. _class_PrismMesh_left_to_right: - :ref:`float` **left_to_right** @@ -51,7 +51,7 @@ Property Descriptions Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottome left edge. Defaults to 0.5 (positioned on the midpoint). - .. _class_PrismMesh_size: +.. _class_PrismMesh_size: - :ref:`Vector3` **size** @@ -63,7 +63,7 @@ Displacement of the upper edge along the x-axis. 0.0 positions edge straight abo Size of the prism. Defaults to (2.0, 2.0, 2.0). - .. _class_PrismMesh_subdivide_depth: +.. _class_PrismMesh_subdivide_depth: - :ref:`int` **subdivide_depth** @@ -75,7 +75,7 @@ Size of the prism. Defaults to (2.0, 2.0, 2.0). Number of added edge loops along the z-axis. Defaults to 0. - .. _class_PrismMesh_subdivide_height: +.. _class_PrismMesh_subdivide_height: - :ref:`int` **subdivide_height** @@ -87,7 +87,7 @@ Number of added edge loops along the z-axis. Defaults to 0. Number of added edge loops along the y-axis. Defaults to 0. - .. _class_PrismMesh_subdivide_width: +.. _class_PrismMesh_subdivide_width: - :ref:`int` **subdivide_width** diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 4ecc25bb4..b026c1f8a 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -56,7 +56,7 @@ Properties Enumerations ------------ - .. _enum_ProceduralSky_TextureSize: +.. _enum_ProceduralSky_TextureSize: enum **TextureSize**: @@ -77,7 +77,7 @@ The ProceduralSky is updated on the CPU after the parameters change and stored i Property Descriptions --------------------- - .. _class_ProceduralSky_ground_bottom_color: +.. _class_ProceduralSky_ground_bottom_color: - :ref:`Color` **ground_bottom_color** @@ -89,7 +89,7 @@ Property Descriptions Color of the ground at the bottom. - .. _class_ProceduralSky_ground_curve: +.. _class_ProceduralSky_ground_curve: - :ref:`float` **ground_curve** @@ -101,7 +101,7 @@ Color of the ground at the bottom. How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. - .. _class_ProceduralSky_ground_energy: +.. _class_ProceduralSky_ground_energy: - :ref:`float` **ground_energy** @@ -113,7 +113,7 @@ How quickly the :ref:`ground_horizon_color` **ground_horizon_color** @@ -125,7 +125,7 @@ Amount of energy contribution from the ground. Color of the ground at the horizon. - .. _class_ProceduralSky_sky_curve: +.. _class_ProceduralSky_sky_curve: - :ref:`float` **sky_curve** @@ -137,7 +137,7 @@ Color of the ground at the horizon. How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. - .. _class_ProceduralSky_sky_energy: +.. _class_ProceduralSky_sky_energy: - :ref:`float` **sky_energy** @@ -149,7 +149,7 @@ How quickly the :ref:`sky_horizon_color` Amount of energy contribution from the sky. - .. _class_ProceduralSky_sky_horizon_color: +.. _class_ProceduralSky_sky_horizon_color: - :ref:`Color` **sky_horizon_color** @@ -161,7 +161,7 @@ Amount of energy contribution from the sky. Color of the sky at the horizon. - .. _class_ProceduralSky_sky_top_color: +.. _class_ProceduralSky_sky_top_color: - :ref:`Color` **sky_top_color** @@ -173,7 +173,7 @@ Color of the sky at the horizon. Color of the sky at the top. - .. _class_ProceduralSky_sun_angle_max: +.. _class_ProceduralSky_sun_angle_max: - :ref:`float` **sun_angle_max** @@ -185,7 +185,7 @@ Color of the sky at the top. Distance from center of sun where it fades out completely. - .. _class_ProceduralSky_sun_angle_min: +.. _class_ProceduralSky_sun_angle_min: - :ref:`float` **sun_angle_min** @@ -197,7 +197,7 @@ Distance from center of sun where it fades out completely. Distance from sun where it goes from solid to starting to fade. - .. _class_ProceduralSky_sun_color: +.. _class_ProceduralSky_sun_color: - :ref:`Color` **sun_color** @@ -209,7 +209,7 @@ Distance from sun where it goes from solid to starting to fade. Color of the sun. - .. _class_ProceduralSky_sun_curve: +.. _class_ProceduralSky_sun_curve: - :ref:`float` **sun_curve** @@ -221,7 +221,7 @@ Color of the sun. How quickly the sun fades away between :ref:`sun_angle_min` and :ref:`sun_angle_max` - .. _class_ProceduralSky_sun_energy: +.. _class_ProceduralSky_sun_energy: - :ref:`float` **sun_energy** @@ -233,7 +233,7 @@ How quickly the sun fades away between :ref:`sun_angle_min` **sun_latitude** @@ -245,7 +245,7 @@ Amount of energy contribution from the sun. The suns height using polar coordinates. - .. _class_ProceduralSky_sun_longitude: +.. _class_ProceduralSky_sun_longitude: - :ref:`float` **sun_longitude** @@ -257,7 +257,7 @@ The suns height using polar coordinates. The direction of the sun using polar coordinates. - .. _class_ProceduralSky_texture_size: +.. _class_ProceduralSky_texture_size: - :ref:`TextureSize` **texture_size** diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 4992fa021..078b65ce5 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -46,7 +46,7 @@ General purpose progress bar. Shows fill percentage from right to left. Property Descriptions --------------------- - .. _class_ProgressBar_percent_visible: +.. _class_ProgressBar_percent_visible: - :ref:`bool` **percent_visible** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 6533f7dae..fdadda576 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -412,8 +412,6 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/remote_fs/page_size` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`network/ssl/certificates` | -+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`node/name_casing` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`node/name_num_separator` | @@ -562,23 +560,23 @@ Contains global variables accessible from everywhere. Use "ProjectSettings.get_s Property Descriptions --------------------- - .. _class_ProjectSettings_application/boot_splash/bg_color: +.. _class_ProjectSettings_application/boot_splash/bg_color: - :ref:`Color` **application/boot_splash/bg_color** - .. _class_ProjectSettings_application/boot_splash/fullsize: +.. _class_ProjectSettings_application/boot_splash/fullsize: - :ref:`bool` **application/boot_splash/fullsize** Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise). - .. _class_ProjectSettings_application/boot_splash/image: +.. _class_ProjectSettings_application/boot_splash/image: - :ref:`String` **application/boot_splash/image** Path to an image used for boot splash. - .. _class_ProjectSettings_application/config/custom_user_dir_name: +.. _class_ProjectSettings_application/config/custom_user_dir_name: - :ref:`String` **application/config/custom_user_dir_name** @@ -586,1180 +584,1174 @@ This directory is used for storing persistent data (user:// filesystem). If a cu the "use_custom_user_dir" setting must be enabled for this to take effect. - .. _class_ProjectSettings_application/config/icon: +.. _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. - .. _class_ProjectSettings_application/config/name: +.. _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. - .. _class_ProjectSettings_application/config/use_custom_user_dir: +.. _class_ProjectSettings_application/config/use_custom_user_dir: - :ref:`bool` **application/config/use_custom_user_dir** Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. - .. _class_ProjectSettings_application/run/disable_stderr: +.. _class_ProjectSettings_application/run/disable_stderr: - :ref:`bool` **application/run/disable_stderr** Disable printing to stderr on exported build. - .. _class_ProjectSettings_application/run/disable_stdout: +.. _class_ProjectSettings_application/run/disable_stdout: - :ref:`bool` **application/run/disable_stdout** Disable printing to stdout on exported build. - .. _class_ProjectSettings_application/run/frame_delay_msec: +.. _class_ProjectSettings_application/run/frame_delay_msec: - :ref:`int` **application/run/frame_delay_msec** Force a delay between frames in the main loop. This may be useful if you plan to disable vsync. - .. _class_ProjectSettings_application/run/low_processor_mode: +.. _class_ProjectSettings_application/run/low_processor_mode: - :ref:`bool` **application/run/low_processor_mode** Turn on low processor mode. This setting only works on desktops. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) on games. - .. _class_ProjectSettings_application/run/low_processor_mode_sleep_usec: +.. _class_ProjectSettings_application/run/low_processor_mode_sleep_usec: - :ref:`int` **application/run/low_processor_mode_sleep_usec** Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled. - .. _class_ProjectSettings_application/run/main_scene: +.. _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. - .. _class_ProjectSettings_audio/channel_disable_threshold_db: +.. _class_ProjectSettings_audio/channel_disable_threshold_db: - :ref:`float` **audio/channel_disable_threshold_db** Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. - .. _class_ProjectSettings_audio/channel_disable_time: +.. _class_ProjectSettings_audio/channel_disable_time: - :ref:`float` **audio/channel_disable_time** Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. - .. _class_ProjectSettings_audio/driver: +.. _class_ProjectSettings_audio/driver: - :ref:`String` **audio/driver** - .. _class_ProjectSettings_audio/mix_rate: +.. _class_ProjectSettings_audio/mix_rate: - :ref:`int` **audio/mix_rate** Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. - .. _class_ProjectSettings_audio/output_latency: +.. _class_ProjectSettings_audio/output_latency: - :ref:`int` **audio/output_latency** - .. _class_ProjectSettings_audio/video_delay_compensation_ms: +.. _class_ProjectSettings_audio/video_delay_compensation_ms: - :ref:`int` **audio/video_delay_compensation_ms** Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. - .. _class_ProjectSettings_compression/formats/gzip/compression_level: +.. _class_ProjectSettings_compression/formats/gzip/compression_level: - :ref:`int` **compression/formats/gzip/compression_level** Default compression level for gzip. Affects compressed scenes and resources. - .. _class_ProjectSettings_compression/formats/zlib/compression_level: +.. _class_ProjectSettings_compression/formats/zlib/compression_level: - :ref:`int` **compression/formats/zlib/compression_level** Default compression level for zlib. Affects compressed scenes and resources. - .. _class_ProjectSettings_compression/formats/zstd/compression_level: +.. _class_ProjectSettings_compression/formats/zstd/compression_level: - :ref:`int` **compression/formats/zstd/compression_level** Default compression level for zstd. Affects compressed scenes and resources. - .. _class_ProjectSettings_compression/formats/zstd/long_distance_matching: +.. _class_ProjectSettings_compression/formats/zstd/long_distance_matching: - :ref:`bool` **compression/formats/zstd/long_distance_matching** Enable long distance matching in zstd. - .. _class_ProjectSettings_compression/formats/zstd/window_log_size: +.. _class_ProjectSettings_compression/formats/zstd/window_log_size: - :ref:`int` **compression/formats/zstd/window_log_size** - .. _class_ProjectSettings_debug/gdscript/warnings/constant_used_as_function: +.. _class_ProjectSettings_debug/gdscript/warnings/constant_used_as_function: - :ref:`bool` **debug/gdscript/warnings/constant_used_as_function** - .. _class_ProjectSettings_debug/gdscript/warnings/deprecated_keyword: +.. _class_ProjectSettings_debug/gdscript/warnings/deprecated_keyword: - :ref:`bool` **debug/gdscript/warnings/deprecated_keyword** - .. _class_ProjectSettings_debug/gdscript/warnings/enable: +.. _class_ProjectSettings_debug/gdscript/warnings/enable: - :ref:`bool` **debug/gdscript/warnings/enable** - .. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_constant: +.. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_constant: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_constant** - .. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_variable: +.. _class_ProjectSettings_debug/gdscript/warnings/function_conflicts_variable: - :ref:`bool` **debug/gdscript/warnings/function_conflicts_variable** - .. _class_ProjectSettings_debug/gdscript/warnings/function_may_yield: +.. _class_ProjectSettings_debug/gdscript/warnings/function_may_yield: - :ref:`bool` **debug/gdscript/warnings/function_may_yield** - .. _class_ProjectSettings_debug/gdscript/warnings/function_used_as_property: +.. _class_ProjectSettings_debug/gdscript/warnings/function_used_as_property: - :ref:`bool` **debug/gdscript/warnings/function_used_as_property** - .. _class_ProjectSettings_debug/gdscript/warnings/incompatible_ternary: +.. _class_ProjectSettings_debug/gdscript/warnings/incompatible_ternary: - :ref:`bool` **debug/gdscript/warnings/incompatible_ternary** - .. _class_ProjectSettings_debug/gdscript/warnings/integer_division: +.. _class_ProjectSettings_debug/gdscript/warnings/integer_division: - :ref:`bool` **debug/gdscript/warnings/integer_division** - .. _class_ProjectSettings_debug/gdscript/warnings/narrowing_conversion: +.. _class_ProjectSettings_debug/gdscript/warnings/narrowing_conversion: - :ref:`bool` **debug/gdscript/warnings/narrowing_conversion** - .. _class_ProjectSettings_debug/gdscript/warnings/property_used_as_function: +.. _class_ProjectSettings_debug/gdscript/warnings/property_used_as_function: - :ref:`bool` **debug/gdscript/warnings/property_used_as_function** - .. _class_ProjectSettings_debug/gdscript/warnings/return_value_discarded: +.. _class_ProjectSettings_debug/gdscript/warnings/return_value_discarded: - :ref:`bool` **debug/gdscript/warnings/return_value_discarded** - .. _class_ProjectSettings_debug/gdscript/warnings/standalone_expression: +.. _class_ProjectSettings_debug/gdscript/warnings/standalone_expression: - :ref:`bool` **debug/gdscript/warnings/standalone_expression** - .. _class_ProjectSettings_debug/gdscript/warnings/treat_warnings_as_errors: +.. _class_ProjectSettings_debug/gdscript/warnings/treat_warnings_as_errors: - :ref:`bool` **debug/gdscript/warnings/treat_warnings_as_errors** - .. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable: +.. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable** - .. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable_op_assign: +.. _class_ProjectSettings_debug/gdscript/warnings/unassigned_variable_op_assign: - :ref:`bool` **debug/gdscript/warnings/unassigned_variable_op_assign** - .. _class_ProjectSettings_debug/gdscript/warnings/unreachable_code: +.. _class_ProjectSettings_debug/gdscript/warnings/unreachable_code: - :ref:`bool` **debug/gdscript/warnings/unreachable_code** - .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_call_argument: +.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_call_argument: - :ref:`bool` **debug/gdscript/warnings/unsafe_call_argument** - .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_cast: +.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_cast: - :ref:`bool` **debug/gdscript/warnings/unsafe_cast** - .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_method_access: +.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_method_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_method_access** - .. _class_ProjectSettings_debug/gdscript/warnings/unsafe_property_access: +.. _class_ProjectSettings_debug/gdscript/warnings/unsafe_property_access: - :ref:`bool` **debug/gdscript/warnings/unsafe_property_access** - .. _class_ProjectSettings_debug/gdscript/warnings/unused_argument: +.. _class_ProjectSettings_debug/gdscript/warnings/unused_argument: - :ref:`bool` **debug/gdscript/warnings/unused_argument** - .. _class_ProjectSettings_debug/gdscript/warnings/unused_class_variable: +.. _class_ProjectSettings_debug/gdscript/warnings/unused_class_variable: - :ref:`bool` **debug/gdscript/warnings/unused_class_variable** - .. _class_ProjectSettings_debug/gdscript/warnings/unused_signal: +.. _class_ProjectSettings_debug/gdscript/warnings/unused_signal: - :ref:`bool` **debug/gdscript/warnings/unused_signal** - .. _class_ProjectSettings_debug/gdscript/warnings/unused_variable: +.. _class_ProjectSettings_debug/gdscript/warnings/unused_variable: - :ref:`bool` **debug/gdscript/warnings/unused_variable** - .. _class_ProjectSettings_debug/gdscript/warnings/variable_conflicts_function: +.. _class_ProjectSettings_debug/gdscript/warnings/variable_conflicts_function: - :ref:`bool` **debug/gdscript/warnings/variable_conflicts_function** - .. _class_ProjectSettings_debug/gdscript/warnings/void_assignment: +.. _class_ProjectSettings_debug/gdscript/warnings/void_assignment: - :ref:`bool` **debug/gdscript/warnings/void_assignment** - .. _class_ProjectSettings_debug/settings/crash_handler/message: +.. _class_ProjectSettings_debug/settings/crash_handler/message: - :ref:`String` **debug/settings/crash_handler/message** - .. _class_ProjectSettings_debug/settings/fps/force_fps: +.. _class_ProjectSettings_debug/settings/fps/force_fps: - :ref:`int` **debug/settings/fps/force_fps** - .. _class_ProjectSettings_debug/settings/gdscript/max_call_stack: +.. _class_ProjectSettings_debug/settings/gdscript/max_call_stack: - :ref:`int` **debug/settings/gdscript/max_call_stack** Maximum call stack allowed for debugging GDScript. - .. _class_ProjectSettings_debug/settings/profiler/max_functions: +.. _class_ProjectSettings_debug/settings/profiler/max_functions: - :ref:`int` **debug/settings/profiler/max_functions** Maximum amount of functions per frame allowed when profiling. - .. _class_ProjectSettings_debug/settings/stdout/print_fps: +.. _class_ProjectSettings_debug/settings/stdout/print_fps: - :ref:`bool` **debug/settings/stdout/print_fps** Print frames per second to stdout. Not very useful in general. - .. _class_ProjectSettings_debug/settings/stdout/verbose_stdout: +.. _class_ProjectSettings_debug/settings/stdout/verbose_stdout: - :ref:`bool` **debug/settings/stdout/verbose_stdout** Print more information to stdout when running. It shows info such as memory leaks, which scenes and resources are being loaded, etc. - .. _class_ProjectSettings_debug/settings/visual_script/max_call_stack: +.. _class_ProjectSettings_debug/settings/visual_script/max_call_stack: - :ref:`int` **debug/settings/visual_script/max_call_stack** Maximum call stack in visual scripting, to avoid infinite recursion. - .. _class_ProjectSettings_display/mouse_cursor/custom_image: +.. _class_ProjectSettings_display/mouse_cursor/custom_image: - :ref:`String` **display/mouse_cursor/custom_image** Custom image for the mouse cursor. - .. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: +.. _class_ProjectSettings_display/mouse_cursor/custom_image_hotspot: - :ref:`Vector2` **display/mouse_cursor/custom_image_hotspot** Hotspot for the custom mouse cursor image. - .. _class_ProjectSettings_display/window/allow_per_pixel_transparency: +.. _class_ProjectSettings_display/window/allow_per_pixel_transparency: - :ref:`bool` **display/window/allow_per_pixel_transparency** Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off. - .. _class_ProjectSettings_display/window/dpi/allow_hidpi: +.. _class_ProjectSettings_display/window/dpi/allow_hidpi: - :ref:`bool` **display/window/dpi/allow_hidpi** Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled. - .. _class_ProjectSettings_display/window/energy_saving/keep_screen_on: +.. _class_ProjectSettings_display/window/energy_saving/keep_screen_on: - :ref:`bool` **display/window/energy_saving/keep_screen_on** Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile. - .. _class_ProjectSettings_display/window/handheld/orientation: +.. _class_ProjectSettings_display/window/handheld/orientation: - :ref:`String` **display/window/handheld/orientation** Default orientation for cell phone or tablet. - .. _class_ProjectSettings_display/window/per_pixel_transparency: +.. _class_ProjectSettings_display/window/per_pixel_transparency: - :ref:`bool` **display/window/per_pixel_transparency** - .. _class_ProjectSettings_display/window/per_pixel_transparency_splash: +.. _class_ProjectSettings_display/window/per_pixel_transparency_splash: - :ref:`bool` **display/window/per_pixel_transparency_splash** - .. _class_ProjectSettings_display/window/size/always_on_top: +.. _class_ProjectSettings_display/window/size/always_on_top: - :ref:`bool` **display/window/size/always_on_top** Force the window to be always on top. - .. _class_ProjectSettings_display/window/size/borderless: +.. _class_ProjectSettings_display/window/size/borderless: - :ref:`bool` **display/window/size/borderless** Force the window to be borderless. - .. _class_ProjectSettings_display/window/size/fullscreen: +.. _class_ProjectSettings_display/window/size/fullscreen: - :ref:`bool` **display/window/size/fullscreen** Set the window to full screen when it starts. - .. _class_ProjectSettings_display/window/size/height: +.. _class_ProjectSettings_display/window/size/height: - :ref:`int` **display/window/size/height** Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. - .. _class_ProjectSettings_display/window/size/resizable: +.. _class_ProjectSettings_display/window/size/resizable: - :ref:`bool` **display/window/size/resizable** Allow the window to be resizable by default. - .. _class_ProjectSettings_display/window/size/test_height: +.. _class_ProjectSettings_display/window/size/test_height: - :ref:`int` **display/window/size/test_height** Test a different height for the window. The main use for this is to test with stretch modes. - .. _class_ProjectSettings_display/window/size/test_width: +.. _class_ProjectSettings_display/window/size/test_width: - :ref:`int` **display/window/size/test_width** Test a different width for the window. The main use for this is to test with stretch modes. - .. _class_ProjectSettings_display/window/size/width: +.. _class_ProjectSettings_display/window/size/width: - :ref:`int` **display/window/size/width** Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also as a reference when enabled. - .. _class_ProjectSettings_display/window/vsync/use_vsync: +.. _class_ProjectSettings_display/window/vsync/use_vsync: - :ref:`bool` **display/window/vsync/use_vsync** Use VSync. Don't be stupid, don't turn this off. - .. _class_ProjectSettings_editor/active: +.. _class_ProjectSettings_editor/active: - :ref:`bool` **editor/active** Internal editor setting, don't touch. - .. _class_ProjectSettings_gui/common/default_scroll_deadzone: +.. _class_ProjectSettings_gui/common/default_scroll_deadzone: - :ref:`int` **gui/common/default_scroll_deadzone** - .. _class_ProjectSettings_gui/common/swap_ok_cancel: +.. _class_ProjectSettings_gui/common/swap_ok_cancel: - :ref:`bool` **gui/common/swap_ok_cancel** Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off. - .. _class_ProjectSettings_gui/theme/custom: +.. _class_ProjectSettings_gui/theme/custom: - :ref:`String` **gui/theme/custom** Use a custom theme resource, set a path to it here. - .. _class_ProjectSettings_gui/theme/custom_font: +.. _class_ProjectSettings_gui/theme/custom_font: - :ref:`String` **gui/theme/custom_font** USe a custom default font resource, set a path to it here. - .. _class_ProjectSettings_gui/theme/use_hidpi: +.. _class_ProjectSettings_gui/theme/use_hidpi: - :ref:`bool` **gui/theme/use_hidpi** Make sure the theme used works with hidpi. - .. _class_ProjectSettings_gui/timers/incremental_search_max_interval_msec: +.. _class_ProjectSettings_gui/timers/incremental_search_max_interval_msec: - :ref:`int` **gui/timers/incremental_search_max_interval_msec** Timer setting for incremental search in Tree, IntemList, etc. controls. - .. _class_ProjectSettings_gui/timers/text_edit_idle_detect_sec: +.. _class_ProjectSettings_gui/timers/text_edit_idle_detect_sec: - :ref:`int` **gui/timers/text_edit_idle_detect_sec** Timer for detecting idle in the editor. - .. _class_ProjectSettings_input/ui_accept: +.. _class_ProjectSettings_input/ui_accept: - :ref:`Dictionary` **input/ui_accept** - .. _class_ProjectSettings_input/ui_cancel: +.. _class_ProjectSettings_input/ui_cancel: - :ref:`Dictionary` **input/ui_cancel** - .. _class_ProjectSettings_input/ui_down: +.. _class_ProjectSettings_input/ui_down: - :ref:`Dictionary` **input/ui_down** - .. _class_ProjectSettings_input/ui_end: +.. _class_ProjectSettings_input/ui_end: - :ref:`Dictionary` **input/ui_end** - .. _class_ProjectSettings_input/ui_focus_next: +.. _class_ProjectSettings_input/ui_focus_next: - :ref:`Dictionary` **input/ui_focus_next** - .. _class_ProjectSettings_input/ui_focus_prev: +.. _class_ProjectSettings_input/ui_focus_prev: - :ref:`Dictionary` **input/ui_focus_prev** - .. _class_ProjectSettings_input/ui_home: +.. _class_ProjectSettings_input/ui_home: - :ref:`Dictionary` **input/ui_home** - .. _class_ProjectSettings_input/ui_left: +.. _class_ProjectSettings_input/ui_left: - :ref:`Dictionary` **input/ui_left** - .. _class_ProjectSettings_input/ui_page_down: +.. _class_ProjectSettings_input/ui_page_down: - :ref:`Dictionary` **input/ui_page_down** - .. _class_ProjectSettings_input/ui_page_up: +.. _class_ProjectSettings_input/ui_page_up: - :ref:`Dictionary` **input/ui_page_up** - .. _class_ProjectSettings_input/ui_right: +.. _class_ProjectSettings_input/ui_right: - :ref:`Dictionary` **input/ui_right** - .. _class_ProjectSettings_input/ui_select: +.. _class_ProjectSettings_input/ui_select: - :ref:`Dictionary` **input/ui_select** - .. _class_ProjectSettings_input/ui_up: +.. _class_ProjectSettings_input/ui_up: - :ref:`Dictionary` **input/ui_up** - .. _class_ProjectSettings_input_devices/pointing/emulate_mouse_from_touch: +.. _class_ProjectSettings_input_devices/pointing/emulate_mouse_from_touch: - :ref:`bool` **input_devices/pointing/emulate_mouse_from_touch** - .. _class_ProjectSettings_input_devices/pointing/emulate_touch_from_mouse: +.. _class_ProjectSettings_input_devices/pointing/emulate_touch_from_mouse: - :ref:`bool` **input_devices/pointing/emulate_touch_from_mouse** - .. _class_ProjectSettings_layer_names/2d_physics/layer_1: +.. _class_ProjectSettings_layer_names/2d_physics/layer_1: - :ref:`String` **layer_names/2d_physics/layer_1** - .. _class_ProjectSettings_layer_names/2d_physics/layer_10: +.. _class_ProjectSettings_layer_names/2d_physics/layer_10: - :ref:`String` **layer_names/2d_physics/layer_10** - .. _class_ProjectSettings_layer_names/2d_physics/layer_11: +.. _class_ProjectSettings_layer_names/2d_physics/layer_11: - :ref:`String` **layer_names/2d_physics/layer_11** - .. _class_ProjectSettings_layer_names/2d_physics/layer_12: +.. _class_ProjectSettings_layer_names/2d_physics/layer_12: - :ref:`String` **layer_names/2d_physics/layer_12** - .. _class_ProjectSettings_layer_names/2d_physics/layer_13: +.. _class_ProjectSettings_layer_names/2d_physics/layer_13: - :ref:`String` **layer_names/2d_physics/layer_13** - .. _class_ProjectSettings_layer_names/2d_physics/layer_14: +.. _class_ProjectSettings_layer_names/2d_physics/layer_14: - :ref:`String` **layer_names/2d_physics/layer_14** - .. _class_ProjectSettings_layer_names/2d_physics/layer_15: +.. _class_ProjectSettings_layer_names/2d_physics/layer_15: - :ref:`String` **layer_names/2d_physics/layer_15** - .. _class_ProjectSettings_layer_names/2d_physics/layer_16: +.. _class_ProjectSettings_layer_names/2d_physics/layer_16: - :ref:`String` **layer_names/2d_physics/layer_16** - .. _class_ProjectSettings_layer_names/2d_physics/layer_17: +.. _class_ProjectSettings_layer_names/2d_physics/layer_17: - :ref:`String` **layer_names/2d_physics/layer_17** - .. _class_ProjectSettings_layer_names/2d_physics/layer_18: +.. _class_ProjectSettings_layer_names/2d_physics/layer_18: - :ref:`String` **layer_names/2d_physics/layer_18** - .. _class_ProjectSettings_layer_names/2d_physics/layer_19: +.. _class_ProjectSettings_layer_names/2d_physics/layer_19: - :ref:`String` **layer_names/2d_physics/layer_19** - .. _class_ProjectSettings_layer_names/2d_physics/layer_2: +.. _class_ProjectSettings_layer_names/2d_physics/layer_2: - :ref:`String` **layer_names/2d_physics/layer_2** - .. _class_ProjectSettings_layer_names/2d_physics/layer_20: +.. _class_ProjectSettings_layer_names/2d_physics/layer_20: - :ref:`String` **layer_names/2d_physics/layer_20** - .. _class_ProjectSettings_layer_names/2d_physics/layer_3: +.. _class_ProjectSettings_layer_names/2d_physics/layer_3: - :ref:`String` **layer_names/2d_physics/layer_3** - .. _class_ProjectSettings_layer_names/2d_physics/layer_4: +.. _class_ProjectSettings_layer_names/2d_physics/layer_4: - :ref:`String` **layer_names/2d_physics/layer_4** - .. _class_ProjectSettings_layer_names/2d_physics/layer_5: +.. _class_ProjectSettings_layer_names/2d_physics/layer_5: - :ref:`String` **layer_names/2d_physics/layer_5** - .. _class_ProjectSettings_layer_names/2d_physics/layer_6: +.. _class_ProjectSettings_layer_names/2d_physics/layer_6: - :ref:`String` **layer_names/2d_physics/layer_6** - .. _class_ProjectSettings_layer_names/2d_physics/layer_7: +.. _class_ProjectSettings_layer_names/2d_physics/layer_7: - :ref:`String` **layer_names/2d_physics/layer_7** - .. _class_ProjectSettings_layer_names/2d_physics/layer_8: +.. _class_ProjectSettings_layer_names/2d_physics/layer_8: - :ref:`String` **layer_names/2d_physics/layer_8** - .. _class_ProjectSettings_layer_names/2d_physics/layer_9: +.. _class_ProjectSettings_layer_names/2d_physics/layer_9: - :ref:`String` **layer_names/2d_physics/layer_9** - .. _class_ProjectSettings_layer_names/2d_render/layer_1: +.. _class_ProjectSettings_layer_names/2d_render/layer_1: - :ref:`String` **layer_names/2d_render/layer_1** - .. _class_ProjectSettings_layer_names/2d_render/layer_10: +.. _class_ProjectSettings_layer_names/2d_render/layer_10: - :ref:`String` **layer_names/2d_render/layer_10** - .. _class_ProjectSettings_layer_names/2d_render/layer_11: +.. _class_ProjectSettings_layer_names/2d_render/layer_11: - :ref:`String` **layer_names/2d_render/layer_11** - .. _class_ProjectSettings_layer_names/2d_render/layer_12: +.. _class_ProjectSettings_layer_names/2d_render/layer_12: - :ref:`String` **layer_names/2d_render/layer_12** - .. _class_ProjectSettings_layer_names/2d_render/layer_13: +.. _class_ProjectSettings_layer_names/2d_render/layer_13: - :ref:`String` **layer_names/2d_render/layer_13** - .. _class_ProjectSettings_layer_names/2d_render/layer_14: +.. _class_ProjectSettings_layer_names/2d_render/layer_14: - :ref:`String` **layer_names/2d_render/layer_14** - .. _class_ProjectSettings_layer_names/2d_render/layer_15: +.. _class_ProjectSettings_layer_names/2d_render/layer_15: - :ref:`String` **layer_names/2d_render/layer_15** - .. _class_ProjectSettings_layer_names/2d_render/layer_16: +.. _class_ProjectSettings_layer_names/2d_render/layer_16: - :ref:`String` **layer_names/2d_render/layer_16** - .. _class_ProjectSettings_layer_names/2d_render/layer_17: +.. _class_ProjectSettings_layer_names/2d_render/layer_17: - :ref:`String` **layer_names/2d_render/layer_17** - .. _class_ProjectSettings_layer_names/2d_render/layer_18: +.. _class_ProjectSettings_layer_names/2d_render/layer_18: - :ref:`String` **layer_names/2d_render/layer_18** - .. _class_ProjectSettings_layer_names/2d_render/layer_19: +.. _class_ProjectSettings_layer_names/2d_render/layer_19: - :ref:`String` **layer_names/2d_render/layer_19** - .. _class_ProjectSettings_layer_names/2d_render/layer_2: +.. _class_ProjectSettings_layer_names/2d_render/layer_2: - :ref:`String` **layer_names/2d_render/layer_2** - .. _class_ProjectSettings_layer_names/2d_render/layer_20: +.. _class_ProjectSettings_layer_names/2d_render/layer_20: - :ref:`String` **layer_names/2d_render/layer_20** - .. _class_ProjectSettings_layer_names/2d_render/layer_3: +.. _class_ProjectSettings_layer_names/2d_render/layer_3: - :ref:`String` **layer_names/2d_render/layer_3** - .. _class_ProjectSettings_layer_names/2d_render/layer_4: +.. _class_ProjectSettings_layer_names/2d_render/layer_4: - :ref:`String` **layer_names/2d_render/layer_4** - .. _class_ProjectSettings_layer_names/2d_render/layer_5: +.. _class_ProjectSettings_layer_names/2d_render/layer_5: - :ref:`String` **layer_names/2d_render/layer_5** - .. _class_ProjectSettings_layer_names/2d_render/layer_6: +.. _class_ProjectSettings_layer_names/2d_render/layer_6: - :ref:`String` **layer_names/2d_render/layer_6** - .. _class_ProjectSettings_layer_names/2d_render/layer_7: +.. _class_ProjectSettings_layer_names/2d_render/layer_7: - :ref:`String` **layer_names/2d_render/layer_7** - .. _class_ProjectSettings_layer_names/2d_render/layer_8: +.. _class_ProjectSettings_layer_names/2d_render/layer_8: - :ref:`String` **layer_names/2d_render/layer_8** - .. _class_ProjectSettings_layer_names/2d_render/layer_9: +.. _class_ProjectSettings_layer_names/2d_render/layer_9: - :ref:`String` **layer_names/2d_render/layer_9** - .. _class_ProjectSettings_layer_names/3d_physics/layer_1: +.. _class_ProjectSettings_layer_names/3d_physics/layer_1: - :ref:`String` **layer_names/3d_physics/layer_1** - .. _class_ProjectSettings_layer_names/3d_physics/layer_10: +.. _class_ProjectSettings_layer_names/3d_physics/layer_10: - :ref:`String` **layer_names/3d_physics/layer_10** - .. _class_ProjectSettings_layer_names/3d_physics/layer_11: +.. _class_ProjectSettings_layer_names/3d_physics/layer_11: - :ref:`String` **layer_names/3d_physics/layer_11** - .. _class_ProjectSettings_layer_names/3d_physics/layer_12: +.. _class_ProjectSettings_layer_names/3d_physics/layer_12: - :ref:`String` **layer_names/3d_physics/layer_12** - .. _class_ProjectSettings_layer_names/3d_physics/layer_13: +.. _class_ProjectSettings_layer_names/3d_physics/layer_13: - :ref:`String` **layer_names/3d_physics/layer_13** - .. _class_ProjectSettings_layer_names/3d_physics/layer_14: +.. _class_ProjectSettings_layer_names/3d_physics/layer_14: - :ref:`String` **layer_names/3d_physics/layer_14** - .. _class_ProjectSettings_layer_names/3d_physics/layer_15: +.. _class_ProjectSettings_layer_names/3d_physics/layer_15: - :ref:`String` **layer_names/3d_physics/layer_15** - .. _class_ProjectSettings_layer_names/3d_physics/layer_16: +.. _class_ProjectSettings_layer_names/3d_physics/layer_16: - :ref:`String` **layer_names/3d_physics/layer_16** - .. _class_ProjectSettings_layer_names/3d_physics/layer_17: +.. _class_ProjectSettings_layer_names/3d_physics/layer_17: - :ref:`String` **layer_names/3d_physics/layer_17** - .. _class_ProjectSettings_layer_names/3d_physics/layer_18: +.. _class_ProjectSettings_layer_names/3d_physics/layer_18: - :ref:`String` **layer_names/3d_physics/layer_18** - .. _class_ProjectSettings_layer_names/3d_physics/layer_19: +.. _class_ProjectSettings_layer_names/3d_physics/layer_19: - :ref:`String` **layer_names/3d_physics/layer_19** - .. _class_ProjectSettings_layer_names/3d_physics/layer_2: +.. _class_ProjectSettings_layer_names/3d_physics/layer_2: - :ref:`String` **layer_names/3d_physics/layer_2** - .. _class_ProjectSettings_layer_names/3d_physics/layer_20: +.. _class_ProjectSettings_layer_names/3d_physics/layer_20: - :ref:`String` **layer_names/3d_physics/layer_20** - .. _class_ProjectSettings_layer_names/3d_physics/layer_3: +.. _class_ProjectSettings_layer_names/3d_physics/layer_3: - :ref:`String` **layer_names/3d_physics/layer_3** - .. _class_ProjectSettings_layer_names/3d_physics/layer_4: +.. _class_ProjectSettings_layer_names/3d_physics/layer_4: - :ref:`String` **layer_names/3d_physics/layer_4** - .. _class_ProjectSettings_layer_names/3d_physics/layer_5: +.. _class_ProjectSettings_layer_names/3d_physics/layer_5: - :ref:`String` **layer_names/3d_physics/layer_5** - .. _class_ProjectSettings_layer_names/3d_physics/layer_6: +.. _class_ProjectSettings_layer_names/3d_physics/layer_6: - :ref:`String` **layer_names/3d_physics/layer_6** - .. _class_ProjectSettings_layer_names/3d_physics/layer_7: +.. _class_ProjectSettings_layer_names/3d_physics/layer_7: - :ref:`String` **layer_names/3d_physics/layer_7** - .. _class_ProjectSettings_layer_names/3d_physics/layer_8: +.. _class_ProjectSettings_layer_names/3d_physics/layer_8: - :ref:`String` **layer_names/3d_physics/layer_8** - .. _class_ProjectSettings_layer_names/3d_physics/layer_9: +.. _class_ProjectSettings_layer_names/3d_physics/layer_9: - :ref:`String` **layer_names/3d_physics/layer_9** - .. _class_ProjectSettings_layer_names/3d_render/layer_1: +.. _class_ProjectSettings_layer_names/3d_render/layer_1: - :ref:`String` **layer_names/3d_render/layer_1** - .. _class_ProjectSettings_layer_names/3d_render/layer_10: +.. _class_ProjectSettings_layer_names/3d_render/layer_10: - :ref:`String` **layer_names/3d_render/layer_10** - .. _class_ProjectSettings_layer_names/3d_render/layer_11: +.. _class_ProjectSettings_layer_names/3d_render/layer_11: - :ref:`String` **layer_names/3d_render/layer_11** - .. _class_ProjectSettings_layer_names/3d_render/layer_12: +.. _class_ProjectSettings_layer_names/3d_render/layer_12: - :ref:`String` **layer_names/3d_render/layer_12** - .. _class_ProjectSettings_layer_names/3d_render/layer_13: +.. _class_ProjectSettings_layer_names/3d_render/layer_13: - :ref:`String` **layer_names/3d_render/layer_13** - .. _class_ProjectSettings_layer_names/3d_render/layer_14: +.. _class_ProjectSettings_layer_names/3d_render/layer_14: - :ref:`String` **layer_names/3d_render/layer_14** - .. _class_ProjectSettings_layer_names/3d_render/layer_15: +.. _class_ProjectSettings_layer_names/3d_render/layer_15: - :ref:`String` **layer_names/3d_render/layer_15** - .. _class_ProjectSettings_layer_names/3d_render/layer_16: +.. _class_ProjectSettings_layer_names/3d_render/layer_16: - :ref:`String` **layer_names/3d_render/layer_16** - .. _class_ProjectSettings_layer_names/3d_render/layer_17: +.. _class_ProjectSettings_layer_names/3d_render/layer_17: - :ref:`String` **layer_names/3d_render/layer_17** - .. _class_ProjectSettings_layer_names/3d_render/layer_18: +.. _class_ProjectSettings_layer_names/3d_render/layer_18: - :ref:`String` **layer_names/3d_render/layer_18** - .. _class_ProjectSettings_layer_names/3d_render/layer_19: +.. _class_ProjectSettings_layer_names/3d_render/layer_19: - :ref:`String` **layer_names/3d_render/layer_19** - .. _class_ProjectSettings_layer_names/3d_render/layer_2: +.. _class_ProjectSettings_layer_names/3d_render/layer_2: - :ref:`String` **layer_names/3d_render/layer_2** - .. _class_ProjectSettings_layer_names/3d_render/layer_20: +.. _class_ProjectSettings_layer_names/3d_render/layer_20: - :ref:`String` **layer_names/3d_render/layer_20** - .. _class_ProjectSettings_layer_names/3d_render/layer_3: +.. _class_ProjectSettings_layer_names/3d_render/layer_3: - :ref:`String` **layer_names/3d_render/layer_3** - .. _class_ProjectSettings_layer_names/3d_render/layer_4: +.. _class_ProjectSettings_layer_names/3d_render/layer_4: - :ref:`String` **layer_names/3d_render/layer_4** - .. _class_ProjectSettings_layer_names/3d_render/layer_5: +.. _class_ProjectSettings_layer_names/3d_render/layer_5: - :ref:`String` **layer_names/3d_render/layer_5** - .. _class_ProjectSettings_layer_names/3d_render/layer_6: +.. _class_ProjectSettings_layer_names/3d_render/layer_6: - :ref:`String` **layer_names/3d_render/layer_6** - .. _class_ProjectSettings_layer_names/3d_render/layer_7: +.. _class_ProjectSettings_layer_names/3d_render/layer_7: - :ref:`String` **layer_names/3d_render/layer_7** - .. _class_ProjectSettings_layer_names/3d_render/layer_8: +.. _class_ProjectSettings_layer_names/3d_render/layer_8: - :ref:`String` **layer_names/3d_render/layer_8** - .. _class_ProjectSettings_layer_names/3d_render/layer_9: +.. _class_ProjectSettings_layer_names/3d_render/layer_9: - :ref:`String` **layer_names/3d_render/layer_9** - .. _class_ProjectSettings_locale/fallback: +.. _class_ProjectSettings_locale/fallback: - :ref:`String` **locale/fallback** - .. _class_ProjectSettings_locale/test: +.. _class_ProjectSettings_locale/test: - :ref:`String` **locale/test** - .. _class_ProjectSettings_logging/file_logging/enable_file_logging: +.. _class_ProjectSettings_logging/file_logging/enable_file_logging: - :ref:`bool` **logging/file_logging/enable_file_logging** Log all output to a file. - .. _class_ProjectSettings_logging/file_logging/log_path: +.. _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. - .. _class_ProjectSettings_logging/file_logging/max_log_files: +.. _class_ProjectSettings_logging/file_logging/max_log_files: - :ref:`int` **logging/file_logging/max_log_files** Amount of log files (used for rotation)/ - .. _class_ProjectSettings_memory/limits/message_queue/max_size_kb: +.. _class_ProjectSettings_memory/limits/message_queue/max_size_kb: - :ref:`int` **memory/limits/message_queue/max_size_kb** Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. - .. _class_ProjectSettings_memory/limits/multithreaded_server/rid_pool_prealloc: +.. _class_ProjectSettings_memory/limits/multithreaded_server/rid_pool_prealloc: - :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: +.. _class_ProjectSettings_mono/debugger_agent/port: - :ref:`int` **mono/debugger_agent/port** - .. _class_ProjectSettings_mono/debugger_agent/wait_for_debugger: +.. _class_ProjectSettings_mono/debugger_agent/wait_for_debugger: - :ref:`bool` **mono/debugger_agent/wait_for_debugger** - .. _class_ProjectSettings_mono/debugger_agent/wait_timeout: +.. _class_ProjectSettings_mono/debugger_agent/wait_timeout: - :ref:`int` **mono/debugger_agent/wait_timeout** - .. _class_ProjectSettings_mono/export/include_scripts_content: +.. _class_ProjectSettings_mono/export/include_scripts_content: - :ref:`bool` **mono/export/include_scripts_content** - .. _class_ProjectSettings_network/limits/debugger_stdout/max_chars_per_second: +.. _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. - .. _class_ProjectSettings_network/limits/debugger_stdout/max_errors_per_frame: +.. _class_ProjectSettings_network/limits/debugger_stdout/max_errors_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_errors_per_frame** Maximum amount of errors allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. - .. _class_ProjectSettings_network/limits/debugger_stdout/max_messages_per_frame: +.. _class_ProjectSettings_network/limits/debugger_stdout/max_messages_per_frame: - :ref:`int` **network/limits/debugger_stdout/max_messages_per_frame** Maximum amount of messages allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection. - .. _class_ProjectSettings_network/limits/packet_peer_stream/max_buffer_po2: +.. _class_ProjectSettings_network/limits/packet_peer_stream/max_buffer_po2: - :ref:`int` **network/limits/packet_peer_stream/max_buffer_po2** Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. - .. _class_ProjectSettings_network/remote_fs/max_pages: +.. _class_ProjectSettings_network/remote_fs/max_pages: - :ref:`int` **network/remote_fs/max_pages** Maximum amount of pages used for remote filesystem (used by debugging). - .. _class_ProjectSettings_network/remote_fs/page_read_ahead: +.. _class_ProjectSettings_network/remote_fs/page_read_ahead: - :ref:`int` **network/remote_fs/page_read_ahead** Amount of read ahead used by remote filesystem. Improves latency. - .. _class_ProjectSettings_network/remote_fs/page_size: +.. _class_ProjectSettings_network/remote_fs/page_size: - :ref:`int` **network/remote_fs/page_size** Page size used by remote filesystem. - .. _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. - - .. _class_ProjectSettings_node/name_casing: +.. _class_ProjectSettings_node/name_casing: - :ref:`int` **node/name_casing** When creating nodes names automatically, set the type of casing in this project. This is mostly an editor setting. - .. _class_ProjectSettings_node/name_num_separator: +.. _class_ProjectSettings_node/name_num_separator: - :ref:`int` **node/name_num_separator** What to use to separate node name from number. This is mostly an editor setting. - .. _class_ProjectSettings_physics/2d/physics_engine: +.. _class_ProjectSettings_physics/2d/physics_engine: - :ref:`String` **physics/2d/physics_engine** - .. _class_ProjectSettings_physics/2d/thread_model: +.. _class_ProjectSettings_physics/2d/thread_model: - :ref:`int` **physics/2d/thread_model** Set whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API Access to only physics process. - .. _class_ProjectSettings_physics/3d/active_soft_world: +.. _class_ProjectSettings_physics/3d/active_soft_world: - :ref:`bool` **physics/3d/active_soft_world** - .. _class_ProjectSettings_physics/3d/physics_engine: +.. _class_ProjectSettings_physics/3d/physics_engine: - :ref:`String` **physics/3d/physics_engine** - .. _class_ProjectSettings_physics/common/physics_fps: +.. _class_ProjectSettings_physics/common/physics_fps: - :ref:`int` **physics/common/physics_fps** Frames per second used in the physics. Physics always needs a fixed amount of frames per second. - .. _class_ProjectSettings_physics/common/physics_jitter_fix: +.. _class_ProjectSettings_physics/common/physics_jitter_fix: - :ref:`float` **physics/common/physics_jitter_fix** Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS. - .. _class_ProjectSettings_rendering/environment/default_clear_color: +.. _class_ProjectSettings_rendering/environment/default_clear_color: - :ref:`Color` **rendering/environment/default_clear_color** Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`VisualServer.set_default_clear_color`. - .. _class_ProjectSettings_rendering/limits/buffers/blend_shape_max_buffer_size_kb: +.. _class_ProjectSettings_rendering/limits/buffers/blend_shape_max_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/blend_shape_max_buffer_size_kb** Max buffer size for blend shapes. Any blend shape bigger than this will not work. - .. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_buffer_size_kb: +.. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_buffer_size_kb** Max buffer size for drawing polygons. Any polygon bigger than this will not work. - .. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: +.. _class_ProjectSettings_rendering/limits/buffers/canvas_polygon_index_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/canvas_polygon_index_buffer_size_kb** Max index buffer size for drawing polygons. Any polygon bigger than this will not work. - .. _class_ProjectSettings_rendering/limits/buffers/immediate_buffer_size_kb: +.. _class_ProjectSettings_rendering/limits/buffers/immediate_buffer_size_kb: - :ref:`int` **rendering/limits/buffers/immediate_buffer_size_kb** Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work. - .. _class_ProjectSettings_rendering/limits/rendering/max_renderable_elements: +.. _class_ProjectSettings_rendering/limits/rendering/max_renderable_elements: - :ref:`int` **rendering/limits/rendering/max_renderable_elements** Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. - .. _class_ProjectSettings_rendering/limits/time/time_rollover_secs: +.. _class_ProjectSettings_rendering/limits/time/time_rollover_secs: - :ref:`int` **rendering/limits/time/time_rollover_secs** Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. - .. _class_ProjectSettings_rendering/quality/2d/use_pixel_snap: +.. _class_ProjectSettings_rendering/quality/2d/use_pixel_snap: - :ref:`bool` **rendering/quality/2d/use_pixel_snap** Force snapping of polygons to pixels in 2D rendering. May help in some pixel art styles. - .. _class_ProjectSettings_rendering/quality/depth_prepass/disable_for_vendors: +.. _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. - .. _class_ProjectSettings_rendering/quality/depth_prepass/enable: +.. _class_ProjectSettings_rendering/quality/depth_prepass/enable: - :ref:`bool` **rendering/quality/depth_prepass/enable** Do a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. - .. _class_ProjectSettings_rendering/quality/directional_shadow/size: +.. _class_ProjectSettings_rendering/quality/directional_shadow/size: - :ref:`int` **rendering/quality/directional_shadow/size** Size in pixels of the directional shadow. - .. _class_ProjectSettings_rendering/quality/directional_shadow/size.mobile: +.. _class_ProjectSettings_rendering/quality/directional_shadow/size.mobile: - :ref:`int` **rendering/quality/directional_shadow/size.mobile** - .. _class_ProjectSettings_rendering/quality/driver/driver_fallback: +.. _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: +.. _class_ProjectSettings_rendering/quality/driver/driver_name: - :ref:`String` **rendering/quality/driver/driver_name** - .. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: +.. _class_ProjectSettings_rendering/quality/filters/anisotropic_filter_level: - :ref:`int` **rendering/quality/filters/anisotropic_filter_level** Maximum Anisotropic filter level used for textures when anisotropy enabled. - .. _class_ProjectSettings_rendering/quality/filters/use_nearest_mipmap_filter: +.. _class_ProjectSettings_rendering/quality/filters/use_nearest_mipmap_filter: - :ref:`bool` **rendering/quality/filters/use_nearest_mipmap_filter** Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used. - .. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation: +.. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation** Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports). - .. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation.mobile: +.. _class_ProjectSettings_rendering/quality/intended_usage/framebuffer_allocation.mobile: - :ref:`int` **rendering/quality/intended_usage/framebuffer_allocation.mobile** - .. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx: +.. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx** For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness). - .. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx.mobile: +.. _class_ProjectSettings_rendering/quality/reflections/high_quality_ggx.mobile: - :ref:`bool` **rendering/quality/reflections/high_quality_ggx.mobile** - .. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections: +.. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections** For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory. - .. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections.mobile: +.. _class_ProjectSettings_rendering/quality/reflections/texture_array_reflections.mobile: - :ref:`bool` **rendering/quality/reflections/texture_array_reflections.mobile** - .. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading: +.. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading: - :ref:`bool` **rendering/quality/shading/force_vertex_shading** Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile. - .. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading.mobile: +.. _class_ProjectSettings_rendering/quality/shading/force_vertex_shading.mobile: - :ref:`bool` **rendering/quality/shading/force_vertex_shading.mobile** - .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_0_subdiv: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_0_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_0_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_1_subdiv: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_1_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_1_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_2_subdiv: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_2_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_2_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - .. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_3_subdiv: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/quadrant_3_subdiv: - :ref:`int` **rendering/quality/shadow_atlas/quadrant_3_subdiv** Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - .. _class_ProjectSettings_rendering/quality/shadow_atlas/size: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/size: - :ref:`int` **rendering/quality/shadow_atlas/size** Size for shadow atlas (used for point and omni lights). See documentation. - .. _class_ProjectSettings_rendering/quality/shadow_atlas/size.mobile: +.. _class_ProjectSettings_rendering/quality/shadow_atlas/size.mobile: - :ref:`int` **rendering/quality/shadow_atlas/size.mobile** - .. _class_ProjectSettings_rendering/quality/shadows/filter_mode: +.. _class_ProjectSettings_rendering/quality/shadows/filter_mode: - :ref:`int` **rendering/quality/shadows/filter_mode** Shadow filter mode. The more complex the filter, the more memory bandwidth required. - .. _class_ProjectSettings_rendering/quality/shadows/filter_mode.mobile: +.. _class_ProjectSettings_rendering/quality/shadows/filter_mode.mobile: - :ref:`int` **rendering/quality/shadows/filter_mode.mobile** - .. _class_ProjectSettings_rendering/quality/subsurface_scattering/follow_surface: +.. _class_ProjectSettings_rendering/quality/subsurface_scattering/follow_surface: - :ref:`bool` **rendering/quality/subsurface_scattering/follow_surface** Improves quality of subsurface scattering, but cost significantly increases. - .. _class_ProjectSettings_rendering/quality/subsurface_scattering/quality: +.. _class_ProjectSettings_rendering/quality/subsurface_scattering/quality: - :ref:`int` **rendering/quality/subsurface_scattering/quality** Quality setting for subsurface scaterring (samples taken). - .. _class_ProjectSettings_rendering/quality/subsurface_scattering/scale: +.. _class_ProjectSettings_rendering/quality/subsurface_scattering/scale: - :ref:`int` **rendering/quality/subsurface_scattering/scale** - .. _class_ProjectSettings_rendering/quality/subsurface_scattering/weight_samples: +.. _class_ProjectSettings_rendering/quality/subsurface_scattering/weight_samples: - :ref:`bool` **rendering/quality/subsurface_scattering/weight_samples** Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen. - .. _class_ProjectSettings_rendering/quality/voxel_cone_tracing/high_quality: +.. _class_ProjectSettings_rendering/quality/voxel_cone_tracing/high_quality: - :ref:`bool` **rendering/quality/voxel_cone_tracing/high_quality** Use high quality voxel cone tracing (looks better, but requires a higher end GPU). - .. _class_ProjectSettings_rendering/threads/thread_model: +.. _class_ProjectSettings_rendering/threads/thread_model: - :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: +.. _class_ProjectSettings_rendering/vram_compression/import_bptc: - :ref:`bool` **rendering/vram_compression/import_bptc** - .. _class_ProjectSettings_rendering/vram_compression/import_etc: +.. _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. - .. _class_ProjectSettings_rendering/vram_compression/import_etc2: +.. _class_ProjectSettings_rendering/vram_compression/import_etc2: - :ref:`bool` **rendering/vram_compression/import_etc2** If the project uses this compression (usually high end mobile), texture importer will import these. - .. _class_ProjectSettings_rendering/vram_compression/import_pvrtc: +.. _class_ProjectSettings_rendering/vram_compression/import_pvrtc: - :ref:`bool` **rendering/vram_compression/import_pvrtc** If the project uses this compression (usually iOS), texture importer will import these. - .. _class_ProjectSettings_rendering/vram_compression/import_s3tc: +.. _class_ProjectSettings_rendering/vram_compression/import_s3tc: - :ref:`bool` **rendering/vram_compression/import_s3tc** If the project uses this compression (usually Desktop and Consoles), texture importer will import these. - .. _class_ProjectSettings_script: +.. _class_ProjectSettings_script: - :ref:`Script` **script** Method Descriptions ------------------- - .. _class_ProjectSettings_add_property_info: +.. _class_ProjectSettings_add_property_info: - void **add_property_info** **(** :ref:`Dictionary` hint **)** @@ -1780,71 +1772,71 @@ Example: ProjectSettings.add_property_info(property_info) - .. _class_ProjectSettings_clear: +.. _class_ProjectSettings_clear: - void **clear** **(** :ref:`String` name **)** Clear the whole configuration (not recommended, may break things). - .. _class_ProjectSettings_get_order: +.. _class_ProjectSettings_get_order: - :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: +.. _class_ProjectSettings_get_setting: - :ref:`Variant` **get_setting** **(** :ref:`String` name **)** const - .. _class_ProjectSettings_globalize_path: +.. _class_ProjectSettings_globalize_path: - :ref:`String` **globalize_path** **(** :ref:`String` path **)** const Convert a localized path (res://) to a full native OS path. - .. _class_ProjectSettings_has_setting: +.. _class_ProjectSettings_has_setting: - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const Return true if a configuration value is present. - .. _class_ProjectSettings_load_resource_pack: +.. _class_ProjectSettings_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** - .. _class_ProjectSettings_localize_path: +.. _class_ProjectSettings_localize_path: - :ref:`String` **localize_path** **(** :ref:`String` path **)** const Convert a path to a localized path (res:// path). - .. _class_ProjectSettings_property_can_revert: +.. _class_ProjectSettings_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** - .. _class_ProjectSettings_property_get_revert: +.. _class_ProjectSettings_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** - .. _class_ProjectSettings_save: +.. _class_ProjectSettings_save: - :ref:`Error` **save** **(** **)** - .. _class_ProjectSettings_save_custom: +.. _class_ProjectSettings_save_custom: - :ref:`Error` **save_custom** **(** :ref:`String` file **)** - .. _class_ProjectSettings_set_initial_value: +.. _class_ProjectSettings_set_initial_value: - void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** - .. _class_ProjectSettings_set_order: +.. _class_ProjectSettings_set_order: - 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: +.. _class_ProjectSettings_set_setting: - void **set_setting** **(** :ref:`String` name, :ref:`Variant` value **)** diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index 72b5632fc..527600c32 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -37,14 +37,14 @@ Methods Signals ------- - .. _class_ProximityGroup_broadcast: +.. _class_ProximityGroup_broadcast: - **broadcast** **(** :ref:`String` group_name, :ref:`Array` parameters **)** Enumerations ------------ - .. _enum_ProximityGroup_DispatchMode: +.. _enum_ProximityGroup_DispatchMode: enum **DispatchMode**: @@ -59,7 +59,7 @@ General purpose proximity-detection node. Property Descriptions --------------------- - .. _class_ProximityGroup_dispatch_mode: +.. _class_ProximityGroup_dispatch_mode: - :ref:`DispatchMode` **dispatch_mode** @@ -69,7 +69,7 @@ Property Descriptions | *Getter* | get_dispatch_mode() | +----------+--------------------------+ - .. _class_ProximityGroup_grid_radius: +.. _class_ProximityGroup_grid_radius: - :ref:`Vector3` **grid_radius** @@ -79,7 +79,7 @@ Property Descriptions | *Getter* | get_grid_radius() | +----------+------------------------+ - .. _class_ProximityGroup_group_name: +.. _class_ProximityGroup_group_name: - :ref:`String` **group_name** @@ -92,7 +92,7 @@ Property Descriptions Method Descriptions ------------------- - .. _class_ProximityGroup_broadcast: +.. _class_ProximityGroup_broadcast: - void **broadcast** **(** :ref:`String` name, :ref:`Variant` parameters **)** diff --git a/classes/class_proxytexture.rst b/classes/class_proxytexture.rst index 10f49a561..37fa6be57 100644 --- a/classes/class_proxytexture.rst +++ b/classes/class_proxytexture.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_ProxyTexture_base: +.. _class_ProxyTexture_base: - :ref:`Texture` **base** diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index ce542e644..55d6027cb 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -31,7 +31,7 @@ Class representing a square mesh with size (2,2,0). Consider using a :ref:`Plane Property Descriptions --------------------- - .. _class_QuadMesh_size: +.. _class_QuadMesh_size: - :ref:`Vector2` **size** diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 2b7592ce5..1ebeab3ca 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -70,6 +70,7 @@ Constants --------- - **IDENTITY** = **Quat( 0, 0, 0, 1 )** + Description ----------- @@ -83,29 +84,31 @@ 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: +.. _class_Quat_w: - :ref:`float` **w** W component of the quaternion. Default value: ``1`` - .. _class_Quat_x: +.. _class_Quat_x: - :ref:`float` **x** X component of the quaternion. Default value: ``0`` - .. _class_Quat_y: +.. _class_Quat_y: - :ref:`float` **y** Y component of the quaternion. Default value: ``0`` - .. _class_Quat_z: +.. _class_Quat_z: - :ref:`float` **z** @@ -114,103 +117,103 @@ Z component of the quaternion. Default value: ``0`` Method Descriptions ------------------- - .. _class_Quat_Quat: +.. _class_Quat_Quat: - :ref:`Quat` **Quat** **(** :ref:`Basis` from **)** Returns the rotation matrix corresponding to the given quaternion. - .. _class_Quat_Quat: +.. _class_Quat_Quat: - :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: +.. _class_Quat_Quat: - :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: +.. _class_Quat_Quat: - :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: +.. _class_Quat_cubic_slerp: - :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: +.. _class_Quat_dot: - :ref:`float` **dot** **(** :ref:`Quat` b **)** Returns the dot product of two quaternions. - .. _class_Quat_get_euler: +.. _class_Quat_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: +.. _class_Quat_inverse: - :ref:`Quat` **inverse** **(** **)** Returns the inverse of the quaternion. - .. _class_Quat_is_normalized: +.. _class_Quat_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns whether the quaternion is normalized or not. - .. _class_Quat_length: +.. _class_Quat_length: - :ref:`float` **length** **(** **)** Returns the length of the quaternion. - .. _class_Quat_length_squared: +.. _class_Quat_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the length of the quaternion, squared. - .. _class_Quat_normalized: +.. _class_Quat_normalized: - :ref:`Quat` **normalized** **(** **)** Returns a copy of the quaternion, normalized to unit length. - .. _class_Quat_set_axis_angle: +.. _class_Quat_set_axis_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: +.. _class_Quat_set_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: +.. _class_Quat_slerp: - :ref:`Quat` **slerp** **(** :ref:`Quat` b, :ref:`float` t **)** Performs a spherical-linear interpolation with another quaternion. - .. _class_Quat_slerpni: +.. _class_Quat_slerpni: - :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: +.. _class_Quat_xform: - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** diff --git a/classes/class_range.rst b/classes/class_range.rst index 875de2a6f..b65b40a9d 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -55,13 +55,13 @@ Methods Signals ------- - .. _class_Range_changed: +.. _class_Range_changed: - **changed** **(** **)** Emitted when :ref:`min_value`, :ref:`max_value`, :ref:`page`, or :ref:`step` change. - .. _class_Range_value_changed: +.. _class_Range_value_changed: - **value_changed** **(** :ref:`float` value **)** @@ -75,7 +75,7 @@ Range is a base class for :ref:`Control` nodes that change a floa Property Descriptions --------------------- - .. _class_Range_allow_greater: +.. _class_Range_allow_greater: - :ref:`bool` **allow_greater** @@ -87,7 +87,7 @@ Property Descriptions If ``true`` :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. - .. _class_Range_allow_lesser: +.. _class_Range_allow_lesser: - :ref:`bool` **allow_lesser** @@ -99,7 +99,7 @@ If ``true`` :ref:`value` may be greater than :ref:`max_value< If ``true`` :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. - .. _class_Range_exp_edit: +.. _class_Range_exp_edit: - :ref:`bool` **exp_edit** @@ -111,7 +111,7 @@ If ``true`` :ref:`value` may be less than :ref:`min_value` **max_value** @@ -123,7 +123,7 @@ If ``true`` and ``min_value`` is greater than 0, ``value`` will be represented e Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Default value: ``100``. - .. _class_Range_min_value: +.. _class_Range_min_value: - :ref:`float` **min_value** @@ -135,7 +135,7 @@ Maximum value. Range is clamped if ``value`` is greater than ``max_value``. Defa Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default value: ``0``. - .. _class_Range_page: +.. _class_Range_page: - :ref:`float` **page** @@ -147,7 +147,7 @@ Minimum value. Range is clamped if ``value`` is less than ``min_value``. Default 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: +.. _class_Range_ratio: - :ref:`float` **ratio** @@ -159,7 +159,7 @@ Page size. Used mainly for :ref:`ScrollBar`. ScrollBar's length The value mapped between 0 and 1. - .. _class_Range_rounded: +.. _class_Range_rounded: - :ref:`bool` **rounded** @@ -171,7 +171,7 @@ The value mapped between 0 and 1. If ``true`` ``value`` will always be rounded to the nearest integer. Default value: ``false``. - .. _class_Range_step: +.. _class_Range_step: - :ref:`float` **step** @@ -183,7 +183,7 @@ If ``true`` ``value`` will always be rounded to the nearest integer. Default val If greater than 0, ``value`` will always be rounded to a multiple of ``step``. If ``rounded`` is also ``true``, ``value`` will first be rounded to a multiple of ``step`` then rounded to the nearest integer. - .. _class_Range_value: +.. _class_Range_value: - :ref:`float` **value** @@ -198,13 +198,13 @@ Range's current value. Method Descriptions ------------------- - .. _class_Range_share: +.. _class_Range_share: - 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. - .. _class_Range_unshare: +.. _class_Range_unshare: - void **unshare** **(** **)** diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index e1134e657..89d6aef0b 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -80,7 +80,7 @@ RayCast calculates intersection every physics frame (see :ref:`Node` Property Descriptions --------------------- - .. _class_RayCast_cast_to: +.. _class_RayCast_cast_to: - :ref:`Vector3` **cast_to** @@ -92,7 +92,7 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. - .. _class_RayCast_collide_with_areas: +.. _class_RayCast_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -104,7 +104,7 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area`\ s will be reported. Default value: ``false``. - .. _class_RayCast_collide_with_bodies: +.. _class_RayCast_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -116,7 +116,7 @@ If ``true``, collision with :ref:`Area`\ s will be reported. Default If ``true``, collision with :ref:`PhysicsBody`\ s will be reported. Default value: ``true``. - .. _class_RayCast_collision_mask: +.. _class_RayCast_collision_mask: - :ref:`int` **collision_mask** @@ -128,7 +128,7 @@ If ``true``, collision with :ref:`PhysicsBody`\ s will be rep The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. - .. _class_RayCast_enabled: +.. _class_RayCast_enabled: - :ref:`bool` **enabled** @@ -140,7 +140,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true`` collisions will be reported. Default value: ``false``. - .. _class_RayCast_exclude_parent: +.. _class_RayCast_exclude_parent: - :ref:`bool` **exclude_parent** @@ -155,25 +155,25 @@ If ``true`` collisions will be ignored for this RayCast's immediate parent. Defa Method Descriptions ------------------- - .. _class_RayCast_add_exception: +.. _class_RayCast_add_exception: - 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: +.. _class_RayCast_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. - .. _class_RayCast_clear_exceptions: +.. _class_RayCast_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. - .. _class_RayCast_force_raycast_update: +.. _class_RayCast_force_raycast_update: - void **force_raycast_update** **(** **)** @@ -181,55 +181,55 @@ Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. - .. _class_RayCast_get_collider: +.. _class_RayCast_get_collider: - :ref:`Object` **get_collider** **(** **)** const 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: +.. _class_RayCast_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const 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: +.. _class_RayCast_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the bit index passed is turned on. Note that bit indexes range from 0-19. - .. _class_RayCast_get_collision_normal: +.. _class_RayCast_get_collision_normal: - :ref:`Vector3` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. - .. _class_RayCast_get_collision_point: +.. _class_RayCast_get_collision_point: - :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. - .. _class_RayCast_is_colliding: +.. _class_RayCast_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether any object is intersecting with the ray's vector (considering the vector length). - .. _class_RayCast_remove_exception: +.. _class_RayCast_remove_exception: - 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: +.. _class_RayCast_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. - .. _class_RayCast_set_collision_mask_bit: +.. _class_RayCast_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index b88b60d71..c697334c1 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -80,7 +80,7 @@ RayCast2D calculates intersection every physics frame (see :ref:`Node` **cast_to** @@ -92,7 +92,7 @@ Property Descriptions The ray's destination point, relative to the RayCast's ``position``. - .. _class_RayCast2D_collide_with_areas: +.. _class_RayCast2D_collide_with_areas: - :ref:`bool` **collide_with_areas** @@ -104,7 +104,7 @@ The ray's destination point, relative to the RayCast's ``position``. If ``true``, collision with :ref:`Area2D`\ s will be reported. Default value: ``false``. - .. _class_RayCast2D_collide_with_bodies: +.. _class_RayCast2D_collide_with_bodies: - :ref:`bool` **collide_with_bodies** @@ -116,7 +116,7 @@ If ``true``, collision with :ref:`Area2D`\ s will be reported. Def If ``true``, collision with :ref:`PhysicsBody2D`\ s will be reported. Default value: ``true``. - .. _class_RayCast2D_collision_mask: +.. _class_RayCast2D_collision_mask: - :ref:`int` **collision_mask** @@ -128,7 +128,7 @@ If ``true``, collision with :ref:`PhysicsBody2D`\ s will be The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. - .. _class_RayCast2D_enabled: +.. _class_RayCast2D_enabled: - :ref:`bool` **enabled** @@ -140,7 +140,7 @@ The ray's collision mask. Only objects in at least one collision layer enabled i If ``true``, collisions will be reported. Default value: ``false``. - .. _class_RayCast2D_exclude_parent: +.. _class_RayCast2D_exclude_parent: - :ref:`bool` **exclude_parent** @@ -155,79 +155,79 @@ If ``true``, the parent node will be excluded from collision detection. Default Method Descriptions ------------------- - .. _class_RayCast2D_add_exception: +.. _class_RayCast2D_add_exception: - 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: +.. _class_RayCast2D_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. - .. _class_RayCast2D_clear_exceptions: +.. _class_RayCast2D_clear_exceptions: - void **clear_exceptions** **(** **)** Removes all collision exceptions for this ray. - .. _class_RayCast2D_force_raycast_update: +.. _class_RayCast2D_force_raycast_update: - void **force_raycast_update** **(** **)** Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the ray or its parent has changed state. Note: ``enabled == true`` is not required for this to work. - .. _class_RayCast2D_get_collider: +.. _class_RayCast2D_get_collider: - :ref:`Object` **get_collider** **(** **)** const 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: +.. _class_RayCast2D_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const 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: +.. _class_RayCast2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Return an individual bit on the collision mask. - .. _class_RayCast2D_get_collision_normal: +.. _class_RayCast2D_get_collision_normal: - :ref:`Vector2` **get_collision_normal** **(** **)** const Returns the normal of the intersecting object's shape at the collision point. - .. _class_RayCast2D_get_collision_point: +.. _class_RayCast2D_get_collision_point: - :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. - .. _class_RayCast2D_is_colliding: +.. _class_RayCast2D_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether any object is intersecting with the ray's vector (considering the vector length). - .. _class_RayCast2D_remove_exception: +.. _class_RayCast2D_remove_exception: - 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: +.. _class_RayCast2D_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. - .. _class_RayCast2D_set_collision_mask_bit: +.. _class_RayCast2D_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index 54011425f..3133383c0 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -33,7 +33,7 @@ Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody` **length** @@ -45,7 +45,7 @@ Property Descriptions The ray's length. - .. _class_RayShape_slips_on_slope: +.. _class_RayShape_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index 02299975f..8845822da 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -33,7 +33,7 @@ Ray shape for 2D collisions. A ray is not really a collision body, instead it tr Property Descriptions --------------------- - .. _class_RayShape2D_length: +.. _class_RayShape2D_length: - :ref:`float` **length** @@ -45,7 +45,7 @@ Property Descriptions The ray's length. - .. _class_RayShape2D_slips_on_slope: +.. _class_RayShape2D_slips_on_slope: - :ref:`bool` **slips_on_slope** diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index f1c0a8b1a..e3fdaa560 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -67,22 +67,23 @@ Tutorials --------- - :doc:`../tutorials/math/index` + Property Descriptions --------------------- - .. _class_Rect2_end: +.. _class_Rect2_end: - :ref:`Vector2` **end** Ending corner. - .. _class_Rect2_position: +.. _class_Rect2_position: - :ref:`Vector2` **position** Position (starting corner). - .. _class_Rect2_size: +.. _class_Rect2_size: - :ref:`Vector2` **size** @@ -91,85 +92,85 @@ Size from position to end. Method Descriptions ------------------- - .. _class_Rect2_Rect2: +.. _class_Rect2_Rect2: - :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Constructs a ``Rect2`` by position and size. - .. _class_Rect2_Rect2: +.. _class_Rect2_Rect2: - :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: +.. _class_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: +.. _class_Rect2_clip: - :ref:`Rect2` **clip** **(** :ref:`Rect2` b **)** Returns the intersection of this ``Rect2`` and b. - .. _class_Rect2_encloses: +.. _class_Rect2_encloses: - :ref:`bool` **encloses** **(** :ref:`Rect2` b **)** Returns ``true`` if this ``Rect2`` completely encloses another one. - .. _class_Rect2_expand: +.. _class_Rect2_expand: - :ref:`Rect2` **expand** **(** :ref:`Vector2` to **)** Returns this ``Rect2`` expanded to include a given point. - .. _class_Rect2_get_area: +.. _class_Rect2_get_area: - :ref:`float` **get_area** **(** **)** Returns the area of the ``Rect2``. - .. _class_Rect2_grow: +.. _class_Rect2_grow: - :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: +.. _class_Rect2_grow_individual: - :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: +.. _class_Rect2_grow_margin: - :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. - .. _class_Rect2_has_no_area: +.. _class_Rect2_has_no_area: - :ref:`bool` **has_no_area** **(** **)** Returns ``true`` if the ``Rect2`` is flat or empty. - .. _class_Rect2_has_point: +.. _class_Rect2_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector2` point **)** Returns ``true`` if the ``Rect2`` contains a point. - .. _class_Rect2_intersects: +.. _class_Rect2_intersects: - :ref:`bool` **intersects** **(** :ref:`Rect2` b **)** Returns ``true`` if the ``Rect2`` overlaps with another. - .. _class_Rect2_merge: +.. _class_Rect2_merge: - :ref:`Rect2` **merge** **(** :ref:`Rect2` b **)** diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 29cc58154..cba7ff34d 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -31,7 +31,7 @@ Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D Property Descriptions --------------------- - .. _class_RectangleShape2D_extents: +.. _class_RectangleShape2D_extents: - :ref:`Vector2` **extents** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 41d10f1c1..ccc3d432e 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -37,17 +37,17 @@ Base class for anything that keeps a reference count. Resource and many other he Method Descriptions ------------------- - .. _class_Reference_init_ref: +.. _class_Reference_init_ref: - :ref:`bool` **init_ref** **(** **)** - .. _class_Reference_reference: +.. _class_Reference_reference: - :ref:`bool` **reference** **(** **)** Increase the internal reference counter. Use this only if you really know what you are doing. - .. _class_Reference_unreference: +.. _class_Reference_unreference: - :ref:`bool` **unreference** **(** **)** diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 6bf6d9137..12ac3a045 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -31,7 +31,7 @@ Reference frame for GUI. It's just like an empty control, except a red box is di Property Descriptions --------------------- - .. _class_ReferenceRect_border_color: +.. _class_ReferenceRect_border_color: - :ref:`Color` **border_color** diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index e11d6a640..02f8bdb8e 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -48,7 +48,7 @@ Properties Enumerations ------------ - .. _enum_ReflectionProbe_UpdateMode: +.. _enum_ReflectionProbe_UpdateMode: enum **UpdateMode**: @@ -59,10 +59,11 @@ Tutorials --------- - :doc:`../tutorials/3d/reflection_probes` + Property Descriptions --------------------- - .. _class_ReflectionProbe_box_projection: +.. _class_ReflectionProbe_box_projection: - :ref:`bool` **box_projection** @@ -72,7 +73,7 @@ Property Descriptions | *Getter* | is_box_projection_enabled() | +----------+----------------------------------+ - .. _class_ReflectionProbe_cull_mask: +.. _class_ReflectionProbe_cull_mask: - :ref:`int` **cull_mask** @@ -82,7 +83,7 @@ Property Descriptions | *Getter* | get_cull_mask() | +----------+----------------------+ - .. _class_ReflectionProbe_enable_shadows: +.. _class_ReflectionProbe_enable_shadows: - :ref:`bool` **enable_shadows** @@ -92,7 +93,7 @@ Property Descriptions | *Getter* | are_shadows_enabled() | +----------+---------------------------+ - .. _class_ReflectionProbe_extents: +.. _class_ReflectionProbe_extents: - :ref:`Vector3` **extents** @@ -102,7 +103,7 @@ Property Descriptions | *Getter* | get_extents() | +----------+--------------------+ - .. _class_ReflectionProbe_intensity: +.. _class_ReflectionProbe_intensity: - :ref:`float` **intensity** @@ -112,7 +113,7 @@ Property Descriptions | *Getter* | get_intensity() | +----------+----------------------+ - .. _class_ReflectionProbe_interior_ambient_color: +.. _class_ReflectionProbe_interior_ambient_color: - :ref:`Color` **interior_ambient_color** @@ -122,7 +123,7 @@ Property Descriptions | *Getter* | get_interior_ambient() | +----------+-----------------------------+ - .. _class_ReflectionProbe_interior_ambient_contrib: +.. _class_ReflectionProbe_interior_ambient_contrib: - :ref:`float` **interior_ambient_contrib** @@ -132,7 +133,7 @@ Property Descriptions | *Getter* | get_interior_ambient_probe_contribution() | +----------+------------------------------------------------+ - .. _class_ReflectionProbe_interior_ambient_energy: +.. _class_ReflectionProbe_interior_ambient_energy: - :ref:`float` **interior_ambient_energy** @@ -142,7 +143,7 @@ Property Descriptions | *Getter* | get_interior_ambient_energy() | +----------+------------------------------------+ - .. _class_ReflectionProbe_interior_enable: +.. _class_ReflectionProbe_interior_enable: - :ref:`bool` **interior_enable** @@ -152,7 +153,7 @@ Property Descriptions | *Getter* | is_set_as_interior() | +----------+------------------------+ - .. _class_ReflectionProbe_max_distance: +.. _class_ReflectionProbe_max_distance: - :ref:`float` **max_distance** @@ -162,7 +163,7 @@ Property Descriptions | *Getter* | get_max_distance() | +----------+-------------------------+ - .. _class_ReflectionProbe_origin_offset: +.. _class_ReflectionProbe_origin_offset: - :ref:`Vector3` **origin_offset** @@ -172,7 +173,7 @@ Property Descriptions | *Getter* | get_origin_offset() | +----------+--------------------------+ - .. _class_ReflectionProbe_update_mode: +.. _class_ReflectionProbe_update_mode: - :ref:`UpdateMode` **update_mode** diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 35f06d1a1..c06093eec 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -87,55 +87,55 @@ If you need to process multiple results, :ref:`search_all` **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. - .. _class_RegEx_get_group_count: +.. _class_RegEx_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups in compiled pattern. - .. _class_RegEx_get_names: +.. _class_RegEx_get_names: - :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: +.. _class_RegEx_get_pattern: - :ref:`String` **get_pattern** **(** **)** const Returns the original search pattern that was compiled. - .. _class_RegEx_is_valid: +.. _class_RegEx_is_valid: - :ref:`bool` **is_valid** **(** **)** const Returns whether this object has a valid search pattern assigned. - .. _class_RegEx_search: +.. _class_RegEx_search: - :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. - .. _class_RegEx_search_all: +.. _class_RegEx_search_all: - :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. - .. _class_RegEx_sub: +.. _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 diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 91190d1b5..3d6a462e4 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -48,7 +48,7 @@ Contains the results of a single regex match returned by :ref:`RegEx.search` **names** @@ -58,7 +58,7 @@ Property Descriptions 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: +.. _class_RegExMatch_strings: - :ref:`Array` **strings** @@ -68,7 +68,7 @@ A dictionary of named groups and its corresponding group number. Only groups wit An :ref:`Array` of the match and its capturing groups. - .. _class_RegExMatch_subject: +.. _class_RegExMatch_subject: - :ref:`String` **subject** @@ -81,7 +81,7 @@ The source string used with the search pattern to find this matching result. Method Descriptions ------------------- - .. _class_RegExMatch_get_end: +.. _class_RegExMatch_get_end: - :ref:`int` **get_end** **(** :ref:`Variant` name=0 **)** const @@ -89,13 +89,13 @@ Returns the end position of the match within the source string. The end position Returns -1 if the group did not match or doesn't exist. - .. _class_RegExMatch_get_group_count: +.. _class_RegExMatch_get_group_count: - :ref:`int` **get_group_count** **(** **)** const Returns the number of capturing groups. - .. _class_RegExMatch_get_start: +.. _class_RegExMatch_get_start: - :ref:`int` **get_start** **(** :ref:`Variant` name=0 **)** const @@ -103,7 +103,7 @@ Returns the starting position of the match within the source string. The startin Returns -1 if the group did not match or doesn't exist. - .. _class_RegExMatch_get_string: +.. _class_RegExMatch_get_string: - :ref:`String` **get_string** **(** :ref:`Variant` name=0 **)** const diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 1759f57b6..76d880013 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -41,7 +41,7 @@ It can be set to update another Node's position, rotation and/or scale. It can u Property Descriptions --------------------- - .. _class_RemoteTransform_remote_path: +.. _class_RemoteTransform_remote_path: - :ref:`NodePath` **remote_path** @@ -53,7 +53,7 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform's position in the scene. - .. _class_RemoteTransform_update_position: +.. _class_RemoteTransform_update_position: - :ref:`bool` **update_position** @@ -65,7 +65,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true`` the remote node's position is updated. Default value: ``true``. - .. _class_RemoteTransform_update_rotation: +.. _class_RemoteTransform_update_rotation: - :ref:`bool` **update_rotation** @@ -77,7 +77,7 @@ If ``true`` the remote node's position is updated. Default value: ``true``. If ``true`` the remote node's rotation is updated. Default value: ``true``. - .. _class_RemoteTransform_update_scale: +.. _class_RemoteTransform_update_scale: - :ref:`bool` **update_scale** @@ -89,7 +89,7 @@ If ``true`` the remote node's rotation is updated. Default value: ``true``. If ``true`` the remote node's scale is updated. Default value: ``true``. - .. _class_RemoteTransform_use_global_coordinates: +.. _class_RemoteTransform_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index d1678a79e..f8720bde5 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -41,7 +41,7 @@ It can be set to update another Node's position, rotation and/or scale. It can u Property Descriptions --------------------- - .. _class_RemoteTransform2D_remote_path: +.. _class_RemoteTransform2D_remote_path: - :ref:`NodePath` **remote_path** @@ -53,7 +53,7 @@ Property Descriptions The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. - .. _class_RemoteTransform2D_update_position: +.. _class_RemoteTransform2D_update_position: - :ref:`bool` **update_position** @@ -65,7 +65,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr If ``true`` the remote node's position is updated. Default value: ``true``. - .. _class_RemoteTransform2D_update_rotation: +.. _class_RemoteTransform2D_update_rotation: - :ref:`bool` **update_rotation** @@ -77,7 +77,7 @@ If ``true`` the remote node's position is updated. Default value: ``true``. If ``true`` the remote node's rotation is updated. Default value: ``true``. - .. _class_RemoteTransform2D_update_scale: +.. _class_RemoteTransform2D_update_scale: - :ref:`bool` **update_scale** @@ -89,7 +89,7 @@ If ``true`` the remote node's rotation is updated. Default value: ``true``. If ``true`` the remote node's scale is updated. Default value: ``true``. - .. _class_RemoteTransform2D_use_global_coordinates: +.. _class_RemoteTransform2D_use_global_coordinates: - :ref:`bool` **use_global_coordinates** diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 4d91d6e6c..032f0ef0e 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -49,7 +49,7 @@ Methods Signals ------- - .. _class_Resource_changed: +.. _class_Resource_changed: - **changed** **(** **)** @@ -61,7 +61,7 @@ Resource is the base class for all resource types. Resources are primarily data Property Descriptions --------------------- - .. _class_Resource_resource_local_to_scene: +.. _class_Resource_resource_local_to_scene: - :ref:`bool` **resource_local_to_scene** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | is_local_to_scene() | +----------+---------------------------+ - .. _class_Resource_resource_name: +.. _class_Resource_resource_name: - :ref:`String` **resource_name** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_name() | +----------+-----------------+ - .. _class_Resource_resource_path: +.. _class_Resource_resource_path: - :ref:`String` **resource_path** @@ -94,29 +94,29 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Resource__setup_local_to_scene: +.. _class_Resource__setup_local_to_scene: - void **_setup_local_to_scene** **(** **)** virtual - .. _class_Resource_duplicate: +.. _class_Resource_duplicate: - :ref:`Resource` **duplicate** **(** :ref:`bool` subresources=false **)** const - .. _class_Resource_get_local_scene: +.. _class_Resource_get_local_scene: - :ref:`Node` **get_local_scene** **(** **)** const - .. _class_Resource_get_rid: +.. _class_Resource_get_rid: - :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. - .. _class_Resource_setup_local_to_scene: +.. _class_Resource_setup_local_to_scene: - void **setup_local_to_scene** **(** **)** - .. _class_Resource_take_over_path: +.. _class_Resource_take_over_path: - void **take_over_path** **(** :ref:`String` path **)** diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index ed937bc7a..20d48995f 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -39,31 +39,31 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf Method Descriptions ------------------- - .. _class_ResourceInteractiveLoader_get_resource: +.. _class_ResourceInteractiveLoader_get_resource: - :ref:`Resource` **get_resource** **(** **)** Return the loaded resource (only if loaded). Otherwise, returns null. - .. _class_ResourceInteractiveLoader_get_stage: +.. _class_ResourceInteractiveLoader_get_stage: - :ref:`int` **get_stage** **(** **)** const Return the load stage. The total amount of stages can be queried with :ref:`get_stage_count` - .. _class_ResourceInteractiveLoader_get_stage_count: +.. _class_ResourceInteractiveLoader_get_stage_count: - :ref:`int` **get_stage_count** **(** **)** const Return the total amount of stages (calls to :ref:`poll`) needed to completely load this resource. - .. _class_ResourceInteractiveLoader_poll: +.. _class_ResourceInteractiveLoader_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: +.. _class_ResourceInteractiveLoader_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 74538c9aa..a26c6f4a5 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -45,39 +45,39 @@ Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScr Method Descriptions ------------------- - .. _class_ResourceLoader_exists: +.. _class_ResourceLoader_exists: - :ref:`bool` **exists** **(** :ref:`String` path, :ref:`String` type_hint="" **)** - .. _class_ResourceLoader_get_dependencies: +.. _class_ResourceLoader_get_dependencies: - :ref:`PoolStringArray` **get_dependencies** **(** :ref:`String` path **)** - .. _class_ResourceLoader_get_recognized_extensions_for_type: +.. _class_ResourceLoader_get_recognized_extensions_for_type: - :ref:`PoolStringArray` **get_recognized_extensions_for_type** **(** :ref:`String` type **)** Return the list of recognized extensions for a resource type. - .. _class_ResourceLoader_has: +.. _class_ResourceLoader_has: - :ref:`bool` **has** **(** :ref:`String` path **)** - .. _class_ResourceLoader_has_cached: +.. _class_ResourceLoader_has_cached: - :ref:`bool` **has_cached** **(** :ref:`String` path **)** - .. _class_ResourceLoader_load: +.. _class_ResourceLoader_load: - :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** - .. _class_ResourceLoader_load_interactive: +.. _class_ResourceLoader_load_interactive: - :ref:`ResourceInteractiveLoader` **load_interactive** **(** :ref:`String` path, :ref:`String` type_hint="" **)** Load a resource interactively, the returned object allows to load with high granularity. - .. _class_ResourceLoader_set_abort_on_missing_resources: +.. _class_ResourceLoader_set_abort_on_missing_resources: - void **set_abort_on_missing_resources** **(** :ref:`bool` abort **)** diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index 8d13a5430..cbb24d19e 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -41,35 +41,35 @@ Resource Preloader Node. This node is used to preload sub-resources inside a sce Method Descriptions ------------------- - .. _class_ResourcePreloader_add_resource: +.. _class_ResourcePreloader_add_resource: - void **add_resource** **(** :ref:`String` name, :ref:`Resource` resource **)** - .. _class_ResourcePreloader_get_resource: +.. _class_ResourcePreloader_get_resource: - :ref:`Resource` **get_resource** **(** :ref:`String` name **)** const Return the resource given a text-id. - .. _class_ResourcePreloader_get_resource_list: +.. _class_ResourcePreloader_get_resource_list: - :ref:`PoolStringArray` **get_resource_list** **(** **)** const Return the list of resources inside the preloader. - .. _class_ResourcePreloader_has_resource: +.. _class_ResourcePreloader_has_resource: - :ref:`bool` **has_resource** **(** :ref:`String` name **)** const Return true if the preloader has a given resource. - .. _class_ResourcePreloader_remove_resource: +.. _class_ResourcePreloader_remove_resource: - void **remove_resource** **(** :ref:`String` name **)** Remove a resource from the preloader by text id. - .. _class_ResourcePreloader_rename_resource: +.. _class_ResourcePreloader_rename_resource: - void **rename_resource** **(** :ref:`String` name, :ref:`String` newname **)** diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 34111a74f..9f2046dc0 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -28,7 +28,7 @@ Methods Enumerations ------------ - .. _enum_ResourceSaver_SaverFlags: +.. _enum_ResourceSaver_SaverFlags: enum **SaverFlags**: @@ -47,13 +47,13 @@ Resource saving interface, used for saving resources to disk. Method Descriptions ------------------- - .. _class_ResourceSaver_get_recognized_extensions: +.. _class_ResourceSaver_get_recognized_extensions: - :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` type **)** Returns the list of extensions available for saving a resource of a given type. - .. _class_ResourceSaver_save: +.. _class_ResourceSaver_save: - :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index d29fe692b..db6cf517f 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -138,19 +138,19 @@ Theme Properties Signals ------- - .. _class_RichTextLabel_meta_clicked: +.. _class_RichTextLabel_meta_clicked: - **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. - .. _class_RichTextLabel_meta_hover_ended: +.. _class_RichTextLabel_meta_hover_ended: - **meta_hover_ended** **(** :ref:`Nil` meta **)** Triggers when the mouse exits a meta tag. - .. _class_RichTextLabel_meta_hover_started: +.. _class_RichTextLabel_meta_hover_started: - **meta_hover_started** **(** :ref:`Nil` meta **)** @@ -159,7 +159,7 @@ Triggers when the mouse enters a meta tag. Enumerations ------------ - .. _enum_RichTextLabel_ListType: +.. _enum_RichTextLabel_ListType: enum **ListType**: @@ -167,7 +167,7 @@ enum **ListType**: - **LIST_LETTERS** = **1** - **LIST_DOTS** = **2** - .. _enum_RichTextLabel_Align: +.. _enum_RichTextLabel_Align: enum **Align**: @@ -176,7 +176,7 @@ enum **Align**: - **ALIGN_RIGHT** = **2** - **ALIGN_FILL** = **3** - .. _enum_RichTextLabel_ItemType: +.. _enum_RichTextLabel_ItemType: enum **ItemType**: @@ -204,10 +204,11 @@ Tutorials --------- - :doc:`../tutorials/gui/bbcode_in_richtextlabel` + Property Descriptions --------------------- - .. _class_RichTextLabel_bbcode_enabled: +.. _class_RichTextLabel_bbcode_enabled: - :ref:`bool` **bbcode_enabled** @@ -219,7 +220,7 @@ Property Descriptions If ``true`` the label uses BBCode formatting. Default value: ``false``. - .. _class_RichTextLabel_bbcode_text: +.. _class_RichTextLabel_bbcode_text: - :ref:`String` **bbcode_text** @@ -231,7 +232,7 @@ If ``true`` the label uses BBCode formatting. Default value: ``false``. 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: +.. _class_RichTextLabel_meta_underlined: - :ref:`bool` **meta_underlined** @@ -243,7 +244,7 @@ The label's text in BBCode format. Is not representative of manual modifications If ``true``, the label underlines meta tags such as url{text}. Default value: ``true``. - .. _class_RichTextLabel_override_selected_font_color: +.. _class_RichTextLabel_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -255,7 +256,7 @@ If ``true``, the label underlines meta tags such as url{text}. Default value: `` If ``true`` the label uses the custom font color. Default value: ``false``. - .. _class_RichTextLabel_percent_visible: +.. _class_RichTextLabel_percent_visible: - :ref:`float` **percent_visible** @@ -267,7 +268,7 @@ If ``true`` the label uses the custom font color. Default value: ``false``. The text's visibility, as a :ref:`float` between 0.0 and 1.0. - .. _class_RichTextLabel_scroll_active: +.. _class_RichTextLabel_scroll_active: - :ref:`bool` **scroll_active** @@ -279,7 +280,7 @@ The text's visibility, as a :ref:`float` between 0.0 and 1.0. If ``true``, the scrollbar is visible. Does not block scrolling completely. See :ref:`scroll_to_line`. Default value: ``true``. - .. _class_RichTextLabel_scroll_following: +.. _class_RichTextLabel_scroll_following: - :ref:`bool` **scroll_following** @@ -291,7 +292,7 @@ If ``true``, the scrollbar is visible. Does not block scrolling completely. See If ``true``, the window scrolls down to display new content automatically. Default value: ``false``. - .. _class_RichTextLabel_selection_enabled: +.. _class_RichTextLabel_selection_enabled: - :ref:`bool` **selection_enabled** @@ -303,7 +304,7 @@ If ``true``, the window scrolls down to display new content automatically. Defau If ``true``, the label allows text selection. - .. _class_RichTextLabel_tab_size: +.. _class_RichTextLabel_tab_size: - :ref:`int` **tab_size** @@ -315,7 +316,7 @@ If ``true``, the label allows text selection. The number of spaces associated with a single tab length. Does not affect "\\t" in text tags, only indent tags. - .. _class_RichTextLabel_text: +.. _class_RichTextLabel_text: - :ref:`String` **text** @@ -329,7 +330,7 @@ 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: +.. _class_RichTextLabel_visible_characters: - :ref:`int` **visible_characters** @@ -344,145 +345,145 @@ The restricted number of characters to display in the label. Method Descriptions ------------------- - .. _class_RichTextLabel_add_image: +.. _class_RichTextLabel_add_image: - void **add_image** **(** :ref:`Texture` image **)** Adds an image's opening and closing tags to the tag stack. - .. _class_RichTextLabel_add_text: +.. _class_RichTextLabel_add_text: - void **add_text** **(** :ref:`String` text **)** Adds raw non-bbcode-parsed text to the tag stack. - .. _class_RichTextLabel_append_bbcode: +.. _class_RichTextLabel_append_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. - .. _class_RichTextLabel_clear: +.. _class_RichTextLabel_clear: - void **clear** **(** **)** Clears the tag stack and sets :ref:`bbcode_text` to an empty string. - .. _class_RichTextLabel_get_content_height: +.. _class_RichTextLabel_get_content_height: - :ref:`int` **get_content_height** **(** **)** Returns the height of the content. - .. _class_RichTextLabel_get_line_count: +.. _class_RichTextLabel_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. - .. _class_RichTextLabel_get_total_character_count: +.. _class_RichTextLabel_get_total_character_count: - :ref:`int` **get_total_character_count** **(** **)** const Returns the total number of characters from text tags. Does not include bbcodes. - .. _class_RichTextLabel_get_v_scroll: +.. _class_RichTextLabel_get_v_scroll: - :ref:`VScrollBar` **get_v_scroll** **(** **)** Returns the vertical scrollbar. - .. _class_RichTextLabel_get_visible_line_count: +.. _class_RichTextLabel_get_visible_line_count: - :ref:`int` **get_visible_line_count** **(** **)** const Returns the number of visible lines. - .. _class_RichTextLabel_newline: +.. _class_RichTextLabel_newline: - void **newline** **(** **)** Adds a newline tag to the tag stack. - .. _class_RichTextLabel_parse_bbcode: +.. _class_RichTextLabel_parse_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. - .. _class_RichTextLabel_pop: +.. _class_RichTextLabel_pop: - void **pop** **(** **)** Terminates the current tag. Use after ``push_*`` methods to close bbcodes manually. Does not need to follow ``add_*`` methods. - .. _class_RichTextLabel_push_align: +.. _class_RichTextLabel_push_align: - void **push_align** **(** :ref:`Align` align **)** Adds a ``[right]`` tag to the tag stack. - .. _class_RichTextLabel_push_cell: +.. _class_RichTextLabel_push_cell: - void **push_cell** **(** **)** Adds a ``[cell]`` tag to the tag stack. Must be inside a table tag. See :ref:`push_table` for details. - .. _class_RichTextLabel_push_color: +.. _class_RichTextLabel_push_color: - void **push_color** **(** :ref:`Color` color **)** Adds a ``[color]`` tag to the tag stack. - .. _class_RichTextLabel_push_font: +.. _class_RichTextLabel_push_font: - void **push_font** **(** :ref:`Font` font **)** Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration. - .. _class_RichTextLabel_push_indent: +.. _class_RichTextLabel_push_indent: - void **push_indent** **(** :ref:`int` level **)** Adds an ``[indent]`` tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length. - .. _class_RichTextLabel_push_list: +.. _class_RichTextLabel_push_list: - 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: +.. _class_RichTextLabel_push_meta: - 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. - .. _class_RichTextLabel_push_table: +.. _class_RichTextLabel_push_table: - void **push_table** **(** :ref:`int` columns **)** Adds a ``[table=columns]`` tag to the tag stack. - .. _class_RichTextLabel_push_underline: +.. _class_RichTextLabel_push_underline: - void **push_underline** **(** **)** Adds a ``[u]`` tag to the tag stack. - .. _class_RichTextLabel_remove_line: +.. _class_RichTextLabel_remove_line: - :ref:`bool` **remove_line** **(** :ref:`int` line **)** Removes a line of content from the label. Returns ``true`` if the line exists. - .. _class_RichTextLabel_scroll_to_line: +.. _class_RichTextLabel_scroll_to_line: - void **scroll_to_line** **(** :ref:`int` line **)** Scrolls the window's top line to match ``line``. - .. _class_RichTextLabel_set_table_column_expand: +.. _class_RichTextLabel_set_table_column_expand: - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** diff --git a/classes/class_rid.rst b/classes/class_rid.rst index fc67a61e0..fdcff8416 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -31,13 +31,13 @@ The RID type is used to access the unique integer ID of a resource. They are op Method Descriptions ------------------- - .. _class_RID_RID: +.. _class_RID_RID: - :ref:`RID` **RID** **(** :ref:`Object` from **)** 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: +.. _class_RID_get_id: - :ref:`int` **get_id** **(** **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index fb06e5da5..6f1a59ad4 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -95,19 +95,19 @@ Methods Signals ------- - .. _class_RigidBody_body_entered: +.. _class_RigidBody_body_entered: - **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: +.. _class_RigidBody_body_exited: - **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: +.. _class_RigidBody_body_shape_entered: - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -115,7 +115,7 @@ Emitted when a body enters into contact with this one. Contact monitor and conta 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: +.. _class_RigidBody_body_shape_exited: - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Node` body, :ref:`int` body_shape, :ref:`int` local_shape **)** @@ -123,7 +123,7 @@ Emitted when a body shape exits contact with this one. Contact monitor and conta 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: +.. _class_RigidBody_sleeping_state_changed: - **sleeping_state_changed** **(** **)** @@ -132,7 +132,7 @@ Emitted when the body changes its sleeping state. Either by sleeping or waking u Enumerations ------------ - .. _enum_RigidBody_Mode: +.. _enum_RigidBody_Mode: enum **Mode**: @@ -156,10 +156,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_RigidBody_angular_damp: +.. _class_RigidBody_angular_damp: - :ref:`float` **angular_damp** @@ -171,7 +172,7 @@ Property Descriptions Damps RigidBody's rotational forces. - .. _class_RigidBody_angular_velocity: +.. _class_RigidBody_angular_velocity: - :ref:`Vector3` **angular_velocity** @@ -183,7 +184,7 @@ Damps RigidBody's rotational forces. RigidBody's rotational velocity. - .. _class_RigidBody_axis_lock_angular_x: +.. _class_RigidBody_axis_lock_angular_x: - :ref:`bool` **axis_lock_angular_x** @@ -193,7 +194,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_axis_lock_angular_y: +.. _class_RigidBody_axis_lock_angular_y: - :ref:`bool` **axis_lock_angular_y** @@ -203,7 +204,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_axis_lock_angular_z: +.. _class_RigidBody_axis_lock_angular_z: - :ref:`bool` **axis_lock_angular_z** @@ -213,7 +214,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_axis_lock_linear_x: +.. _class_RigidBody_axis_lock_linear_x: - :ref:`bool` **axis_lock_linear_x** @@ -223,7 +224,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_axis_lock_linear_y: +.. _class_RigidBody_axis_lock_linear_y: - :ref:`bool` **axis_lock_linear_y** @@ -233,7 +234,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_axis_lock_linear_z: +.. _class_RigidBody_axis_lock_linear_z: - :ref:`bool` **axis_lock_linear_z** @@ -243,7 +244,7 @@ RigidBody's rotational velocity. | *Getter* | get_axis_lock() | +----------+----------------------+ - .. _class_RigidBody_bounce: +.. _class_RigidBody_bounce: - :ref:`float` **bounce** @@ -255,7 +256,7 @@ RigidBody's rotational velocity. RigidBody's bounciness. - .. _class_RigidBody_can_sleep: +.. _class_RigidBody_can_sleep: - :ref:`bool` **can_sleep** @@ -267,7 +268,7 @@ RigidBody's bounciness. If ``true`` the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. - .. _class_RigidBody_contact_monitor: +.. _class_RigidBody_contact_monitor: - :ref:`bool` **contact_monitor** @@ -279,7 +280,7 @@ If ``true`` the RigidBody will not calculate forces and will act as a static bod If true, the RigidBody will emit signals when it collides with another RigidBody. - .. _class_RigidBody_contacts_reported: +.. _class_RigidBody_contacts_reported: - :ref:`int` **contacts_reported** @@ -291,7 +292,7 @@ If true, the RigidBody will emit signals when it collides with another RigidBody 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_RigidBody_continuous_cd: +.. _class_RigidBody_continuous_cd: - :ref:`bool` **continuous_cd** @@ -305,7 +306,7 @@ If ``true`` continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. - .. _class_RigidBody_custom_integrator: +.. _class_RigidBody_custom_integrator: - :ref:`bool` **custom_integrator** @@ -317,7 +318,7 @@ Continuous collision detection tries to predict where a moving body will collide If ``true`` internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. - .. _class_RigidBody_friction: +.. _class_RigidBody_friction: - :ref:`float` **friction** @@ -329,7 +330,7 @@ If ``true`` internal force integration will be disabled (like gravity or air fri The body friction, from 0 (frictionless) to 1 (max friction). - .. _class_RigidBody_gravity_scale: +.. _class_RigidBody_gravity_scale: - :ref:`float` **gravity_scale** @@ -341,7 +342,7 @@ The body friction, from 0 (frictionless) to 1 (max friction). This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. - .. _class_RigidBody_linear_damp: +.. _class_RigidBody_linear_damp: - :ref:`float` **linear_damp** @@ -353,7 +354,7 @@ This is multiplied by the global 3D gravity setting found in "Project > Project RigidBody's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. - .. _class_RigidBody_linear_velocity: +.. _class_RigidBody_linear_velocity: - :ref:`Vector3` **linear_velocity** @@ -365,7 +366,7 @@ RigidBody's linear damp. Default value: -1, cannot be less than -1. If this valu 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: +.. _class_RigidBody_mass: - :ref:`float` **mass** @@ -377,7 +378,7 @@ RigidBody's linear velocity. Can be used sporadically, but **DON'T SET THIS IN E RigidBody's mass. - .. _class_RigidBody_mode: +.. _class_RigidBody_mode: - :ref:`Mode` **mode** @@ -389,7 +390,7 @@ RigidBody's mass. The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. - .. _class_RigidBody_physics_material_override: +.. _class_RigidBody_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -399,7 +400,7 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC | *Getter* | get_physics_material_override() | +----------+--------------------------------------+ - .. _class_RigidBody_sleeping: +.. _class_RigidBody_sleeping: - :ref:`bool` **sleeping** @@ -411,7 +412,7 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC If ``true`` RigidBody is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. - .. _class_RigidBody_weight: +.. _class_RigidBody_weight: - :ref:`float` **weight** @@ -426,13 +427,13 @@ RigidBody's weight based on its mass and the global 3D gravity. Global values ar Method Descriptions ------------------- - .. _class_RigidBody__integrate_forces: +.. _class_RigidBody__integrate_forces: - 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: +.. _class_RigidBody_add_central_force: - void **add_central_force** **(** :ref:`Vector3` force **)** @@ -440,19 +441,19 @@ Adds a constant directional force without affecting rotation. This is equivalent to ``add_force(force, Vector3(0,0,0))``. - .. _class_RigidBody_add_force: +.. _class_RigidBody_add_force: - void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** Adds a constant force (i.e. acceleration). - .. _class_RigidBody_add_torque: +.. _class_RigidBody_add_torque: - void **add_torque** **(** :ref:`Vector3` torque **)** Adds a constant rotational force (i.e. a motor) without affecting position. - .. _class_RigidBody_apply_central_impulse: +.. _class_RigidBody_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** @@ -460,25 +461,25 @@ Applies a single directional impulse without affecting rotation. This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. - .. _class_RigidBody_apply_impulse: +.. _class_RigidBody_apply_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: +.. _class_RigidBody_apply_torque_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: +.. _class_RigidBody_get_colliding_bodies: - :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: +.. _class_RigidBody_set_axis_velocity: - void **set_axis_velocity** **(** :ref:`Vector3` axis_velocity **)** diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index f34cdf699..28d81871d 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -89,31 +89,31 @@ Methods Signals ------- - .. _class_RigidBody2D_body_entered: +.. _class_RigidBody2D_body_entered: - **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: +.. _class_RigidBody2D_body_exited: - **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: +.. _class_RigidBody2D_body_shape_entered: - **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``. - .. _class_RigidBody2D_body_shape_exited: +.. _class_RigidBody2D_body_shape_exited: - **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``. - .. _class_RigidBody2D_sleeping_state_changed: +.. _class_RigidBody2D_sleeping_state_changed: - **sleeping_state_changed** **(** **)** @@ -122,7 +122,7 @@ Emitted when :ref:`sleeping` changes. Enumerations ------------ - .. _enum_RigidBody2D_CCDMode: +.. _enum_RigidBody2D_CCDMode: enum **CCDMode**: @@ -130,7 +130,7 @@ enum **CCDMode**: - **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_RigidBody2D_Mode: enum **Mode**: @@ -153,7 +153,7 @@ If you need to override the default physics behavior, you can write a custom for Property Descriptions --------------------- - .. _class_RigidBody2D_angular_damp: +.. _class_RigidBody2D_angular_damp: - :ref:`float` **angular_damp** @@ -165,7 +165,7 @@ Property Descriptions Damps the body's :ref:`angular_velocity`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. - .. _class_RigidBody2D_angular_velocity: +.. _class_RigidBody2D_angular_velocity: - :ref:`float` **angular_velocity** @@ -177,7 +177,7 @@ Damps the body's :ref:`angular_velocity`. If The body's rotational velocity. - .. _class_RigidBody2D_applied_force: +.. _class_RigidBody2D_applied_force: - :ref:`Vector2` **applied_force** @@ -189,7 +189,7 @@ The body's rotational velocity. The body's total applied force. - .. _class_RigidBody2D_applied_torque: +.. _class_RigidBody2D_applied_torque: - :ref:`float` **applied_torque** @@ -201,7 +201,7 @@ The body's total applied force. The body's total applied torque. - .. _class_RigidBody2D_bounce: +.. _class_RigidBody2D_bounce: - :ref:`float` **bounce** @@ -213,7 +213,7 @@ The body's total applied torque. The body's bounciness. Default value: ``0``. - .. _class_RigidBody2D_can_sleep: +.. _class_RigidBody2D_can_sleep: - :ref:`bool` **can_sleep** @@ -225,7 +225,7 @@ The body's bounciness. Default value: ``0``. If ``true`` the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. - .. _class_RigidBody2D_contact_monitor: +.. _class_RigidBody2D_contact_monitor: - :ref:`bool` **contact_monitor** @@ -237,7 +237,7 @@ If ``true`` the body will not calculate forces and will act as a static body if If ``true`` the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. - .. _class_RigidBody2D_contacts_reported: +.. _class_RigidBody2D_contacts_reported: - :ref:`int` **contacts_reported** @@ -249,7 +249,7 @@ If ``true`` the body will emit signals when it collides with another RigidBody2D The maximum number of contacts to report. Default value: ``0``. - .. _class_RigidBody2D_continuous_cd: +.. _class_RigidBody2D_continuous_cd: - :ref:`CCDMode` **continuous_cd** @@ -263,7 +263,7 @@ 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. - .. _class_RigidBody2D_custom_integrator: +.. _class_RigidBody2D_custom_integrator: - :ref:`bool` **custom_integrator** @@ -275,7 +275,7 @@ Continuous collision detection tries to predict where a moving body will collide If ``true`` internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. - .. _class_RigidBody2D_friction: +.. _class_RigidBody2D_friction: - :ref:`float` **friction** @@ -287,7 +287,7 @@ If ``true`` internal force integration is disabled for this body. Aside from col The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``. - .. _class_RigidBody2D_gravity_scale: +.. _class_RigidBody2D_gravity_scale: - :ref:`float` **gravity_scale** @@ -299,7 +299,7 @@ The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum fr 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: +.. _class_RigidBody2D_inertia: - :ref:`float` **inertia** @@ -311,7 +311,7 @@ Multiplies the gravity applied to the body. The body's gravity is calculated fro The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. - .. _class_RigidBody2D_linear_damp: +.. _class_RigidBody2D_linear_damp: - :ref:`float` **linear_damp** @@ -323,7 +323,7 @@ The body's moment of inertia. This is like mass, but for rotation: it determines Damps the body's :ref:`linear_velocity`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``. - .. _class_RigidBody2D_linear_velocity: +.. _class_RigidBody2D_linear_velocity: - :ref:`Vector2` **linear_velocity** @@ -335,7 +335,7 @@ Damps the body's :ref:`linear_velocity`. If ` The body's linear velocity. - .. _class_RigidBody2D_mass: +.. _class_RigidBody2D_mass: - :ref:`float` **mass** @@ -347,7 +347,7 @@ The body's linear velocity. The body's mass. Default value: ``1``. - .. _class_RigidBody2D_mode: +.. _class_RigidBody2D_mode: - :ref:`Mode` **mode** @@ -359,7 +359,7 @@ The body's mass. Default value: ``1``. The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. - .. _class_RigidBody2D_physics_material_override: +.. _class_RigidBody2D_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** @@ -369,7 +369,7 @@ The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. | *Getter* | get_physics_material_override() | +----------+--------------------------------------+ - .. _class_RigidBody2D_sleeping: +.. _class_RigidBody2D_sleeping: - :ref:`bool` **sleeping** @@ -381,7 +381,7 @@ The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. If ``true`` the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. - .. _class_RigidBody2D_weight: +.. _class_RigidBody2D_weight: - :ref:`float` **weight** @@ -396,53 +396,53 @@ The body's weight based on its mass and the "Default Gravity" value in "Project Method Descriptions ------------------- - .. _class_RigidBody2D__integrate_forces: +.. _class_RigidBody2D__integrate_forces: - 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: +.. _class_RigidBody2D_add_central_force: - void **add_central_force** **(** :ref:`Vector2` force **)** - .. _class_RigidBody2D_add_force: +.. _class_RigidBody2D_add_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. - .. _class_RigidBody2D_add_torque: +.. _class_RigidBody2D_add_torque: - void **add_torque** **(** :ref:`float` torque **)** - .. _class_RigidBody2D_apply_central_impulse: +.. _class_RigidBody2D_apply_central_impulse: - void **apply_central_impulse** **(** :ref:`Vector2` impulse **)** - .. _class_RigidBody2D_apply_impulse: +.. _class_RigidBody2D_apply_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. - .. _class_RigidBody2D_apply_torque_impulse: +.. _class_RigidBody2D_apply_torque_impulse: - void **apply_torque_impulse** **(** :ref:`float` torque **)** - .. _class_RigidBody2D_get_colliding_bodies: +.. _class_RigidBody2D_get_colliding_bodies: - :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: +.. _class_RigidBody2D_set_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: +.. _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 **)** diff --git a/classes/class_rootmotionview.rst b/classes/class_rootmotionview.rst index 8fdd24202..0a4694770 100644 --- a/classes/class_rootmotionview.rst +++ b/classes/class_rootmotionview.rst @@ -34,7 +34,7 @@ Properties Property Descriptions --------------------- - .. _class_RootMotionView_animation_path: +.. _class_RootMotionView_animation_path: - :ref:`NodePath` **animation_path** @@ -44,7 +44,7 @@ Property Descriptions | *Getter* | get_animation_path() | +----------+---------------------------+ - .. _class_RootMotionView_cell_size: +.. _class_RootMotionView_cell_size: - :ref:`float` **cell_size** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_cell_size() | +----------+----------------------+ - .. _class_RootMotionView_color: +.. _class_RootMotionView_color: - :ref:`Color` **color** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ - .. _class_RootMotionView_radius: +.. _class_RootMotionView_radius: - :ref:`float` **radius** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_radius() | +----------+-------------------+ - .. _class_RootMotionView_zero_y: +.. _class_RootMotionView_zero_y: - :ref:`bool` **zero_y** diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 657e6f63d..71ad339e5 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -64,7 +64,7 @@ Methods Enumerations ------------ - .. _enum_SceneState_GenEditState: +.. _enum_SceneState_GenEditState: enum **GenEditState**: @@ -80,119 +80,119 @@ Maintains a list of resources, nodes, exported, and overridden properties, and b Method Descriptions ------------------- - .. _class_SceneState_get_connection_binds: +.. _class_SceneState_get_connection_binds: - :ref:`Array` **get_connection_binds** **(** :ref:`int` idx **)** const Returns the list of bound parameters for the signal at ``idx``. - .. _class_SceneState_get_connection_count: +.. _class_SceneState_get_connection_count: - :ref:`int` **get_connection_count** **(** **)** const Returns the number of signal connections in the scene. - .. _class_SceneState_get_connection_flags: +.. _class_SceneState_get_connection_flags: - :ref:`int` **get_connection_flags** **(** :ref:`int` idx **)** const Returns the flags for the signal at ``idx``. See :ref:`Object`'s ``CONNECT_*`` flags. - .. _class_SceneState_get_connection_method: +.. _class_SceneState_get_connection_method: - :ref:`String` **get_connection_method** **(** :ref:`int` idx **)** const Returns the method connected to the signal at ``idx``. - .. _class_SceneState_get_connection_signal: +.. _class_SceneState_get_connection_signal: - :ref:`String` **get_connection_signal** **(** :ref:`int` idx **)** const Returns the name of the signal at ``idx``. - .. _class_SceneState_get_connection_source: +.. _class_SceneState_get_connection_source: - :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: +.. _class_SceneState_get_connection_target: - :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. - .. _class_SceneState_get_node_count: +.. _class_SceneState_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in the scene. - .. _class_SceneState_get_node_groups: +.. _class_SceneState_get_node_groups: - :ref:`PoolStringArray` **get_node_groups** **(** :ref:`int` idx **)** const Returns the list of group names associated with the node at ``idx``. - .. _class_SceneState_get_node_index: +.. _class_SceneState_get_node_index: - :ref:`int` **get_node_index** **(** :ref:`int` idx **)** const - .. _class_SceneState_get_node_instance: +.. _class_SceneState_get_node_instance: - :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: +.. _class_SceneState_get_node_instance_placeholder: - :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`. - .. _class_SceneState_get_node_name: +.. _class_SceneState_get_node_name: - :ref:`String` **get_node_name** **(** :ref:`int` idx **)** const Returns the name of the node at ``idx``. - .. _class_SceneState_get_node_owner_path: +.. _class_SceneState_get_node_owner_path: - :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: +.. _class_SceneState_get_node_path: - :ref:`NodePath` **get_node_path** **(** :ref:`int` idx, :ref:`bool` for_parent=false **)** const Returns the path to the node at ``idx``. - .. _class_SceneState_get_node_property_count: +.. _class_SceneState_get_node_property_count: - :ref:`int` **get_node_property_count** **(** :ref:`int` idx **)** const Returns the number of exported or overridden properties for the node at ``idx``. - .. _class_SceneState_get_node_property_name: +.. _class_SceneState_get_node_property_name: - :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: +.. _class_SceneState_get_node_property_value: - :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: +.. _class_SceneState_get_node_type: - :ref:`String` **get_node_type** **(** :ref:`int` idx **)** const Returns the type of the node at ``idx``. - .. _class_SceneState_is_node_instance_placeholder: +.. _class_SceneState_is_node_instance_placeholder: - :ref:`bool` **is_node_instance_placeholder** **(** :ref:`int` idx **)** const diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 543709ad6..85d59356d 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -103,79 +103,79 @@ Methods Signals ------- - .. _class_SceneTree_connected_to_server: +.. _class_SceneTree_connected_to_server: - **connected_to_server** **(** **)** Emitted whenever this SceneTree's :ref:`network_peer` successfully connected to a server. Only emitted on clients. - .. _class_SceneTree_connection_failed: +.. _class_SceneTree_connection_failed: - **connection_failed** **(** **)** Emitted whenever this SceneTree's :ref:`network_peer` fails to establish a connection to a server. Only emitted on clients. - .. _class_SceneTree_files_dropped: +.. _class_SceneTree_files_dropped: - **files_dropped** **(** :ref:`PoolStringArray` files, :ref:`int` screen **)** Emitted whenever files are drag-and-dropped onto the window. - .. _class_SceneTree_idle_frame: +.. _class_SceneTree_idle_frame: - **idle_frame** **(** **)** Emitted immediately before :ref:`Node._process` is called on every node in the SceneTree. - .. _class_SceneTree_network_peer_connected: +.. _class_SceneTree_network_peer_connected: - **network_peer_connected** **(** :ref:`int` id **)** Emitted whenever this SceneTree's :ref:`network_peer` connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). - .. _class_SceneTree_network_peer_disconnected: +.. _class_SceneTree_network_peer_disconnected: - **network_peer_disconnected** **(** :ref:`int` id **)** Emitted whenever this SceneTree's :ref:`network_peer` disconnects from a peer. Clients get notified when other clients disconnect from the same server. - .. _class_SceneTree_node_added: +.. _class_SceneTree_node_added: - **node_added** **(** :ref:`Node` node **)** Emitted whenever a node is added to the SceneTree. - .. _class_SceneTree_node_configuration_warning_changed: +.. _class_SceneTree_node_configuration_warning_changed: - **node_configuration_warning_changed** **(** :ref:`Node` node **)** Emitted when a node's configuration changed. Only emitted in tool mode. - .. _class_SceneTree_node_removed: +.. _class_SceneTree_node_removed: - **node_removed** **(** :ref:`Node` node **)** Emitted whenever a node is removed from the SceneTree. - .. _class_SceneTree_physics_frame: +.. _class_SceneTree_physics_frame: - **physics_frame** **(** **)** Emitted immediately before :ref:`Node._physics_process` is called on every node in the SceneTree. - .. _class_SceneTree_screen_resized: +.. _class_SceneTree_screen_resized: - **screen_resized** **(** **)** Emitted whenever the screen resolution (fullscreen) or window size (windowed) changes. - .. _class_SceneTree_server_disconnected: +.. _class_SceneTree_server_disconnected: - **server_disconnected** **(** **)** Emitted whenever this SceneTree's :ref:`network_peer` disconnected from server. Only emitted on clients. - .. _class_SceneTree_tree_changed: +.. _class_SceneTree_tree_changed: - **tree_changed** **(** **)** @@ -184,7 +184,7 @@ Emitted whenever the SceneTree hierarchy changed (children being moved or rename Enumerations ------------ - .. _enum_SceneTree_GroupCallFlags: +.. _enum_SceneTree_GroupCallFlags: enum **GroupCallFlags**: @@ -193,7 +193,7 @@ enum **GroupCallFlags**: - **GROUP_CALL_REALTIME** = **2** --- Call a group immediately (calls are normally made on idle). - **GROUP_CALL_UNIQUE** = **4** --- Call a group only once even if the call is executed many times. - .. _enum_SceneTree_StretchMode: +.. _enum_SceneTree_StretchMode: enum **StretchMode**: @@ -201,7 +201,7 @@ enum **StretchMode**: - **STRETCH_MODE_2D** = **1** --- Render stretching in higher resolution (interpolated). - **STRETCH_MODE_VIEWPORT** = **2** --- Keep the specified display resolution. No interpolation. Content may appear pixelated. - .. _enum_SceneTree_StretchAspect: +.. _enum_SceneTree_StretchAspect: enum **StretchAspect**: @@ -220,11 +220,13 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/scene_tree` + - :doc:`../tutorials/viewports/multiple_resolutions` + Property Descriptions --------------------- - .. _class_SceneTree_current_scene: +.. _class_SceneTree_current_scene: - :ref:`Node` **current_scene** @@ -236,7 +238,7 @@ Property Descriptions The current scene. - .. _class_SceneTree_debug_collisions_hint: +.. _class_SceneTree_debug_collisions_hint: - :ref:`bool` **debug_collisions_hint** @@ -246,7 +248,7 @@ The current scene. | *Getter* | is_debugging_collisions_hint() | +----------+----------------------------------+ - .. _class_SceneTree_debug_navigation_hint: +.. _class_SceneTree_debug_navigation_hint: - :ref:`bool` **debug_navigation_hint** @@ -256,7 +258,7 @@ The current scene. | *Getter* | is_debugging_navigation_hint() | +----------+----------------------------------+ - .. _class_SceneTree_edited_scene_root: +.. _class_SceneTree_edited_scene_root: - :ref:`Node` **edited_scene_root** @@ -268,7 +270,7 @@ The current scene. The root of the edited scene. - .. _class_SceneTree_multiplayer: +.. _class_SceneTree_multiplayer: - :ref:`MultiplayerAPI` **multiplayer** @@ -280,7 +282,7 @@ The root of the edited scene. The default :ref:`MultiplayerAPI` instance for this SceneTree. - .. _class_SceneTree_multiplayer_poll: +.. _class_SceneTree_multiplayer_poll: - :ref:`bool` **multiplayer_poll** @@ -294,7 +296,7 @@ If ``true`` (default) enable the automatic polling of the :ref:`MultiplayerAPI` 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` protection when accessing the :ref:`MultiplayerAPI` from threads. - .. _class_SceneTree_network_peer: +.. _class_SceneTree_network_peer: - :ref:`NetworkedMultiplayerPeer` **network_peer** @@ -306,7 +308,7 @@ When ``false`` you need to manually call :ref:`MultiplayerAPI.poll`) 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 puppet. 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: +.. _class_SceneTree_paused: - :ref:`bool` **paused** @@ -318,7 +320,7 @@ The peer object to handle the RPC system (effectively enabling networking when s If ``true`` the SceneTree is paused. - .. _class_SceneTree_refuse_new_network_connections: +.. _class_SceneTree_refuse_new_network_connections: - :ref:`bool` **refuse_new_network_connections** @@ -330,7 +332,7 @@ If ``true`` the SceneTree is paused. If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. - .. _class_SceneTree_root: +.. _class_SceneTree_root: - :ref:`Viewport` **root** @@ -340,7 +342,7 @@ If ``true`` the SceneTree's :ref:`network_peer` re The SceneTree's :ref:`Viewport`. - .. _class_SceneTree_use_font_oversampling: +.. _class_SceneTree_use_font_oversampling: - :ref:`bool` **use_font_oversampling** @@ -355,155 +357,155 @@ If ``true`` font oversampling is used. Method Descriptions ------------------- - .. _class_SceneTree_call_group: +.. _class_SceneTree_call_group: - :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: +.. _class_SceneTree_call_group_flags: - :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`. - .. _class_SceneTree_change_scene: +.. _class_SceneTree_change_scene: - :ref:`Error` **change_scene** **(** :ref:`String` path **)** Changes to the scene at the given ``path``. - .. _class_SceneTree_change_scene_to: +.. _class_SceneTree_change_scene_to: - :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** Changes to the given :ref:`PackedScene`. - .. _class_SceneTree_create_timer: +.. _class_SceneTree_create_timer: - :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. - .. _class_SceneTree_get_frame: +.. _class_SceneTree_get_frame: - :ref:`int` **get_frame** **(** **)** const - .. _class_SceneTree_get_network_connected_peers: +.. _class_SceneTree_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const Returns the peer IDs of all connected peers of this SceneTree's :ref:`network_peer`. - .. _class_SceneTree_get_network_unique_id: +.. _class_SceneTree_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const Returns the unique peer ID of this SceneTree's :ref:`network_peer`. - .. _class_SceneTree_get_node_count: +.. _class_SceneTree_get_node_count: - :ref:`int` **get_node_count** **(** **)** const Returns the number of nodes in this SceneTree. - .. _class_SceneTree_get_nodes_in_group: +.. _class_SceneTree_get_nodes_in_group: - :ref:`Array` **get_nodes_in_group** **(** :ref:`String` group **)** Returns all nodes assigned to the given group. - .. _class_SceneTree_get_rpc_sender_id: +.. _class_SceneTree_get_rpc_sender_id: - :ref:`int` **get_rpc_sender_id** **(** **)** const Returns the sender's peer ID for the most recently received RPC call. - .. _class_SceneTree_has_group: +.. _class_SceneTree_has_group: - :ref:`bool` **has_group** **(** :ref:`String` name **)** const Returns ``true`` if the given group exists. - .. _class_SceneTree_has_network_peer: +.. _class_SceneTree_has_network_peer: - :ref:`bool` **has_network_peer** **(** **)** const Returns ``true`` if there is a :ref:`network_peer` set. - .. _class_SceneTree_is_input_handled: +.. _class_SceneTree_is_input_handled: - :ref:`bool` **is_input_handled** **(** **)** Returns ``true`` if the most recent InputEvent was marked as handled with :ref:`set_input_as_handled`. - .. _class_SceneTree_is_network_server: +.. _class_SceneTree_is_network_server: - :ref:`bool` **is_network_server** **(** **)** const Returns ``true`` if this SceneTree's :ref:`network_peer` is in server mode (listening for connections). - .. _class_SceneTree_notify_group: +.. _class_SceneTree_notify_group: - void **notify_group** **(** :ref:`String` group, :ref:`int` notification **)** Sends the given notification to all members of the ``group``. - .. _class_SceneTree_notify_group_flags: +.. _class_SceneTree_notify_group_flags: - 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`. - .. _class_SceneTree_queue_delete: +.. _class_SceneTree_queue_delete: - void **queue_delete** **(** :ref:`Object` obj **)** Queues the given object for deletion, delaying the call to :ref:`Object.free` to after the current frame. - .. _class_SceneTree_quit: +.. _class_SceneTree_quit: - void **quit** **(** **)** Quits the application. - .. _class_SceneTree_reload_current_scene: +.. _class_SceneTree_reload_current_scene: - :ref:`Error` **reload_current_scene** **(** **)** Reloads the currently active scene. - .. _class_SceneTree_set_auto_accept_quit: +.. _class_SceneTree_set_auto_accept_quit: - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** If ``true`` the application automatically accepts quitting. - .. _class_SceneTree_set_group: +.. _class_SceneTree_set_group: - 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: +.. _class_SceneTree_set_group_flags: - 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`. - .. _class_SceneTree_set_input_as_handled: +.. _class_SceneTree_set_input_as_handled: - void **set_input_as_handled** **(** **)** Marks the most recent input event as handled. - .. _class_SceneTree_set_quit_on_go_back: +.. _class_SceneTree_set_quit_on_go_back: - void **set_quit_on_go_back** **(** :ref:`bool` enabled **)** If ``true`` the application quits automatically on going back (e.g. on Android). - .. _class_SceneTree_set_screen_stretch: +.. _class_SceneTree_set_screen_stretch: - void **set_screen_stretch** **(** :ref:`StretchMode` mode, :ref:`StretchAspect` aspect, :ref:`Vector2` minsize, :ref:`float` shrink=1 **)** diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index 94f74478b..a95fa29f8 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -26,14 +26,14 @@ Properties Signals ------- - .. _class_SceneTreeTimer_timeout: +.. _class_SceneTreeTimer_timeout: - **timeout** **(** **)** Property Descriptions --------------------- - .. _class_SceneTreeTimer_time_left: +.. _class_SceneTreeTimer_time_left: - :ref:`float` **time_left** diff --git a/classes/class_script.rst b/classes/class_script.rst index 116a6e02a..d144724a6 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -57,10 +57,11 @@ Tutorials --------- - :doc:`../getting_started/step_by_step/scripting` + Property Descriptions --------------------- - .. _class_Script_source_code: +.. _class_Script_source_code: - :ref:`String` **source_code** @@ -75,49 +76,49 @@ The script source code or an empty string if source code is not available. When Method Descriptions ------------------- - .. _class_Script_can_instance: +.. _class_Script_can_instance: - :ref:`bool` **can_instance** **(** **)** const Returns ``true`` if the script can be instanced. - .. _class_Script_get_base_script: +.. _class_Script_get_base_script: - :ref:`Script` **get_base_script** **(** **)** const Returns the script directly inherited by this script. - .. _class_Script_get_instance_base_type: +.. _class_Script_get_instance_base_type: - :ref:`String` **get_instance_base_type** **(** **)** const Returns the script's base type. - .. _class_Script_has_script_signal: +.. _class_Script_has_script_signal: - :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. - .. _class_Script_has_source_code: +.. _class_Script_has_source_code: - :ref:`bool` **has_source_code** **(** **)** const Returns ``true`` if the script contains non-empty source code. - .. _class_Script_instance_has: +.. _class_Script_instance_has: - :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const Returns ``true`` if ``base_object`` is an instance of this script. - .. _class_Script_is_tool: +.. _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. - .. _class_Script_reload: +.. _class_Script_reload: - :ref:`Error` **reload** **(** :ref:`bool` keep_state=false **)** diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index eb8b2211a..ae3bf25a5 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -26,7 +26,7 @@ Methods Signals ------- - .. _class_ScriptCreateDialog_script_created: +.. _class_ScriptCreateDialog_script_created: - **script_created** **(** :ref:`Script` script **)** @@ -47,7 +47,7 @@ The ScriptCreateDialog creates script files according to a given template for a Method Descriptions ------------------- - .. _class_ScriptCreateDialog_config: +.. _class_ScriptCreateDialog_config: - void **config** **(** :ref:`String` inherits, :ref:`String` path **)** diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 1caab4540..95bf764ab 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -36,13 +36,13 @@ Methods Signals ------- - .. _class_ScriptEditor_editor_script_changed: +.. _class_ScriptEditor_editor_script_changed: - **editor_script_changed** **(** :ref:`Script` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. - .. _class_ScriptEditor_script_close: +.. _class_ScriptEditor_script_close: - **script_close** **(** :ref:`Script` script **)** @@ -51,31 +51,31 @@ Emitted when editor is about to close the active script. Argument is a :ref:`Scr Method Descriptions ------------------- - .. _class_ScriptEditor_can_drop_data_fw: +.. _class_ScriptEditor_can_drop_data_fw: - :ref:`bool` **can_drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** const - .. _class_ScriptEditor_drop_data_fw: +.. _class_ScriptEditor_drop_data_fw: - void **drop_data_fw** **(** :ref:`Vector2` point, :ref:`Variant` data, :ref:`Control` from **)** - .. _class_ScriptEditor_get_current_script: +.. _class_ScriptEditor_get_current_script: - :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. - .. _class_ScriptEditor_get_drag_data_fw: +.. _class_ScriptEditor_get_drag_data_fw: - :ref:`Variant` **get_drag_data_fw** **(** :ref:`Vector2` point, :ref:`Control` from **)** - .. _class_ScriptEditor_get_open_scripts: +.. _class_ScriptEditor_get_open_scripts: - :ref:`Array` **get_open_scripts** **(** **)** const Returns an array with all :ref:`Script` objects which are currently open in editor. - .. _class_ScriptEditor_open_script_create_dialog: +.. _class_ScriptEditor_open_script_create_dialog: - 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 4f00afdb3..2c6d6d2a6 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -28,7 +28,7 @@ Properties Signals ------- - .. _class_ScrollBar_scrolling: +.. _class_ScrollBar_scrolling: - **scrolling** **(** **)** @@ -42,7 +42,7 @@ Scrollbars are a :ref:`Range` based :ref:`Control`, Property Descriptions --------------------- - .. _class_ScrollBar_custom_step: +.. _class_ScrollBar_custom_step: - :ref:`float` **custom_step** diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 55b05b654..ae6b784c0 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -52,13 +52,13 @@ Theme Properties Signals ------- - .. _class_ScrollContainer_scroll_ended: +.. _class_ScrollContainer_scroll_ended: - **scroll_ended** **(** **)** Emitted whenever scrolling stops. - .. _class_ScrollContainer_scroll_started: +.. _class_ScrollContainer_scroll_started: - **scroll_started** **(** **)** @@ -72,7 +72,7 @@ A ScrollContainer node with a :ref:`Control` child and scrollbar Property Descriptions --------------------- - .. _class_ScrollContainer_scroll_deadzone: +.. _class_ScrollContainer_scroll_deadzone: - :ref:`int` **scroll_deadzone** @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | get_deadzone() | +----------+---------------------+ - .. _class_ScrollContainer_scroll_horizontal: +.. _class_ScrollContainer_scroll_horizontal: - :ref:`int` **scroll_horizontal** @@ -94,7 +94,7 @@ Property Descriptions The current horizontal scroll value. - .. _class_ScrollContainer_scroll_horizontal_enabled: +.. _class_ScrollContainer_scroll_horizontal_enabled: - :ref:`bool` **scroll_horizontal_enabled** @@ -106,7 +106,7 @@ The current horizontal scroll value. If ``true``, enables horizontal scrolling. - .. _class_ScrollContainer_scroll_vertical: +.. _class_ScrollContainer_scroll_vertical: - :ref:`int` **scroll_vertical** @@ -118,7 +118,7 @@ If ``true``, enables horizontal scrolling. The current vertical scroll value. - .. _class_ScrollContainer_scroll_vertical_enabled: +.. _class_ScrollContainer_scroll_vertical_enabled: - :ref:`bool` **scroll_vertical_enabled** @@ -133,11 +133,11 @@ If ``true``, enables vertical scrolling. Method Descriptions ------------------- - .. _class_ScrollContainer_get_h_scrollbar: +.. _class_ScrollContainer_get_h_scrollbar: - :ref:`HScrollBar` **get_h_scrollbar** **(** **)** - .. _class_ScrollContainer_get_v_scrollbar: +.. _class_ScrollContainer_get_v_scrollbar: - :ref:`VScrollBar` **get_v_scrollbar** **(** **)** diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index d9489b3d3..7402adb50 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -33,7 +33,7 @@ Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``. Property Descriptions --------------------- - .. _class_SegmentShape2D_a: +.. _class_SegmentShape2D_a: - :ref:`Vector2` **a** @@ -45,7 +45,7 @@ Property Descriptions The segment's first point position. - .. _class_SegmentShape2D_b: +.. _class_SegmentShape2D_b: - :ref:`Vector2` **b** diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 6a812711d..fa8b5eb19 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -33,13 +33,13 @@ A synchronization Semaphore. Element used to synchronize multiple :ref:`Thread` **post** **(** **)** Lowers the ``Semaphore``, allowing one more thread in. Returns OK on success, ERR_BUSY otherwise. - .. _class_Semaphore_wait: +.. _class_Semaphore_wait: - :ref:`Error` **wait** **(** **)** diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 63ef6687c..d604b2352 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -41,7 +41,7 @@ Methods Enumerations ------------ - .. _enum_Shader_Mode: +.. _enum_Shader_Mode: enum **Mode**: @@ -58,10 +58,11 @@ Tutorials --------- - :doc:`../tutorials/shading/index` + Property Descriptions --------------------- - .. _class_Shader_code: +.. _class_Shader_code: - :ref:`String` **code** @@ -74,21 +75,21 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Shader_get_default_texture_param: +.. _class_Shader_get_default_texture_param: - :ref:`Texture` **get_default_texture_param** **(** :ref:`String` param **)** const - .. _class_Shader_get_mode: +.. _class_Shader_get_mode: - :ref:`Mode` **get_mode** **(** **)** const Returns the shader mode for the shader, either ``MODE_CANVAS_ITEM``, ``MODE_SPATIAL`` or ``MODE_PARTICLES`` - .. _class_Shader_has_param: +.. _class_Shader_has_param: - :ref:`bool` **has_param** **(** :ref:`String` name **)** const - .. _class_Shader_set_default_texture_param: +.. _class_Shader_set_default_texture_param: - void **set_default_texture_param** **(** :ref:`String` param, :ref:`Texture` texture **)** diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 4082cc3e5..9f92585b1 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -44,7 +44,7 @@ A material that uses a custom :ref:`Shader` program to render eith Property Descriptions --------------------- - .. _class_ShaderMaterial_shader: +.. _class_ShaderMaterial_shader: - :ref:`Shader` **shader** @@ -59,21 +59,21 @@ The :ref:`Shader` program used to render this material. Method Descriptions ------------------- - .. _class_ShaderMaterial_get_shader_param: +.. _class_ShaderMaterial_get_shader_param: - :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_property_can_revert: +.. _class_ShaderMaterial_property_can_revert: - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** - .. _class_ShaderMaterial_property_get_revert: +.. _class_ShaderMaterial_property_get_revert: - :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** - .. _class_ShaderMaterial_set_shader_param: +.. _class_ShaderMaterial_set_shader_param: - void **set_shader_param** **(** :ref:`String` param, :ref:`Variant` value **)** diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 6e4b266a5..6a6ee5ea3 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -34,10 +34,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_Shape_margin: +.. _class_Shape_margin: - :ref:`float` **margin** diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index db5468a6b..0fbabe878 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -47,10 +47,11 @@ Tutorials --------- - :doc:`../tutorials/physics/physics_introduction` + Property Descriptions --------------------- - .. _class_Shape2D_custom_solver_bias: +.. _class_Shape2D_custom_solver_bias: - :ref:`float` **custom_solver_bias** @@ -63,7 +64,7 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Shape2D_collide: +.. _class_Shape2D_collide: - :ref:`bool` **collide** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -71,7 +72,7 @@ Returns ``true`` if this shape is colliding with another. This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). - .. _class_Shape2D_collide_and_get_contacts: +.. _class_Shape2D_collide_and_get_contacts: - :ref:`Variant` **collide_and_get_contacts** **(** :ref:`Transform2D` local_xform, :ref:`Shape2D` with_shape, :ref:`Transform2D` shape_xform **)** @@ -79,7 +80,7 @@ Returns a list of the points where this shape touches another. If there are no c This method needs the transformation matrix for this shape (``local_xform``), the shape to check collisions with (``with_shape``), and the transformation matrix of that shape (``shape_xform``). - .. _class_Shape2D_collide_with_motion: +.. _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 **)** @@ -87,7 +88,7 @@ Return whether this shape would collide with another, if a given movement was ap This method needs the transformation matrix for this shape (``local_xform``), the movement to test on this shape (``local_motion``), the shape to check collisions with (``with_shape``), the transformation matrix of that shape (``shape_xform``), and the movement to test onto the other object (``shape_motion``). - .. _class_Shape2D_collide_with_motion_and_get_contacts: +.. _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 **)** diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 1eb078a01..cd257fd29 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -44,7 +44,7 @@ Shortcuts are commonly used for interacting with a :ref:`Control` Property Descriptions --------------------- - .. _class_ShortCut_shortcut: +.. _class_ShortCut_shortcut: - :ref:`InputEvent` **shortcut** @@ -61,19 +61,19 @@ Generally the :ref:`InputEvent` is a keyboard key, though it c Method Descriptions ------------------- - .. _class_ShortCut_get_as_text: +.. _class_ShortCut_get_as_text: - :ref:`String` **get_as_text** **(** **)** const Returns the shortcut's :ref:`InputEvent` as a :ref:`String`. - .. _class_ShortCut_is_shortcut: +.. _class_ShortCut_is_shortcut: - :ref:`bool` **is_shortcut** **(** :ref:`InputEvent` event **)** const Returns ``true`` if the shortcut's :ref:`InputEvent` equals ``event``. - .. _class_ShortCut_is_valid: +.. _class_ShortCut_is_valid: - :ref:`bool` **is_valid** **(** **)** const diff --git a/classes/class_simplexnoise.rst b/classes/class_simplexnoise.rst index f92297011..5265ecad7 100644 --- a/classes/class_simplexnoise.rst +++ b/classes/class_simplexnoise.rst @@ -26,7 +26,7 @@ Properties +---------------------------+----------------------------------------------------+ | :ref:`float` | :ref:`period` | +---------------------------+----------------------------------------------------+ -| :ref:`float` | :ref:`persistance` | +| :ref:`float` | :ref:`persistence` | +---------------------------+----------------------------------------------------+ | :ref:`int` | :ref:`seed` | +---------------------------+----------------------------------------------------+ @@ -67,18 +67,18 @@ Here is a brief usage example that configures a SimplexNoise and gets samples at noise.seed = randi() noise.octaves = 4 noise.period = 20.0 - noise.persistance = 0.8 + noise.persistence = 0.8 - #Sample + # Sample print("Values:") - print(noise.get_noise_2d(1.0,1.0)) - print(noise.get_noise_3d(0.5,3.0,15.0)) - print(noise.get_noise_3d(0.5,1.9,4.7,0.0)) + print(noise.get_noise_2d(1.0, 1.0)) + print(noise.get_noise_3d(0.5, 3.0, 15.0)) + print(noise.get_noise_4d(0.5, 1.9, 4.7, 0.0)) Property Descriptions --------------------- - .. _class_SimplexNoise_lacunarity: +.. _class_SimplexNoise_lacunarity: - :ref:`float` **lacunarity** @@ -90,7 +90,7 @@ Property Descriptions Difference in period between :ref:`octaves`. - .. _class_SimplexNoise_octaves: +.. _class_SimplexNoise_octaves: - :ref:`int` **octaves** @@ -100,9 +100,9 @@ Difference in period between :ref:`octaves`. | *Getter* | get_octaves() | +----------+--------------------+ -Number of Simplex Noise layers that are sampled to get the fractal noise. +Number of Simplex noise layers that are sampled to get the fractal noise. - .. _class_SimplexNoise_period: +.. _class_SimplexNoise_period: - :ref:`float` **period** @@ -112,25 +112,25 @@ Number of Simplex Noise layers that are sampled to get the fractal noise. | *Getter* | get_period() | +----------+-------------------+ -Period of the base octave. +Period of the base octave. -A lower period results in a higher frequancy noise (more value changes across the same distance). +A lower period results in a higher-frequency noise (more value changes across the same distance). - .. _class_SimplexNoise_persistance: +.. _class_SimplexNoise_persistence: -- :ref:`float` **persistance** +- :ref:`float` **persistence** +----------+------------------------+ -| *Setter* | set_persistance(value) | +| *Setter* | set_persistence(value) | +----------+------------------------+ -| *Getter* | get_persistance() | +| *Getter* | get_persistence() | +----------+------------------------+ -Contribuiton factor of the different octaves. +Contribution factor of the different octaves. -A ``persistance`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. +A ``persistence`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one. - .. _class_SimplexNoise_seed: +.. _class_SimplexNoise_seed: - :ref:`int` **seed** @@ -145,47 +145,47 @@ Seed used to generate random values, different seeds will generate different noi Method Descriptions ------------------- - .. _class_SimplexNoise_get_image: +.. _class_SimplexNoise_get_image: - :ref:`Image` **get_image** **(** :ref:`int` width, :ref:`int` height **)** Generate a noise image with the requested ``width`` and ``height``, based on the current noise parameters. - .. _class_SimplexNoise_get_noise_2d: +.. _class_SimplexNoise_get_noise_2d: - :ref:`float` **get_noise_2d** **(** :ref:`float` x, :ref:`float` y **)** -2D noise value -1,1 at position ``x``,``y``. +Returns the 2D noise value ``[-1,1]`` at the given position. - .. _class_SimplexNoise_get_noise_2dv: +.. _class_SimplexNoise_get_noise_2dv: - :ref:`float` **get_noise_2dv** **(** :ref:`Vector2` pos **)** -2D noise value -1,1 at position ``pos.x``,``pos.y``. +Returns the 2D noise value ``[-1,1]`` at the given position. - .. _class_SimplexNoise_get_noise_3d: +.. _class_SimplexNoise_get_noise_3d: - :ref:`float` **get_noise_3d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** -3D noise value -1,1 at position ``x``,``y``,``z``. +Returns the 3D noise value ``[-1,1]`` at the given position. - .. _class_SimplexNoise_get_noise_3dv: +.. _class_SimplexNoise_get_noise_3dv: - :ref:`float` **get_noise_3dv** **(** :ref:`Vector3` pos **)** -3D noise value -1,1 at position ``pos.x``,``pos.y``,``pos.z``. +Returns the 3D noise value ``[-1,1]`` at the given position. - .. _class_SimplexNoise_get_noise_4d: +.. _class_SimplexNoise_get_noise_4d: - :ref:`float` **get_noise_4d** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** -4D noise value -1,1 at position ``x``,``y``,``z``,``w``. +Returns the 4D noise value ``[-1,1]`` at the given position. - .. _class_SimplexNoise_get_seamless_image: +.. _class_SimplexNoise_get_seamless_image: - :ref:`Image` **get_seamless_image** **(** :ref:`int` size **)** -Generate a tileable noise image, based on the current noise parameters. +Generate a tileable noise image, based on the current noise parameters. -Generated seamless images are always square (``size``\ x``size``). +Generated seamless images are always square (``size`` x ``size``). diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index ae8079401..2a0aea462 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -79,6 +79,7 @@ Constants --------- - **NOTIFICATION_UPDATE_SKELETON** = **50** + Description ----------- @@ -91,145 +92,145 @@ Note that "global pose" below refers to the overall transform of the bone with r Method Descriptions ------------------- - .. _class_Skeleton_add_bone: +.. _class_Skeleton_add_bone: - 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: +.. _class_Skeleton_bind_child_node_to_bone: - void **bind_child_node_to_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. - .. _class_Skeleton_clear_bones: +.. _class_Skeleton_clear_bones: - void **clear_bones** **(** **)** Clear all the bones in this skeleton. - .. _class_Skeleton_find_bone: +.. _class_Skeleton_find_bone: - :ref:`int` **find_bone** **(** :ref:`String` name **)** const Return the bone index that matches "name" as its name. - .. _class_Skeleton_get_bone_count: +.. _class_Skeleton_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const Return the amount of bones in the skeleton. - .. _class_Skeleton_get_bone_custom_pose: +.. _class_Skeleton_get_bone_custom_pose: - :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: +.. _class_Skeleton_get_bone_global_pose: - :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: +.. _class_Skeleton_get_bone_name: - :ref:`String` **get_bone_name** **(** :ref:`int` bone_idx **)** const Return the name of the bone at index "index". - .. _class_Skeleton_get_bone_parent: +.. _class_Skeleton_get_bone_parent: - :ref:`int` **get_bone_parent** **(** :ref:`int` bone_idx **)** const Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". - .. _class_Skeleton_get_bone_pose: +.. _class_Skeleton_get_bone_pose: - :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: +.. _class_Skeleton_get_bone_rest: - :ref:`Transform` **get_bone_rest** **(** :ref:`int` bone_idx **)** const Return the rest transform for a bone "bone_idx". - .. _class_Skeleton_get_bone_transform: +.. _class_Skeleton_get_bone_transform: - :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: +.. _class_Skeleton_get_bound_child_nodes_to_bone: - :ref:`Array` **get_bound_child_nodes_to_bone** **(** :ref:`int` bone_idx **)** const Deprecated soon. - .. _class_Skeleton_is_bone_rest_disabled: +.. _class_Skeleton_is_bone_rest_disabled: - :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const - .. _class_Skeleton_physical_bones_add_collision_exception: +.. _class_Skeleton_physical_bones_add_collision_exception: - void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** - .. _class_Skeleton_physical_bones_remove_collision_exception: +.. _class_Skeleton_physical_bones_remove_collision_exception: - void **physical_bones_remove_collision_exception** **(** :ref:`RID` exception **)** - .. _class_Skeleton_physical_bones_start_simulation: +.. _class_Skeleton_physical_bones_start_simulation: - void **physical_bones_start_simulation** **(** :ref:`Array` bones=[ ] **)** - .. _class_Skeleton_physical_bones_stop_simulation: +.. _class_Skeleton_physical_bones_stop_simulation: - void **physical_bones_stop_simulation** **(** **)** - .. _class_Skeleton_set_bone_custom_pose: +.. _class_Skeleton_set_bone_custom_pose: - void **set_bone_custom_pose** **(** :ref:`int` bone_idx, :ref:`Transform` custom_pose **)** - .. _class_Skeleton_set_bone_disable_rest: +.. _class_Skeleton_set_bone_disable_rest: - void **set_bone_disable_rest** **(** :ref:`int` bone_idx, :ref:`bool` disable **)** - .. _class_Skeleton_set_bone_global_pose: +.. _class_Skeleton_set_bone_global_pose: - void **set_bone_global_pose** **(** :ref:`int` bone_idx, :ref:`Transform` pose **)** - .. _class_Skeleton_set_bone_ignore_animation: +.. _class_Skeleton_set_bone_ignore_animation: - void **set_bone_ignore_animation** **(** :ref:`int` bone, :ref:`bool` ignore **)** - .. _class_Skeleton_set_bone_parent: +.. _class_Skeleton_set_bone_parent: - void **set_bone_parent** **(** :ref:`int` bone_idx, :ref:`int` parent_idx **)** Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". - .. _class_Skeleton_set_bone_pose: +.. _class_Skeleton_set_bone_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: +.. _class_Skeleton_set_bone_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: +.. _class_Skeleton_unbind_child_node_from_bone: - void **unbind_child_node_from_bone** **(** :ref:`int` bone_idx, :ref:`Node` node **)** Deprecated soon. - .. _class_Skeleton_unparent_bone_and_rest: +.. _class_Skeleton_unparent_bone_and_rest: - void **unparent_bone_and_rest** **(** :ref:`int` bone_idx **)** diff --git a/classes/class_skeleton2d.rst b/classes/class_skeleton2d.rst index f8a872287..f868f770f 100644 --- a/classes/class_skeleton2d.rst +++ b/classes/class_skeleton2d.rst @@ -30,15 +30,15 @@ Methods Method Descriptions ------------------- - .. _class_Skeleton2D_get_bone: +.. _class_Skeleton2D_get_bone: - :ref:`Bone2D` **get_bone** **(** :ref:`int` idx **)** - .. _class_Skeleton2D_get_bone_count: +.. _class_Skeleton2D_get_bone_count: - :ref:`int` **get_bone_count** **(** **)** const - .. _class_Skeleton2D_get_skeleton: +.. _class_Skeleton2D_get_skeleton: - :ref:`RID` **get_skeleton** **(** **)** const diff --git a/classes/class_skeletonik.rst b/classes/class_skeletonik.rst index 3d01069d4..f07444abd 100644 --- a/classes/class_skeletonik.rst +++ b/classes/class_skeletonik.rst @@ -55,7 +55,7 @@ Methods Property Descriptions --------------------- - .. _class_SkeletonIK_interpolation: +.. _class_SkeletonIK_interpolation: - :ref:`float` **interpolation** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | get_interpolation() | +----------+--------------------------+ - .. _class_SkeletonIK_magnet: +.. _class_SkeletonIK_magnet: - :ref:`Vector3` **magnet** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_magnet_position() | +----------+----------------------------+ - .. _class_SkeletonIK_max_iterations: +.. _class_SkeletonIK_max_iterations: - :ref:`int` **max_iterations** @@ -85,7 +85,7 @@ Property Descriptions | *Getter* | get_max_iterations() | +----------+---------------------------+ - .. _class_SkeletonIK_min_distance: +.. _class_SkeletonIK_min_distance: - :ref:`float` **min_distance** @@ -95,7 +95,7 @@ Property Descriptions | *Getter* | get_min_distance() | +----------+-------------------------+ - .. _class_SkeletonIK_root_bone: +.. _class_SkeletonIK_root_bone: - :ref:`String` **root_bone** @@ -105,7 +105,7 @@ Property Descriptions | *Getter* | get_root_bone() | +----------+----------------------+ - .. _class_SkeletonIK_target: +.. _class_SkeletonIK_target: - :ref:`Transform` **target** @@ -115,7 +115,7 @@ Property Descriptions | *Getter* | get_target_transform() | +----------+-----------------------------+ - .. _class_SkeletonIK_target_node: +.. _class_SkeletonIK_target_node: - :ref:`NodePath` **target_node** @@ -125,7 +125,7 @@ Property Descriptions | *Getter* | get_target_node() | +----------+------------------------+ - .. _class_SkeletonIK_tip_bone: +.. _class_SkeletonIK_tip_bone: - :ref:`String` **tip_bone** @@ -135,7 +135,7 @@ Property Descriptions | *Getter* | get_tip_bone() | +----------+---------------------+ - .. _class_SkeletonIK_use_magnet: +.. _class_SkeletonIK_use_magnet: - :ref:`bool` **use_magnet** @@ -148,19 +148,19 @@ Property Descriptions Method Descriptions ------------------- - .. _class_SkeletonIK_get_parent_skeleton: +.. _class_SkeletonIK_get_parent_skeleton: - :ref:`Skeleton` **get_parent_skeleton** **(** **)** const - .. _class_SkeletonIK_is_running: +.. _class_SkeletonIK_is_running: - :ref:`bool` **is_running** **(** **)** - .. _class_SkeletonIK_start: +.. _class_SkeletonIK_start: - void **start** **(** :ref:`bool` one_time=false **)** - .. _class_SkeletonIK_stop: +.. _class_SkeletonIK_stop: - void **stop** **(** **)** diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 7872d96ce..35b0044b5 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_Sky_RadianceSize: +.. _enum_Sky_RadianceSize: enum **RadianceSize**: @@ -49,7 +49,7 @@ The base class for :ref:`PanoramaSky` and :ref:`ProceduralSky Property Descriptions --------------------- - .. _class_Sky_radiance_size: +.. _class_Sky_radiance_size: - :ref:`RadianceSize` **radiance_size** diff --git a/classes/class_slider.rst b/classes/class_slider.rst index c55154a97..3beafc36e 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -41,7 +41,7 @@ Base class for GUI Sliders. Property Descriptions --------------------- - .. _class_Slider_editable: +.. _class_Slider_editable: - :ref:`bool` **editable** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | is_editable() | +----------+---------------------+ - .. _class_Slider_focus_mode: +.. _class_Slider_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -61,7 +61,7 @@ Property Descriptions | *Getter* | get_focus_mode() | +----------+-----------------------+ - .. _class_Slider_scrollable: +.. _class_Slider_scrollable: - :ref:`bool` **scrollable** @@ -71,7 +71,7 @@ Property Descriptions | *Getter* | is_scrollable() | +----------+-----------------------+ - .. _class_Slider_tick_count: +.. _class_Slider_tick_count: - :ref:`int` **tick_count** @@ -81,7 +81,7 @@ Property Descriptions | *Getter* | get_ticks() | +----------+------------------+ - .. _class_Slider_ticks_on_borders: +.. _class_Slider_ticks_on_borders: - :ref:`bool` **ticks_on_borders** diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index be110a9df..969e39c73 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -68,7 +68,7 @@ Properties Enumerations ------------ - .. _enum_SliderJoint_Param: +.. _enum_SliderJoint_Param: enum **Param**: @@ -104,7 +104,7 @@ Slides across the x-axis of the Pivot object. Property Descriptions --------------------- - .. _class_SliderJoint_angular_limit/damping: +.. _class_SliderJoint_angular_limit/damping: - :ref:`float` **angular_limit/damping** @@ -118,13 +118,13 @@ The amount of damping of the rotation when the limit is surpassed. A lower damping value allows a rotation initiated by body A to travel to body B slower. - .. _class_SliderJoint_angular_limit/lower_angle: +.. _class_SliderJoint_angular_limit/lower_angle: - :ref:`float` **angular_limit/lower_angle** The lower limit of rotation in the slider. - .. _class_SliderJoint_angular_limit/restitution: +.. _class_SliderJoint_angular_limit/restitution: - :ref:`float` **angular_limit/restitution** @@ -138,7 +138,7 @@ The amount of restitution of the rotation when the limit is surpassed. Does not affect damping. - .. _class_SliderJoint_angular_limit/softness: +.. _class_SliderJoint_angular_limit/softness: - :ref:`float` **angular_limit/softness** @@ -152,13 +152,13 @@ A factor applied to the all rotation once the limit is surpassed. Makes all rotation slower when between 0 and 1. - .. _class_SliderJoint_angular_limit/upper_angle: +.. _class_SliderJoint_angular_limit/upper_angle: - :ref:`float` **angular_limit/upper_angle** The upper limit of rotation in the slider. - .. _class_SliderJoint_angular_motion/damping: +.. _class_SliderJoint_angular_motion/damping: - :ref:`float` **angular_motion/damping** @@ -170,7 +170,7 @@ The upper limit of rotation in the slider. The amount of damping of the rotation in the limits. - .. _class_SliderJoint_angular_motion/restitution: +.. _class_SliderJoint_angular_motion/restitution: - :ref:`float` **angular_motion/restitution** @@ -182,7 +182,7 @@ The amount of damping of the rotation in the limits. The amount of restitution of the rotation in the limits. - .. _class_SliderJoint_angular_motion/softness: +.. _class_SliderJoint_angular_motion/softness: - :ref:`float` **angular_motion/softness** @@ -194,7 +194,7 @@ The amount of restitution of the rotation in the limits. A factor applied to the all rotation in the limits. - .. _class_SliderJoint_angular_ortho/damping: +.. _class_SliderJoint_angular_ortho/damping: - :ref:`float` **angular_ortho/damping** @@ -206,7 +206,7 @@ A factor applied to the all rotation in the limits. The amount of damping of the rotation across axes orthogonal to the slider. - .. _class_SliderJoint_angular_ortho/restitution: +.. _class_SliderJoint_angular_ortho/restitution: - :ref:`float` **angular_ortho/restitution** @@ -218,7 +218,7 @@ The amount of damping of the rotation across axes orthogonal to the slider. The amount of restitution of the rotation across axes orthogonal to the slider. - .. _class_SliderJoint_angular_ortho/softness: +.. _class_SliderJoint_angular_ortho/softness: - :ref:`float` **angular_ortho/softness** @@ -230,7 +230,7 @@ The amount of restitution of the rotation across axes orthogonal to the slider. A factor applied to the all rotation across axes orthogonal to the slider. - .. _class_SliderJoint_linear_limit/damping: +.. _class_SliderJoint_linear_limit/damping: - :ref:`float` **linear_limit/damping** @@ -242,7 +242,7 @@ A factor applied to the all rotation across axes orthogonal to the slider. The amount of damping that happens once the limit defined by :ref:`linear_limit/lower_distance` and :ref:`linear_limit/upper_distance` is surpassed. - .. _class_SliderJoint_linear_limit/lower_distance: +.. _class_SliderJoint_linear_limit/lower_distance: - :ref:`float` **linear_limit/lower_distance** @@ -254,7 +254,7 @@ The amount of damping that happens once the limit defined by :ref:`linear_limit/ The minimum difference between the pivot points on their x-axis before damping happens. - .. _class_SliderJoint_linear_limit/restitution: +.. _class_SliderJoint_linear_limit/restitution: - :ref:`float` **linear_limit/restitution** @@ -266,7 +266,7 @@ The minimum difference between the pivot points on their x-axis before damping h The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. - .. _class_SliderJoint_linear_limit/softness: +.. _class_SliderJoint_linear_limit/softness: - :ref:`float` **linear_limit/softness** @@ -278,7 +278,7 @@ The amount of restitution once the limits are surpassed. The lower, the more vel A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement. - .. _class_SliderJoint_linear_limit/upper_distance: +.. _class_SliderJoint_linear_limit/upper_distance: - :ref:`float` **linear_limit/upper_distance** @@ -290,7 +290,7 @@ A factor applied to the movement across the slider axis once the limits get surp The maximum difference between the pivot points on their x-axis before damping happens. - .. _class_SliderJoint_linear_motion/damping: +.. _class_SliderJoint_linear_motion/damping: - :ref:`float` **linear_motion/damping** @@ -302,7 +302,7 @@ The maximum difference between the pivot points on their x-axis before damping h The amount of damping inside the slider limits. - .. _class_SliderJoint_linear_motion/restitution: +.. _class_SliderJoint_linear_motion/restitution: - :ref:`float` **linear_motion/restitution** @@ -314,7 +314,7 @@ The amount of damping inside the slider limits. The amount of restitution inside the slider limits. - .. _class_SliderJoint_linear_motion/softness: +.. _class_SliderJoint_linear_motion/softness: - :ref:`float` **linear_motion/softness** @@ -326,7 +326,7 @@ The amount of restitution inside the slider limits. 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. - .. _class_SliderJoint_linear_ortho/damping: +.. _class_SliderJoint_linear_ortho/damping: - :ref:`float` **linear_ortho/damping** @@ -338,7 +338,7 @@ A factor applied to the movement across the slider axis as long as the slider is The amount of damping when movement is across axes orthogonal to the slider. - .. _class_SliderJoint_linear_ortho/restitution: +.. _class_SliderJoint_linear_ortho/restitution: - :ref:`float` **linear_ortho/restitution** @@ -350,7 +350,7 @@ The amount of damping when movement is across axes orthogonal to the slider. The amount of restitution when movement is across axes orthogonal to the slider. - .. _class_SliderJoint_linear_ortho/softness: +.. _class_SliderJoint_linear_ortho/softness: - :ref:`float` **linear_ortho/softness** diff --git a/classes/class_softbody.rst b/classes/class_softbody.rst index 61218e40d..d837e398f 100644 --- a/classes/class_softbody.rst +++ b/classes/class_softbody.rst @@ -74,7 +74,7 @@ A deformable physics body. Used to create elastic or deformable objects such as Property Descriptions --------------------- - .. _class_SoftBody_areaAngular_stiffness: +.. _class_SoftBody_areaAngular_stiffness: - :ref:`float` **areaAngular_stiffness** @@ -84,7 +84,7 @@ Property Descriptions | *Getter* | get_areaAngular_stiffness() | +----------+----------------------------------+ - .. _class_SoftBody_collision_layer: +.. _class_SoftBody_collision_layer: - :ref:`int` **collision_layer** @@ -100,7 +100,7 @@ Collidable objects can exist in any of 32 different layers. These layers work li A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - .. _class_SoftBody_collision_mask: +.. _class_SoftBody_collision_mask: - :ref:`int` **collision_mask** @@ -112,7 +112,7 @@ A contact is detected if object A is in any of the layers that object B scans, o The physics layers this area scans for collisions. - .. _class_SoftBody_damping_coefficient: +.. _class_SoftBody_damping_coefficient: - :ref:`float` **damping_coefficient** @@ -122,7 +122,7 @@ The physics layers this area scans for collisions. | *Getter* | get_damping_coefficient() | +----------+--------------------------------+ - .. _class_SoftBody_drag_coefficient: +.. _class_SoftBody_drag_coefficient: - :ref:`float` **drag_coefficient** @@ -132,7 +132,7 @@ The physics layers this area scans for collisions. | *Getter* | get_drag_coefficient() | +----------+-----------------------------+ - .. _class_SoftBody_linear_stiffness: +.. _class_SoftBody_linear_stiffness: - :ref:`float` **linear_stiffness** @@ -142,7 +142,7 @@ The physics layers this area scans for collisions. | *Getter* | get_linear_stiffness() | +----------+-----------------------------+ - .. _class_SoftBody_parent_collision_ignore: +.. _class_SoftBody_parent_collision_ignore: - :ref:`NodePath` **parent_collision_ignore** @@ -152,7 +152,7 @@ The physics layers this area scans for collisions. | *Getter* | get_parent_collision_ignore() | +----------+------------------------------------+ - .. _class_SoftBody_pose_matching_coefficient: +.. _class_SoftBody_pose_matching_coefficient: - :ref:`float` **pose_matching_coefficient** @@ -162,7 +162,7 @@ The physics layers this area scans for collisions. | *Getter* | get_pose_matching_coefficient() | +----------+--------------------------------------+ - .. _class_SoftBody_pressure_coefficient: +.. _class_SoftBody_pressure_coefficient: - :ref:`float` **pressure_coefficient** @@ -172,7 +172,7 @@ The physics layers this area scans for collisions. | *Getter* | get_pressure_coefficient() | +----------+---------------------------------+ - .. _class_SoftBody_simulation_precision: +.. _class_SoftBody_simulation_precision: - :ref:`int` **simulation_precision** @@ -184,7 +184,7 @@ The physics layers this area scans for collisions. Increasing this value will improve the resulting simulation, but can affect performance. Use with care. - .. _class_SoftBody_total_mass: +.. _class_SoftBody_total_mass: - :ref:`float` **total_mass** @@ -194,7 +194,7 @@ Increasing this value will improve the resulting simulation, but can affect perf | *Getter* | get_total_mass() | +----------+-----------------------+ - .. _class_SoftBody_volume_stiffness: +.. _class_SoftBody_volume_stiffness: - :ref:`float` **volume_stiffness** @@ -207,47 +207,47 @@ Increasing this value will improve the resulting simulation, but can affect perf Method Descriptions ------------------- - .. _class_SoftBody_add_collision_exception_with: +.. _class_SoftBody_add_collision_exception_with: - void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. - .. _class_SoftBody_get_collision_layer_bit: +.. _class_SoftBody_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_SoftBody_get_collision_mask_bit: +.. _class_SoftBody_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns an individual bit on the collision mask. - .. _class_SoftBody_is_ray_pickable: +.. _class_SoftBody_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const - .. _class_SoftBody_remove_collision_exception_with: +.. _class_SoftBody_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. - .. _class_SoftBody_set_collision_layer_bit: +.. _class_SoftBody_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - .. _class_SoftBody_set_collision_mask_bit: +.. _class_SoftBody_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the collision mask. Use this if you only need to change one layer's value. - .. _class_SoftBody_set_ray_pickable: +.. _class_SoftBody_set_ray_pickable: - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 32fdd1cfe..ff8b3f963 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -113,7 +113,7 @@ Methods Signals ------- - .. _class_Spatial_visibility_changed: +.. _class_Spatial_visibility_changed: - **visibility_changed** **(** **)** @@ -128,6 +128,7 @@ In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for - **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 ----------- @@ -139,10 +140,11 @@ Tutorials --------- - :doc:`../tutorials/3d/introduction_to_3d` + Property Descriptions --------------------- - .. _class_Spatial_gizmo: +.. _class_Spatial_gizmo: - :ref:`SpatialGizmo` **gizmo** @@ -154,7 +156,7 @@ Property Descriptions The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. - .. _class_Spatial_global_transform: +.. _class_Spatial_global_transform: - :ref:`Transform` **global_transform** @@ -166,7 +168,7 @@ The SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` of this node. - .. _class_Spatial_rotation: +.. _class_Spatial_rotation: - :ref:`Vector3` **rotation** @@ -180,7 +182,7 @@ Rotation part of the local transformation in radians, specified in terms of YXZ- 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: +.. _class_Spatial_rotation_degrees: - :ref:`Vector3` **rotation_degrees** @@ -192,7 +194,7 @@ Note that in the mathematical sense, rotation is a matrix and not a vector. The 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: +.. _class_Spatial_scale: - :ref:`Vector3` **scale** @@ -204,7 +206,7 @@ Rotation part of the local transformation in degrees, specified in terms of YXZ- Scale part of the local transformation. - .. _class_Spatial_transform: +.. _class_Spatial_transform: - :ref:`Transform` **transform** @@ -216,7 +218,7 @@ Scale part of the local transformation. Local space :ref:`Transform` of this node, with respect to the parent node. - .. _class_Spatial_translation: +.. _class_Spatial_translation: - :ref:`Vector3` **translation** @@ -228,7 +230,7 @@ Local space :ref:`Transform` of this node, with respect to the Local translation of this node. - .. _class_Spatial_visible: +.. _class_Spatial_visible: - :ref:`bool` **visible** @@ -243,73 +245,73 @@ If ``true`` this node is drawn. Default value: ``true``. Method Descriptions ------------------- - .. _class_Spatial_force_update_transform: +.. _class_Spatial_force_update_transform: - void **force_update_transform** **(** **)** - .. _class_Spatial_get_parent_spatial: +.. _class_Spatial_get_parent_spatial: - :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``. - .. _class_Spatial_get_world: +.. _class_Spatial_get_world: - :ref:`World` **get_world** **(** **)** const Returns the current :ref:`World` resource this Spatial node is registered to. - .. _class_Spatial_global_rotate: +.. _class_Spatial_global_rotate: - 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. - .. _class_Spatial_global_scale: +.. _class_Spatial_global_scale: - void **global_scale** **(** :ref:`Vector3` scale **)** - .. _class_Spatial_global_translate: +.. _class_Spatial_global_translate: - void **global_translate** **(** :ref:`Vector3` offset **)** Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. - .. _class_Spatial_hide: +.. _class_Spatial_hide: - void **hide** **(** **)** Disables rendering of this node. Change Spatial Visible property to false. - .. _class_Spatial_is_local_transform_notification_enabled: +.. _class_Spatial_is_local_transform_notification_enabled: - :ref:`bool` **is_local_transform_notification_enabled** **(** **)** const Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default. - .. _class_Spatial_is_scale_disabled: +.. _class_Spatial_is_scale_disabled: - :ref:`bool` **is_scale_disabled** **(** **)** const - .. _class_Spatial_is_set_as_toplevel: +.. _class_Spatial_is_set_as_toplevel: - :ref:`bool` **is_set_as_toplevel** **(** **)** const Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. - .. _class_Spatial_is_transform_notification_enabled: +.. _class_Spatial_is_transform_notification_enabled: - :ref:`bool` **is_transform_notification_enabled** **(** **)** const Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. - .. _class_Spatial_is_visible_in_tree: +.. _class_Spatial_is_visible_in_tree: - :ref:`bool` **is_visible_in_tree** **(** **)** const Returns whether the node is visible, taking into consideration that its parents visibility. - .. _class_Spatial_look_at: +.. _class_Spatial_look_at: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -319,117 +321,117 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. - .. _class_Spatial_look_at_from_position: +.. _class_Spatial_look_at_from_position: - 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. - .. _class_Spatial_orthonormalize: +.. _class_Spatial_orthonormalize: - void **orthonormalize** **(** **)** Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's Transform3D. - .. _class_Spatial_rotate: +.. _class_Spatial_rotate: - void **rotate** **(** :ref:`Vector3` axis, :ref:`float` angle **)** Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. - .. _class_Spatial_rotate_object_local: +.. _class_Spatial_rotate_object_local: - 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. - .. _class_Spatial_rotate_x: +.. _class_Spatial_rotate_x: - void **rotate_x** **(** :ref:`float` angle **)** Rotates the local transformation around the X axis by angle in radians - .. _class_Spatial_rotate_y: +.. _class_Spatial_rotate_y: - void **rotate_y** **(** :ref:`float` angle **)** Rotates the local transformation around the Y axis by angle in radians. - .. _class_Spatial_rotate_z: +.. _class_Spatial_rotate_z: - void **rotate_z** **(** :ref:`float` angle **)** Rotates the local transformation around the Z axis by angle in radians. - .. _class_Spatial_scale_object_local: +.. _class_Spatial_scale_object_local: - void **scale_object_local** **(** :ref:`Vector3` scale **)** Scales the local transformation by given 3D scale factors in object-local coordinate system. - .. _class_Spatial_set_as_toplevel: +.. _class_Spatial_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** Makes the node ignore its parents transformations. Node transformations are only in global space. - .. _class_Spatial_set_disable_scale: +.. _class_Spatial_set_disable_scale: - void **set_disable_scale** **(** :ref:`bool` disable **)** - .. _class_Spatial_set_identity: +.. _class_Spatial_set_identity: - void **set_identity** **(** **)** Reset all transformations for this node. Set its Transform3D to identity matrix. - .. _class_Spatial_set_ignore_transform_notification: +.. _class_Spatial_set_ignore_transform_notification: - void **set_ignore_transform_notification** **(** :ref:`bool` enabled **)** Set whether the node ignores notification that its transformation (global or local) changed. - .. _class_Spatial_set_notify_local_transform: +.. _class_Spatial_set_notify_local_transform: - void **set_notify_local_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default. - .. _class_Spatial_set_notify_transform: +.. _class_Spatial_set_notify_transform: - void **set_notify_transform** **(** :ref:`bool` enable **)** Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. - .. _class_Spatial_show: +.. _class_Spatial_show: - void **show** **(** **)** Enables rendering of this node. Change Spatial Visible property to "True". - .. _class_Spatial_to_global: +.. _class_Spatial_to_global: - :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const Transforms :ref:`Vector3` "local_point" from this node's local space to world space. - .. _class_Spatial_to_local: +.. _class_Spatial_to_local: - :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const Transforms :ref:`Vector3` "global_point" from world space to this node's local space. - .. _class_Spatial_translate: +.. _class_Spatial_translate: - void **translate** **(** :ref:`Vector3` offset **)** Changes the node's position by given offset :ref:`Vector3`. - .. _class_Spatial_translate_object_local: +.. _class_Spatial_translate_object_local: - void **translate_object_local** **(** :ref:`Vector3` offset **)** - .. _class_Spatial_update_gizmo: +.. _class_Spatial_update_gizmo: - void **update_gizmo** **(** **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 856adcdcc..3077108d3 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -220,14 +220,14 @@ Properties Enumerations ------------ - .. _enum_SpatialMaterial_DetailUV: +.. _enum_SpatialMaterial_DetailUV: enum **DetailUV**: - **DETAIL_UV_1** = **0** - **DETAIL_UV_2** = **1** - .. _enum_SpatialMaterial_TextureParam: +.. _enum_SpatialMaterial_TextureParam: enum **TextureParam**: @@ -249,7 +249,7 @@ enum **TextureParam**: - **TEXTURE_DETAIL_NORMAL** = **15** - **TEXTURE_MAX** = **16** - .. _enum_SpatialMaterial_DistanceFadeMode: +.. _enum_SpatialMaterial_DistanceFadeMode: enum **DistanceFadeMode**: @@ -258,7 +258,7 @@ enum **DistanceFadeMode**: - **DISTANCE_FADE_PIXEL_DITHER** = **2** - **DISTANCE_FADE_OBJECT_DITHER** = **3** - .. _enum_SpatialMaterial_DepthDrawMode: +.. _enum_SpatialMaterial_DepthDrawMode: enum **DepthDrawMode**: @@ -267,7 +267,7 @@ enum **DepthDrawMode**: - **DEPTH_DRAW_DISABLED** = **2** - **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3** - .. _enum_SpatialMaterial_DiffuseMode: +.. _enum_SpatialMaterial_DiffuseMode: enum **DiffuseMode**: @@ -277,7 +277,7 @@ enum **DiffuseMode**: - **DIFFUSE_OREN_NAYAR** = **3** - **DIFFUSE_TOON** = **4** - .. _enum_SpatialMaterial_CullMode: +.. _enum_SpatialMaterial_CullMode: enum **CullMode**: @@ -285,7 +285,7 @@ enum **CullMode**: - **CULL_FRONT** = **1** - **CULL_DISABLED** = **2** - .. _enum_SpatialMaterial_Feature: +.. _enum_SpatialMaterial_Feature: enum **Feature**: @@ -303,7 +303,7 @@ enum **Feature**: - **FEATURE_DETAIL** = **11** - **FEATURE_MAX** = **12** - .. _enum_SpatialMaterial_Flags: +.. _enum_SpatialMaterial_Flags: enum **Flags**: @@ -327,7 +327,7 @@ enum **Flags**: - **FLAG_ENSURE_CORRECT_NORMALS** = **16** - **FLAG_MAX** = **18** - .. _enum_SpatialMaterial_BlendMode: +.. _enum_SpatialMaterial_BlendMode: enum **BlendMode**: @@ -336,7 +336,7 @@ enum **BlendMode**: - **BLEND_MODE_SUB** = **2** - **BLEND_MODE_MUL** = **3** - .. _enum_SpatialMaterial_SpecularMode: +.. _enum_SpatialMaterial_SpecularMode: enum **SpecularMode**: @@ -346,7 +346,7 @@ enum **SpecularMode**: - **SPECULAR_TOON** = **3** - **SPECULAR_DISABLED** = **4** - .. _enum_SpatialMaterial_TextureChannel: +.. _enum_SpatialMaterial_TextureChannel: enum **TextureChannel**: @@ -356,7 +356,7 @@ enum **TextureChannel**: - **TEXTURE_CHANNEL_ALPHA** = **3** - **TEXTURE_CHANNEL_GRAYSCALE** = **4** - .. _enum_SpatialMaterial_BillboardMode: +.. _enum_SpatialMaterial_BillboardMode: enum **BillboardMode**: @@ -365,7 +365,7 @@ enum **BillboardMode**: - **BILLBOARD_FIXED_Y** = **2** - **BILLBOARD_PARTICLES** = **3** - .. _enum_SpatialMaterial_EmissionOperator: +.. _enum_SpatialMaterial_EmissionOperator: enum **EmissionOperator**: @@ -376,10 +376,11 @@ Tutorials --------- - :doc:`../tutorials/3d/spatial_material` + Property Descriptions --------------------- - .. _class_SpatialMaterial_albedo_color: +.. _class_SpatialMaterial_albedo_color: - :ref:`Color` **albedo_color** @@ -389,7 +390,7 @@ Property Descriptions | *Getter* | get_albedo() | +----------+-------------------+ - .. _class_SpatialMaterial_albedo_texture: +.. _class_SpatialMaterial_albedo_texture: - :ref:`Texture` **albedo_texture** @@ -399,7 +400,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_anisotropy: +.. _class_SpatialMaterial_anisotropy: - :ref:`float` **anisotropy** @@ -409,7 +410,7 @@ Property Descriptions | *Getter* | get_anisotropy() | +----------+-----------------------+ - .. _class_SpatialMaterial_anisotropy_enabled: +.. _class_SpatialMaterial_anisotropy_enabled: - :ref:`bool` **anisotropy_enabled** @@ -419,7 +420,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_anisotropy_flowmap: +.. _class_SpatialMaterial_anisotropy_flowmap: - :ref:`Texture` **anisotropy_flowmap** @@ -429,7 +430,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_ao_enabled: +.. _class_SpatialMaterial_ao_enabled: - :ref:`bool` **ao_enabled** @@ -439,7 +440,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_ao_light_affect: +.. _class_SpatialMaterial_ao_light_affect: - :ref:`float` **ao_light_affect** @@ -449,7 +450,7 @@ Property Descriptions | *Getter* | get_ao_light_affect() | +----------+----------------------------+ - .. _class_SpatialMaterial_ao_on_uv2: +.. _class_SpatialMaterial_ao_on_uv2: - :ref:`bool` **ao_on_uv2** @@ -459,7 +460,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_ao_texture: +.. _class_SpatialMaterial_ao_texture: - :ref:`Texture` **ao_texture** @@ -469,7 +470,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_ao_texture_channel: +.. _class_SpatialMaterial_ao_texture_channel: - :ref:`TextureChannel` **ao_texture_channel** @@ -479,7 +480,7 @@ Property Descriptions | *Getter* | get_ao_texture_channel() | +----------+-------------------------------+ - .. _class_SpatialMaterial_clearcoat: +.. _class_SpatialMaterial_clearcoat: - :ref:`float` **clearcoat** @@ -489,7 +490,7 @@ Property Descriptions | *Getter* | get_clearcoat() | +----------+----------------------+ - .. _class_SpatialMaterial_clearcoat_enabled: +.. _class_SpatialMaterial_clearcoat_enabled: - :ref:`bool` **clearcoat_enabled** @@ -499,7 +500,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_clearcoat_gloss: +.. _class_SpatialMaterial_clearcoat_gloss: - :ref:`float` **clearcoat_gloss** @@ -509,7 +510,7 @@ Property Descriptions | *Getter* | get_clearcoat_gloss() | +----------+----------------------------+ - .. _class_SpatialMaterial_clearcoat_texture: +.. _class_SpatialMaterial_clearcoat_texture: - :ref:`Texture` **clearcoat_texture** @@ -519,7 +520,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_depth_deep_parallax: +.. _class_SpatialMaterial_depth_deep_parallax: - :ref:`bool` **depth_deep_parallax** @@ -529,7 +530,7 @@ Property Descriptions | *Getter* | is_depth_deep_parallax_enabled() | +----------+----------------------------------+ - .. _class_SpatialMaterial_depth_enabled: +.. _class_SpatialMaterial_depth_enabled: - :ref:`bool` **depth_enabled** @@ -539,7 +540,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_depth_max_layers: +.. _class_SpatialMaterial_depth_max_layers: - :ref:`int` **depth_max_layers** @@ -549,7 +550,7 @@ Property Descriptions | *Getter* | get_depth_deep_parallax_max_layers() | +----------+-------------------------------------------+ - .. _class_SpatialMaterial_depth_min_layers: +.. _class_SpatialMaterial_depth_min_layers: - :ref:`int` **depth_min_layers** @@ -559,7 +560,7 @@ Property Descriptions | *Getter* | get_depth_deep_parallax_min_layers() | +----------+-------------------------------------------+ - .. _class_SpatialMaterial_depth_scale: +.. _class_SpatialMaterial_depth_scale: - :ref:`float` **depth_scale** @@ -569,7 +570,7 @@ Property Descriptions | *Getter* | get_depth_scale() | +----------+------------------------+ - .. _class_SpatialMaterial_depth_texture: +.. _class_SpatialMaterial_depth_texture: - :ref:`Texture` **depth_texture** @@ -579,7 +580,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_detail_albedo: +.. _class_SpatialMaterial_detail_albedo: - :ref:`Texture` **detail_albedo** @@ -589,7 +590,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_detail_blend_mode: +.. _class_SpatialMaterial_detail_blend_mode: - :ref:`BlendMode` **detail_blend_mode** @@ -599,7 +600,7 @@ Property Descriptions | *Getter* | get_detail_blend_mode() | +----------+------------------------------+ - .. _class_SpatialMaterial_detail_enabled: +.. _class_SpatialMaterial_detail_enabled: - :ref:`bool` **detail_enabled** @@ -609,7 +610,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_detail_mask: +.. _class_SpatialMaterial_detail_mask: - :ref:`Texture` **detail_mask** @@ -619,7 +620,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_detail_normal: +.. _class_SpatialMaterial_detail_normal: - :ref:`Texture` **detail_normal** @@ -629,7 +630,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_detail_uv_layer: +.. _class_SpatialMaterial_detail_uv_layer: - :ref:`DetailUV` **detail_uv_layer** @@ -639,7 +640,7 @@ Property Descriptions | *Getter* | get_detail_uv() | +----------+----------------------+ - .. _class_SpatialMaterial_distance_fade_max_distance: +.. _class_SpatialMaterial_distance_fade_max_distance: - :ref:`float` **distance_fade_max_distance** @@ -649,7 +650,7 @@ Property Descriptions | *Getter* | get_distance_fade_max_distance() | +----------+---------------------------------------+ - .. _class_SpatialMaterial_distance_fade_min_distance: +.. _class_SpatialMaterial_distance_fade_min_distance: - :ref:`float` **distance_fade_min_distance** @@ -659,7 +660,7 @@ Property Descriptions | *Getter* | get_distance_fade_min_distance() | +----------+---------------------------------------+ - .. _class_SpatialMaterial_distance_fade_mode: +.. _class_SpatialMaterial_distance_fade_mode: - :ref:`DistanceFadeMode` **distance_fade_mode** @@ -669,7 +670,7 @@ Property Descriptions | *Getter* | get_distance_fade() | +----------+--------------------------+ - .. _class_SpatialMaterial_emission: +.. _class_SpatialMaterial_emission: - :ref:`Color` **emission** @@ -679,7 +680,7 @@ Property Descriptions | *Getter* | get_emission() | +----------+---------------------+ - .. _class_SpatialMaterial_emission_enabled: +.. _class_SpatialMaterial_emission_enabled: - :ref:`bool` **emission_enabled** @@ -689,7 +690,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_emission_energy: +.. _class_SpatialMaterial_emission_energy: - :ref:`float` **emission_energy** @@ -699,7 +700,7 @@ Property Descriptions | *Getter* | get_emission_energy() | +----------+----------------------------+ - .. _class_SpatialMaterial_emission_on_uv2: +.. _class_SpatialMaterial_emission_on_uv2: - :ref:`bool` **emission_on_uv2** @@ -709,7 +710,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_emission_operator: +.. _class_SpatialMaterial_emission_operator: - :ref:`EmissionOperator` **emission_operator** @@ -719,7 +720,7 @@ Property Descriptions | *Getter* | get_emission_operator() | +----------+------------------------------+ - .. _class_SpatialMaterial_emission_texture: +.. _class_SpatialMaterial_emission_texture: - :ref:`Texture` **emission_texture** @@ -729,7 +730,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_flags_albedo_tex_force_srgb: +.. _class_SpatialMaterial_flags_albedo_tex_force_srgb: - :ref:`bool` **flags_albedo_tex_force_srgb** @@ -739,7 +740,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_disable_ambient_light: +.. _class_SpatialMaterial_flags_disable_ambient_light: - :ref:`bool` **flags_disable_ambient_light** @@ -749,7 +750,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_do_not_receive_shadows: +.. _class_SpatialMaterial_flags_do_not_receive_shadows: - :ref:`bool` **flags_do_not_receive_shadows** @@ -759,7 +760,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_ensure_correct_normals: +.. _class_SpatialMaterial_flags_ensure_correct_normals: - :ref:`bool` **flags_ensure_correct_normals** @@ -769,7 +770,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_fixed_size: +.. _class_SpatialMaterial_flags_fixed_size: - :ref:`bool` **flags_fixed_size** @@ -779,7 +780,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_no_depth_test: +.. _class_SpatialMaterial_flags_no_depth_test: - :ref:`bool` **flags_no_depth_test** @@ -789,7 +790,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_transparent: +.. _class_SpatialMaterial_flags_transparent: - :ref:`bool` **flags_transparent** @@ -799,7 +800,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_flags_unshaded: +.. _class_SpatialMaterial_flags_unshaded: - :ref:`bool` **flags_unshaded** @@ -809,7 +810,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_use_point_size: +.. _class_SpatialMaterial_flags_use_point_size: - :ref:`bool` **flags_use_point_size** @@ -819,7 +820,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_vertex_lighting: +.. _class_SpatialMaterial_flags_vertex_lighting: - :ref:`bool` **flags_vertex_lighting** @@ -829,7 +830,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_flags_world_triplanar: +.. _class_SpatialMaterial_flags_world_triplanar: - :ref:`bool` **flags_world_triplanar** @@ -839,7 +840,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_metallic: +.. _class_SpatialMaterial_metallic: - :ref:`float` **metallic** @@ -849,7 +850,7 @@ Property Descriptions | *Getter* | get_metallic() | +----------+---------------------+ - .. _class_SpatialMaterial_metallic_specular: +.. _class_SpatialMaterial_metallic_specular: - :ref:`float` **metallic_specular** @@ -859,7 +860,7 @@ Property Descriptions | *Getter* | get_specular() | +----------+---------------------+ - .. _class_SpatialMaterial_metallic_texture: +.. _class_SpatialMaterial_metallic_texture: - :ref:`Texture` **metallic_texture** @@ -869,7 +870,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_metallic_texture_channel: +.. _class_SpatialMaterial_metallic_texture_channel: - :ref:`TextureChannel` **metallic_texture_channel** @@ -879,7 +880,7 @@ Property Descriptions | *Getter* | get_metallic_texture_channel() | +----------+-------------------------------------+ - .. _class_SpatialMaterial_normal_enabled: +.. _class_SpatialMaterial_normal_enabled: - :ref:`bool` **normal_enabled** @@ -889,7 +890,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_normal_scale: +.. _class_SpatialMaterial_normal_scale: - :ref:`float` **normal_scale** @@ -899,7 +900,7 @@ Property Descriptions | *Getter* | get_normal_scale() | +----------+-------------------------+ - .. _class_SpatialMaterial_normal_texture: +.. _class_SpatialMaterial_normal_texture: - :ref:`Texture` **normal_texture** @@ -909,7 +910,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_params_alpha_scissor_threshold: +.. _class_SpatialMaterial_params_alpha_scissor_threshold: - :ref:`float` **params_alpha_scissor_threshold** @@ -919,7 +920,7 @@ Property Descriptions | *Getter* | get_alpha_scissor_threshold() | +----------+------------------------------------+ - .. _class_SpatialMaterial_params_billboard_keep_scale: +.. _class_SpatialMaterial_params_billboard_keep_scale: - :ref:`bool` **params_billboard_keep_scale** @@ -929,7 +930,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_params_billboard_mode: +.. _class_SpatialMaterial_params_billboard_mode: - :ref:`BillboardMode` **params_billboard_mode** @@ -939,7 +940,7 @@ Property Descriptions | *Getter* | get_billboard_mode() | +----------+---------------------------+ - .. _class_SpatialMaterial_params_blend_mode: +.. _class_SpatialMaterial_params_blend_mode: - :ref:`BlendMode` **params_blend_mode** @@ -949,7 +950,7 @@ Property Descriptions | *Getter* | get_blend_mode() | +----------+-----------------------+ - .. _class_SpatialMaterial_params_cull_mode: +.. _class_SpatialMaterial_params_cull_mode: - :ref:`CullMode` **params_cull_mode** @@ -959,7 +960,7 @@ Property Descriptions | *Getter* | get_cull_mode() | +----------+----------------------+ - .. _class_SpatialMaterial_params_depth_draw_mode: +.. _class_SpatialMaterial_params_depth_draw_mode: - :ref:`DepthDrawMode` **params_depth_draw_mode** @@ -969,7 +970,7 @@ Property Descriptions | *Getter* | get_depth_draw_mode() | +----------+----------------------------+ - .. _class_SpatialMaterial_params_diffuse_mode: +.. _class_SpatialMaterial_params_diffuse_mode: - :ref:`DiffuseMode` **params_diffuse_mode** @@ -979,7 +980,7 @@ Property Descriptions | *Getter* | get_diffuse_mode() | +----------+-------------------------+ - .. _class_SpatialMaterial_params_grow: +.. _class_SpatialMaterial_params_grow: - :ref:`bool` **params_grow** @@ -989,7 +990,7 @@ Property Descriptions | *Getter* | is_grow_enabled() | +----------+-------------------------+ - .. _class_SpatialMaterial_params_grow_amount: +.. _class_SpatialMaterial_params_grow_amount: - :ref:`float` **params_grow_amount** @@ -999,7 +1000,7 @@ Property Descriptions | *Getter* | get_grow() | +----------+-----------------+ - .. _class_SpatialMaterial_params_line_width: +.. _class_SpatialMaterial_params_line_width: - :ref:`float` **params_line_width** @@ -1009,7 +1010,7 @@ Property Descriptions | *Getter* | get_line_width() | +----------+-----------------------+ - .. _class_SpatialMaterial_params_point_size: +.. _class_SpatialMaterial_params_point_size: - :ref:`float` **params_point_size** @@ -1019,7 +1020,7 @@ Property Descriptions | *Getter* | get_point_size() | +----------+-----------------------+ - .. _class_SpatialMaterial_params_specular_mode: +.. _class_SpatialMaterial_params_specular_mode: - :ref:`SpecularMode` **params_specular_mode** @@ -1029,7 +1030,7 @@ Property Descriptions | *Getter* | get_specular_mode() | +----------+--------------------------+ - .. _class_SpatialMaterial_params_use_alpha_scissor: +.. _class_SpatialMaterial_params_use_alpha_scissor: - :ref:`bool` **params_use_alpha_scissor** @@ -1039,7 +1040,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_particles_anim_h_frames: +.. _class_SpatialMaterial_particles_anim_h_frames: - :ref:`int` **particles_anim_h_frames** @@ -1049,7 +1050,7 @@ Property Descriptions | *Getter* | get_particles_anim_h_frames() | +----------+------------------------------------+ - .. _class_SpatialMaterial_particles_anim_loop: +.. _class_SpatialMaterial_particles_anim_loop: - :ref:`int` **particles_anim_loop** @@ -1059,7 +1060,7 @@ Property Descriptions | *Getter* | get_particles_anim_loop() | +----------+--------------------------------+ - .. _class_SpatialMaterial_particles_anim_v_frames: +.. _class_SpatialMaterial_particles_anim_v_frames: - :ref:`int` **particles_anim_v_frames** @@ -1069,7 +1070,7 @@ Property Descriptions | *Getter* | get_particles_anim_v_frames() | +----------+------------------------------------+ - .. _class_SpatialMaterial_proximity_fade_distance: +.. _class_SpatialMaterial_proximity_fade_distance: - :ref:`float` **proximity_fade_distance** @@ -1079,7 +1080,7 @@ Property Descriptions | *Getter* | get_proximity_fade_distance() | +----------+------------------------------------+ - .. _class_SpatialMaterial_proximity_fade_enable: +.. _class_SpatialMaterial_proximity_fade_enable: - :ref:`bool` **proximity_fade_enable** @@ -1089,7 +1090,7 @@ Property Descriptions | *Getter* | is_proximity_fade_enabled() | +----------+-----------------------------+ - .. _class_SpatialMaterial_refraction_enabled: +.. _class_SpatialMaterial_refraction_enabled: - :ref:`bool` **refraction_enabled** @@ -1099,7 +1100,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_refraction_scale: +.. _class_SpatialMaterial_refraction_scale: - :ref:`float` **refraction_scale** @@ -1109,7 +1110,7 @@ Property Descriptions | *Getter* | get_refraction() | +----------+-----------------------+ - .. _class_SpatialMaterial_refraction_texture: +.. _class_SpatialMaterial_refraction_texture: - :ref:`Texture` **refraction_texture** @@ -1119,7 +1120,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_refraction_texture_channel: +.. _class_SpatialMaterial_refraction_texture_channel: - :ref:`TextureChannel` **refraction_texture_channel** @@ -1129,7 +1130,7 @@ Property Descriptions | *Getter* | get_refraction_texture_channel() | +----------+---------------------------------------+ - .. _class_SpatialMaterial_rim: +.. _class_SpatialMaterial_rim: - :ref:`float` **rim** @@ -1139,7 +1140,7 @@ Property Descriptions | *Getter* | get_rim() | +----------+----------------+ - .. _class_SpatialMaterial_rim_enabled: +.. _class_SpatialMaterial_rim_enabled: - :ref:`bool` **rim_enabled** @@ -1149,7 +1150,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_rim_texture: +.. _class_SpatialMaterial_rim_texture: - :ref:`Texture` **rim_texture** @@ -1159,7 +1160,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_rim_tint: +.. _class_SpatialMaterial_rim_tint: - :ref:`float` **rim_tint** @@ -1169,7 +1170,7 @@ Property Descriptions | *Getter* | get_rim_tint() | +----------+---------------------+ - .. _class_SpatialMaterial_roughness: +.. _class_SpatialMaterial_roughness: - :ref:`float` **roughness** @@ -1179,7 +1180,7 @@ Property Descriptions | *Getter* | get_roughness() | +----------+----------------------+ - .. _class_SpatialMaterial_roughness_texture: +.. _class_SpatialMaterial_roughness_texture: - :ref:`Texture` **roughness_texture** @@ -1189,7 +1190,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_roughness_texture_channel: +.. _class_SpatialMaterial_roughness_texture_channel: - :ref:`TextureChannel` **roughness_texture_channel** @@ -1199,7 +1200,7 @@ Property Descriptions | *Getter* | get_roughness_texture_channel() | +----------+--------------------------------------+ - .. _class_SpatialMaterial_subsurf_scatter_enabled: +.. _class_SpatialMaterial_subsurf_scatter_enabled: - :ref:`bool` **subsurf_scatter_enabled** @@ -1209,7 +1210,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_subsurf_scatter_strength: +.. _class_SpatialMaterial_subsurf_scatter_strength: - :ref:`float` **subsurf_scatter_strength** @@ -1219,7 +1220,7 @@ Property Descriptions | *Getter* | get_subsurface_scattering_strength() | +----------+-------------------------------------------+ - .. _class_SpatialMaterial_subsurf_scatter_texture: +.. _class_SpatialMaterial_subsurf_scatter_texture: - :ref:`Texture` **subsurf_scatter_texture** @@ -1229,7 +1230,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_transmission: +.. _class_SpatialMaterial_transmission: - :ref:`Color` **transmission** @@ -1239,7 +1240,7 @@ Property Descriptions | *Getter* | get_transmission() | +----------+-------------------------+ - .. _class_SpatialMaterial_transmission_enabled: +.. _class_SpatialMaterial_transmission_enabled: - :ref:`bool` **transmission_enabled** @@ -1249,7 +1250,7 @@ Property Descriptions | *Getter* | get_feature() | +----------+--------------------+ - .. _class_SpatialMaterial_transmission_texture: +.. _class_SpatialMaterial_transmission_texture: - :ref:`Texture` **transmission_texture** @@ -1259,7 +1260,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_SpatialMaterial_uv1_offset: +.. _class_SpatialMaterial_uv1_offset: - :ref:`Vector3` **uv1_offset** @@ -1269,7 +1270,7 @@ Property Descriptions | *Getter* | get_uv1_offset() | +----------+-----------------------+ - .. _class_SpatialMaterial_uv1_scale: +.. _class_SpatialMaterial_uv1_scale: - :ref:`Vector3` **uv1_scale** @@ -1279,7 +1280,7 @@ Property Descriptions | *Getter* | get_uv1_scale() | +----------+----------------------+ - .. _class_SpatialMaterial_uv1_triplanar: +.. _class_SpatialMaterial_uv1_triplanar: - :ref:`bool` **uv1_triplanar** @@ -1289,7 +1290,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_uv1_triplanar_sharpness: +.. _class_SpatialMaterial_uv1_triplanar_sharpness: - :ref:`float` **uv1_triplanar_sharpness** @@ -1299,7 +1300,7 @@ Property Descriptions | *Getter* | get_uv1_triplanar_blend_sharpness() | +----------+------------------------------------------+ - .. _class_SpatialMaterial_uv2_offset: +.. _class_SpatialMaterial_uv2_offset: - :ref:`Vector3` **uv2_offset** @@ -1309,7 +1310,7 @@ Property Descriptions | *Getter* | get_uv2_offset() | +----------+-----------------------+ - .. _class_SpatialMaterial_uv2_scale: +.. _class_SpatialMaterial_uv2_scale: - :ref:`Vector3` **uv2_scale** @@ -1319,7 +1320,7 @@ Property Descriptions | *Getter* | get_uv2_scale() | +----------+----------------------+ - .. _class_SpatialMaterial_uv2_triplanar: +.. _class_SpatialMaterial_uv2_triplanar: - :ref:`bool` **uv2_triplanar** @@ -1329,7 +1330,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_uv2_triplanar_sharpness: +.. _class_SpatialMaterial_uv2_triplanar_sharpness: - :ref:`float` **uv2_triplanar_sharpness** @@ -1339,7 +1340,7 @@ Property Descriptions | *Getter* | get_uv2_triplanar_blend_sharpness() | +----------+------------------------------------------+ - .. _class_SpatialMaterial_vertex_color_is_srgb: +.. _class_SpatialMaterial_vertex_color_is_srgb: - :ref:`bool` **vertex_color_is_srgb** @@ -1349,7 +1350,7 @@ Property Descriptions | *Getter* | get_flag() | +----------+-----------------+ - .. _class_SpatialMaterial_vertex_color_use_as_albedo: +.. _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 a727ccae3..eb0365ff9 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -37,7 +37,7 @@ Methods Property Descriptions --------------------- - .. _class_SpatialVelocityTracker_track_physics_step: +.. _class_SpatialVelocityTracker_track_physics_step: - :ref:`bool` **track_physics_step** @@ -50,15 +50,15 @@ Property Descriptions Method Descriptions ------------------- - .. _class_SpatialVelocityTracker_get_tracked_linear_velocity: +.. _class_SpatialVelocityTracker_get_tracked_linear_velocity: - :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const - .. _class_SpatialVelocityTracker_reset: +.. _class_SpatialVelocityTracker_reset: - void **reset** **(** :ref:`Vector3` position **)** - .. _class_SpatialVelocityTracker_update_position: +.. _class_SpatialVelocityTracker_update_position: - void **update_position** **(** :ref:`Vector3` position **)** diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index ac57616e2..7789e53b9 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -39,7 +39,7 @@ Class representing a spherical :ref:`PrimitiveMesh`. Property Descriptions --------------------- - .. _class_SphereMesh_height: +.. _class_SphereMesh_height: - :ref:`float` **height** @@ -51,7 +51,7 @@ Property Descriptions Full height of the sphere. Defaults to 2.0. - .. _class_SphereMesh_is_hemisphere: +.. _class_SphereMesh_is_hemisphere: - :ref:`bool` **is_hemisphere** @@ -63,7 +63,7 @@ Full height of the sphere. Defaults to 2.0. Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false. - .. _class_SphereMesh_radial_segments: +.. _class_SphereMesh_radial_segments: - :ref:`int` **radial_segments** @@ -75,7 +75,7 @@ Determines whether a full sphere or a hemisphere is created. Attention: To get a Number of radial segments on the sphere. Defaults to 64. - .. _class_SphereMesh_radius: +.. _class_SphereMesh_radius: - :ref:`float` **radius** @@ -87,7 +87,7 @@ Number of radial segments on the sphere. Defaults to 64. Radius of sphere. Defaults to 1.0. - .. _class_SphereMesh_rings: +.. _class_SphereMesh_rings: - :ref:`int` **rings** diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index d77e8ed52..63d52cbdc 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -31,7 +31,7 @@ Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody` **radius** diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index b1438e975..74f1356fc 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -49,7 +49,7 @@ SpinBox is a numerical input text field. It allows entering integers and floats. Property Descriptions --------------------- - .. _class_SpinBox_editable: +.. _class_SpinBox_editable: - :ref:`bool` **editable** @@ -59,7 +59,7 @@ Property Descriptions | *Getter* | is_editable() | +----------+---------------------+ - .. _class_SpinBox_prefix: +.. _class_SpinBox_prefix: - :ref:`String` **prefix** @@ -69,7 +69,7 @@ Property Descriptions | *Getter* | get_prefix() | +----------+-------------------+ - .. _class_SpinBox_suffix: +.. _class_SpinBox_suffix: - :ref:`String` **suffix** @@ -82,7 +82,7 @@ Property Descriptions Method Descriptions ------------------- - .. _class_SpinBox_get_line_edit: +.. _class_SpinBox_get_line_edit: - :ref:`LineEdit` **get_line_edit** **(** **)** diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 66c575e2c..f8e9fac69 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -32,7 +32,7 @@ Properties Signals ------- - .. _class_SplitContainer_dragged: +.. _class_SplitContainer_dragged: - **dragged** **(** :ref:`int` offset **)** @@ -41,7 +41,7 @@ Emitted when the dragger is dragged by user. Enumerations ------------ - .. _enum_SplitContainer_DraggerVisibility: +.. _enum_SplitContainer_DraggerVisibility: enum **DraggerVisibility**: @@ -57,7 +57,7 @@ Container for splitting two controls vertically or horizontally, with a grabber Property Descriptions --------------------- - .. _class_SplitContainer_collapsed: +.. _class_SplitContainer_collapsed: - :ref:`bool` **collapsed** @@ -67,7 +67,7 @@ Property Descriptions | *Getter* | is_collapsed() | +----------+----------------------+ - .. _class_SplitContainer_dragger_visibility: +.. _class_SplitContainer_dragger_visibility: - :ref:`DraggerVisibility` **dragger_visibility** @@ -79,7 +79,7 @@ Property Descriptions Determines whether the dragger is visible. - .. _class_SplitContainer_split_offset: +.. _class_SplitContainer_split_offset: - :ref:`int` **split_offset** diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index c46781a95..4019b621e 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -38,10 +38,11 @@ Tutorials --------- - :doc:`../tutorials/3d/lights_and_shadows` + Property Descriptions --------------------- - .. _class_SpotLight_spot_angle: +.. _class_SpotLight_spot_angle: - :ref:`float` **spot_angle** @@ -51,7 +52,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_SpotLight_spot_angle_attenuation: +.. _class_SpotLight_spot_angle_attenuation: - :ref:`float` **spot_angle_attenuation** @@ -61,7 +62,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_SpotLight_spot_attenuation: +.. _class_SpotLight_spot_attenuation: - :ref:`float` **spot_attenuation** @@ -71,7 +72,7 @@ Property Descriptions | *Getter* | get_param() | +----------+------------------+ - .. _class_SpotLight_spot_range: +.. _class_SpotLight_spot_range: - :ref:`float` **spot_range** diff --git a/classes/class_springarm.rst b/classes/class_springarm.rst index 394957ece..bfe215877 100644 --- a/classes/class_springarm.rst +++ b/classes/class_springarm.rst @@ -45,7 +45,7 @@ Methods Property Descriptions --------------------- - .. _class_SpringArm_collision_mask: +.. _class_SpringArm_collision_mask: - :ref:`int` **collision_mask** @@ -55,7 +55,7 @@ Property Descriptions | *Getter* | get_collision_mask() | +----------+---------------------------+ - .. _class_SpringArm_margin: +.. _class_SpringArm_margin: - :ref:`float` **margin** @@ -65,7 +65,7 @@ Property Descriptions | *Getter* | get_margin() | +----------+-------------------+ - .. _class_SpringArm_shape: +.. _class_SpringArm_shape: - :ref:`Shape` **shape** @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_shape() | +----------+------------------+ - .. _class_SpringArm_spring_length: +.. _class_SpringArm_spring_length: - :ref:`float` **spring_length** @@ -88,19 +88,19 @@ Property Descriptions Method Descriptions ------------------- - .. _class_SpringArm_add_excluded_object: +.. _class_SpringArm_add_excluded_object: - void **add_excluded_object** **(** :ref:`RID` RID **)** - .. _class_SpringArm_clear_excluded_objects: +.. _class_SpringArm_clear_excluded_objects: - void **clear_excluded_objects** **(** **)** - .. _class_SpringArm_get_hit_length: +.. _class_SpringArm_get_hit_length: - :ref:`float` **get_hit_length** **(** **)** - .. _class_SpringArm_remove_excluded_object: +.. _class_SpringArm_remove_excluded_object: - :ref:`bool` **remove_excluded_object** **(** :ref:`RID` RID **)** diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index ad42425b6..ba3f20200 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -57,13 +57,13 @@ Methods Signals ------- - .. _class_Sprite_frame_changed: +.. _class_Sprite_frame_changed: - **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. - .. _class_Sprite_texture_changed: +.. _class_Sprite_texture_changed: - **texture_changed** **(** **)** @@ -77,7 +77,7 @@ A node that displays a 2D texture. The texture displayed can be a region from a Property Descriptions --------------------- - .. _class_Sprite_centered: +.. _class_Sprite_centered: - :ref:`bool` **centered** @@ -89,7 +89,7 @@ Property Descriptions If ``true`` texture is centered. Default value: ``true``. - .. _class_Sprite_flip_h: +.. _class_Sprite_flip_h: - :ref:`bool` **flip_h** @@ -101,7 +101,7 @@ If ``true`` texture is centered. Default value: ``true``. If ``true`` texture is flipped horizontally. Default value: ``false``. - .. _class_Sprite_flip_v: +.. _class_Sprite_flip_v: - :ref:`bool` **flip_v** @@ -113,7 +113,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. If ``true`` texture is flipped vertically. Default value: ``false``. - .. _class_Sprite_frame: +.. _class_Sprite_frame: - :ref:`int` **frame** @@ -125,7 +125,7 @@ If ``true`` texture is flipped vertically. Default value: ``false``. Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. - .. _class_Sprite_hframes: +.. _class_Sprite_hframes: - :ref:`int` **hframes** @@ -137,7 +137,7 @@ Current frame to display from sprite sheet. :ref:`vframes` The number of columns in the sprite sheet. - .. _class_Sprite_normal_map: +.. _class_Sprite_normal_map: - :ref:`Texture` **normal_map** @@ -149,7 +149,7 @@ The number of columns in the sprite sheet. The normal map gives depth to the Sprite. - .. _class_Sprite_offset: +.. _class_Sprite_offset: - :ref:`Vector2` **offset** @@ -161,7 +161,7 @@ The normal map gives depth to the Sprite. The texture's drawing offset. - .. _class_Sprite_region_enabled: +.. _class_Sprite_region_enabled: - :ref:`bool` **region_enabled** @@ -173,7 +173,7 @@ The texture's drawing offset. If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. - .. _class_Sprite_region_filter_clip: +.. _class_Sprite_region_filter_clip: - :ref:`bool` **region_filter_clip** @@ -185,7 +185,7 @@ If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Def If ``true`` the outermost pixels get blurred out. - .. _class_Sprite_region_rect: +.. _class_Sprite_region_rect: - :ref:`Rect2` **region_rect** @@ -197,7 +197,7 @@ If ``true`` the outermost pixels get blurred out. The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. - .. _class_Sprite_texture: +.. _class_Sprite_texture: - :ref:`Texture` **texture** @@ -209,7 +209,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. - .. _class_Sprite_vframes: +.. _class_Sprite_vframes: - :ref:`int` **vframes** @@ -224,13 +224,13 @@ The number of rows in the sprite sheet. Method Descriptions ------------------- - .. _class_Sprite_get_rect: +.. _class_Sprite_get_rect: - :ref:`Rect2` **get_rect** **(** **)** const Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. - .. _class_Sprite_is_pixel_opaque: +.. _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 1b65adeef..e885aab0c 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -36,7 +36,7 @@ Properties Signals ------- - .. _class_Sprite3D_frame_changed: +.. _class_Sprite3D_frame_changed: - **frame_changed** **(** **)** @@ -50,7 +50,7 @@ A node that displays a 2D texture in a 3D environment. The texture displayed can Property Descriptions --------------------- - .. _class_Sprite3D_frame: +.. _class_Sprite3D_frame: - :ref:`int` **frame** @@ -62,7 +62,7 @@ Property Descriptions Current frame to display from sprite sheet. :ref:`vframes` or :ref:`hframes` must be greater than 1. - .. _class_Sprite3D_hframes: +.. _class_Sprite3D_hframes: - :ref:`int` **hframes** @@ -74,7 +74,7 @@ Current frame to display from sprite sheet. :ref:`vframes` **region_enabled** @@ -86,7 +86,7 @@ The number of columns in the sprite sheet. If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. - .. _class_Sprite3D_region_rect: +.. _class_Sprite3D_region_rect: - :ref:`Rect2` **region_rect** @@ -98,7 +98,7 @@ If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_re The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. - .. _class_Sprite3D_texture: +.. _class_Sprite3D_texture: - :ref:`Texture` **texture** @@ -110,7 +110,7 @@ The region of the atlas texture to display. :ref:`region_enabled` object to draw. - .. _class_Sprite3D_vframes: +.. _class_Sprite3D_vframes: - :ref:`int` **vframes** diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index c38bb8f64..72f2f05bf 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -59,7 +59,7 @@ Methods Enumerations ------------ - .. _enum_SpriteBase3D_AlphaCutMode: +.. _enum_SpriteBase3D_AlphaCutMode: enum **AlphaCutMode**: @@ -67,7 +67,7 @@ enum **AlphaCutMode**: - **ALPHA_CUT_DISCARD** = **1** - **ALPHA_CUT_OPAQUE_PREPASS** = **2** - .. _enum_SpriteBase3D_DrawFlags: +.. _enum_SpriteBase3D_DrawFlags: enum **DrawFlags**: @@ -84,7 +84,7 @@ A node that displays 2D texture information in a 3D environment. Property Descriptions --------------------- - .. _class_SpriteBase3D_alpha_cut: +.. _class_SpriteBase3D_alpha_cut: - :ref:`AlphaCutMode` **alpha_cut** @@ -94,7 +94,7 @@ Property Descriptions | *Getter* | get_alpha_cut_mode() | +----------+---------------------------+ - .. _class_SpriteBase3D_axis: +.. _class_SpriteBase3D_axis: - :ref:`Axis` **axis** @@ -106,7 +106,7 @@ Property Descriptions The direction in which the front of the texture faces. - .. _class_SpriteBase3D_centered: +.. _class_SpriteBase3D_centered: - :ref:`bool` **centered** @@ -118,7 +118,7 @@ The direction in which the front of the texture faces. If ``true`` texture will be centered. Default value: ``true``. - .. _class_SpriteBase3D_double_sided: +.. _class_SpriteBase3D_double_sided: - :ref:`bool` **double_sided** @@ -130,7 +130,7 @@ If ``true`` texture will be centered. Default value: ``true``. 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: +.. _class_SpriteBase3D_flip_h: - :ref:`bool` **flip_h** @@ -142,7 +142,7 @@ If ``true`` texture can be seen from the back as well, if ``false``, it is invis If ``true`` texture is flipped horizontally. Default value: ``false``. - .. _class_SpriteBase3D_flip_v: +.. _class_SpriteBase3D_flip_v: - :ref:`bool` **flip_v** @@ -154,7 +154,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. If ``true`` texture is flipped vertically. Default value: ``false``. - .. _class_SpriteBase3D_modulate: +.. _class_SpriteBase3D_modulate: - :ref:`Color` **modulate** @@ -166,7 +166,7 @@ If ``true`` texture is flipped vertically. Default value: ``false``. A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. - .. _class_SpriteBase3D_offset: +.. _class_SpriteBase3D_offset: - :ref:`Vector2` **offset** @@ -178,7 +178,7 @@ A color value that gets multiplied on, could be used for mood-coloring or to sim The texture's drawing offset. - .. _class_SpriteBase3D_opacity: +.. _class_SpriteBase3D_opacity: - :ref:`float` **opacity** @@ -190,7 +190,7 @@ The texture's drawing offset. The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visible. - .. _class_SpriteBase3D_pixel_size: +.. _class_SpriteBase3D_pixel_size: - :ref:`float` **pixel_size** @@ -202,7 +202,7 @@ The objects visibility on a scale from ``0`` fully invisible to ``1`` fully visi The size of one pixel's width on the Sprite to scale it in 3D. - .. _class_SpriteBase3D_shaded: +.. _class_SpriteBase3D_shaded: - :ref:`bool` **shaded** @@ -214,7 +214,7 @@ The size of one pixel's width on the Sprite to scale it in 3D. If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. - .. _class_SpriteBase3D_transparent: +.. _class_SpriteBase3D_transparent: - :ref:`bool` **transparent** @@ -229,11 +229,11 @@ If ``true`` the texture's transparency and the opacity are used to make those pa Method Descriptions ------------------- - .. _class_SpriteBase3D_generate_triangle_mesh: +.. _class_SpriteBase3D_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const - .. _class_SpriteBase3D_get_item_rect: +.. _class_SpriteBase3D_get_item_rect: - :ref:`Rect2` **get_item_rect** **(** **)** const diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index 2606510ce..54a9c757c 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -68,104 +68,104 @@ Sprite frame library for :ref:`AnimatedSprite`. Contains f Property Descriptions --------------------- - .. _class_SpriteFrames_frames: +.. _class_SpriteFrames_frames: - :ref:`Array` **frames** Method Descriptions ------------------- - .. _class_SpriteFrames_add_animation: +.. _class_SpriteFrames_add_animation: - void **add_animation** **(** :ref:`String` anim **)** Adds a new animation to the library. - .. _class_SpriteFrames_add_frame: +.. _class_SpriteFrames_add_frame: - void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** Adds a frame to the given animation. - .. _class_SpriteFrames_clear: +.. _class_SpriteFrames_clear: - void **clear** **(** :ref:`String` anim **)** Removes all frames from the given animation. - .. _class_SpriteFrames_clear_all: +.. _class_SpriteFrames_clear_all: - void **clear_all** **(** **)** Removes all animations. A "default" animation will be created. - .. _class_SpriteFrames_get_animation_loop: +.. _class_SpriteFrames_get_animation_loop: - :ref:`bool` **get_animation_loop** **(** :ref:`String` anim **)** const If ``true`` the given animation will loop. - .. _class_SpriteFrames_get_animation_names: +.. _class_SpriteFrames_get_animation_names: - :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: +.. _class_SpriteFrames_get_animation_speed: - :ref:`float` **get_animation_speed** **(** :ref:`String` anim **)** const The animation's speed in frames per second. - .. _class_SpriteFrames_get_frame: +.. _class_SpriteFrames_get_frame: - :ref:`Texture` **get_frame** **(** :ref:`String` anim, :ref:`int` idx **)** const Returns the animation's selected frame. - .. _class_SpriteFrames_get_frame_count: +.. _class_SpriteFrames_get_frame_count: - :ref:`int` **get_frame_count** **(** :ref:`String` anim **)** const Returns the number of frames in the animation. - .. _class_SpriteFrames_has_animation: +.. _class_SpriteFrames_has_animation: - :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const If ``true`` the named animation exists. - .. _class_SpriteFrames_remove_animation: +.. _class_SpriteFrames_remove_animation: - void **remove_animation** **(** :ref:`String` anim **)** Removes the given animation. - .. _class_SpriteFrames_remove_frame: +.. _class_SpriteFrames_remove_frame: - void **remove_frame** **(** :ref:`String` anim, :ref:`int` idx **)** Removes the animation's selected frame. - .. _class_SpriteFrames_rename_animation: +.. _class_SpriteFrames_rename_animation: - void **rename_animation** **(** :ref:`String` anim, :ref:`String` newname **)** Changes the animation's name to ``newname``. - .. _class_SpriteFrames_set_animation_loop: +.. _class_SpriteFrames_set_animation_loop: - void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** If ``true`` the animation will loop. - .. _class_SpriteFrames_set_animation_speed: +.. _class_SpriteFrames_set_animation_speed: - void **set_animation_speed** **(** :ref:`String` anim, :ref:`float` speed **)** The animation's speed in frames per second. - .. _class_SpriteFrames_set_frame: +.. _class_SpriteFrames_set_frame: - void **set_frame** **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index b69500bfd..2c9b68214 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -43,7 +43,7 @@ Alternatively, a constant linear or angular velocity can be set for the static b Property Descriptions --------------------- - .. _class_StaticBody_bounce: +.. _class_StaticBody_bounce: - :ref:`float` **bounce** @@ -55,7 +55,7 @@ Property Descriptions The body bounciness. - .. _class_StaticBody_constant_angular_velocity: +.. _class_StaticBody_constant_angular_velocity: - :ref:`Vector3` **constant_angular_velocity** @@ -67,7 +67,7 @@ The body bounciness. 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: +.. _class_StaticBody_constant_linear_velocity: - :ref:`Vector3` **constant_linear_velocity** @@ -79,7 +79,7 @@ The constant angular velocity for the body. This does not rotate the body, but a 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: +.. _class_StaticBody_friction: - :ref:`float` **friction** @@ -91,7 +91,7 @@ The constant linear velocity for the body. This does not move the body, but affe The body friction, from 0 (frictionless) to 1 (full friction). - .. _class_StaticBody_physics_material_override: +.. _class_StaticBody_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 35518b21d..a3f88b29d 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -41,7 +41,7 @@ Additionally, a constant linear or angular velocity can be set for the static bo Property Descriptions --------------------- - .. _class_StaticBody2D_bounce: +.. _class_StaticBody2D_bounce: - :ref:`float` **bounce** @@ -53,7 +53,7 @@ Property Descriptions The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). - .. _class_StaticBody2D_constant_angular_velocity: +.. _class_StaticBody2D_constant_angular_velocity: - :ref:`float` **constant_angular_velocity** @@ -65,7 +65,7 @@ The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounci Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. - .. _class_StaticBody2D_constant_linear_velocity: +.. _class_StaticBody2D_constant_linear_velocity: - :ref:`Vector2` **constant_linear_velocity** @@ -77,7 +77,7 @@ Constant angular velocity for the body. This does not rotate the body, but affec Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. - .. _class_StaticBody2D_friction: +.. _class_StaticBody2D_friction: - :ref:`float` **friction** @@ -89,7 +89,7 @@ Constant linear velocity for the body. This does not move the body, but affects The body's friction. Values range from ``0`` (no friction) to ``1`` (full friction). - .. _class_StaticBody2D_physics_material_override: +.. _class_StaticBody2D_physics_material_override: - :ref:`PhysicsMaterial` **physics_material_override** diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 260f232f2..d73a286a2 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -98,7 +98,7 @@ StreamPeer is an abstraction and base class for stream-based protocols (such as Property Descriptions --------------------- - .. _class_StreamPeer_big_endian: +.. _class_StreamPeer_big_endian: - :ref:`bool` **big_endian** @@ -113,181 +113,181 @@ If ``true``, this ``StreamPeer`` will using big-endian format for encoding and d Method Descriptions ------------------- - .. _class_StreamPeer_get_16: +.. _class_StreamPeer_get_16: - :ref:`int` **get_16** **(** **)** Get a signed 16 bit value from the stream. - .. _class_StreamPeer_get_32: +.. _class_StreamPeer_get_32: - :ref:`int` **get_32** **(** **)** Get a signed 32 bit value from the stream. - .. _class_StreamPeer_get_64: +.. _class_StreamPeer_get_64: - :ref:`int` **get_64** **(** **)** Get a signed 64 bit value from the stream. - .. _class_StreamPeer_get_8: +.. _class_StreamPeer_get_8: - :ref:`int` **get_8** **(** **)** Get a signed byte from the stream. - .. _class_StreamPeer_get_available_bytes: +.. _class_StreamPeer_get_available_bytes: - :ref:`int` **get_available_bytes** **(** **)** const Return the amount of bytes this ``StreamPeer`` has available. - .. _class_StreamPeer_get_data: +.. _class_StreamPeer_get_data: - :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. - .. _class_StreamPeer_get_double: +.. _class_StreamPeer_get_double: - :ref:`float` **get_double** **(** **)** Get a double-precision float from the stream. - .. _class_StreamPeer_get_float: +.. _class_StreamPeer_get_float: - :ref:`float` **get_float** **(** **)** Get a single-precision float from the stream. - .. _class_StreamPeer_get_partial_data: +.. _class_StreamPeer_get_partial_data: - :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: +.. _class_StreamPeer_get_string: - :ref:`String` **get_string** **(** :ref:`int` bytes **)** Get a string with byte-length "bytes" from the stream. - .. _class_StreamPeer_get_u16: +.. _class_StreamPeer_get_u16: - :ref:`int` **get_u16** **(** **)** Get an unsigned 16 bit value from the stream. - .. _class_StreamPeer_get_u32: +.. _class_StreamPeer_get_u32: - :ref:`int` **get_u32** **(** **)** Get an unsigned 32 bit value from the stream. - .. _class_StreamPeer_get_u64: +.. _class_StreamPeer_get_u64: - :ref:`int` **get_u64** **(** **)** Get an unsigned 64 bit value from the stream. - .. _class_StreamPeer_get_u8: +.. _class_StreamPeer_get_u8: - :ref:`int` **get_u8** **(** **)** Get an unsigned byte from the stream. - .. _class_StreamPeer_get_utf8_string: +.. _class_StreamPeer_get_utf8_string: - :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: +.. _class_StreamPeer_get_var: - :ref:`Variant` **get_var** **(** **)** Get a Variant from the stream. - .. _class_StreamPeer_put_16: +.. _class_StreamPeer_put_16: - void **put_16** **(** :ref:`int` value **)** Put a signed 16 bit value into the stream. - .. _class_StreamPeer_put_32: +.. _class_StreamPeer_put_32: - void **put_32** **(** :ref:`int` value **)** Put a signed 32 bit value into the stream. - .. _class_StreamPeer_put_64: +.. _class_StreamPeer_put_64: - void **put_64** **(** :ref:`int` value **)** Put a signed 64 bit value into the stream. - .. _class_StreamPeer_put_8: +.. _class_StreamPeer_put_8: - void **put_8** **(** :ref:`int` value **)** Put a signed byte into the stream. - .. _class_StreamPeer_put_data: +.. _class_StreamPeer_put_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. - .. _class_StreamPeer_put_double: +.. _class_StreamPeer_put_double: - void **put_double** **(** :ref:`float` value **)** Put a double-precision float into the stream. - .. _class_StreamPeer_put_float: +.. _class_StreamPeer_put_float: - void **put_float** **(** :ref:`float` value **)** Put a single-precision float into the stream. - .. _class_StreamPeer_put_partial_data: +.. _class_StreamPeer_put_partial_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. - .. _class_StreamPeer_put_u16: +.. _class_StreamPeer_put_u16: - void **put_u16** **(** :ref:`int` value **)** Put an unsigned 16 bit value into the stream. - .. _class_StreamPeer_put_u32: +.. _class_StreamPeer_put_u32: - void **put_u32** **(** :ref:`int` value **)** Put an unsigned 32 bit value into the stream. - .. _class_StreamPeer_put_u64: +.. _class_StreamPeer_put_u64: - void **put_u64** **(** :ref:`int` value **)** Put an unsigned 64 bit value into the stream. - .. _class_StreamPeer_put_u8: +.. _class_StreamPeer_put_u8: - void **put_u8** **(** :ref:`int` value **)** Put an unsigned byte into the stream. - .. _class_StreamPeer_put_utf8_string: +.. _class_StreamPeer_put_utf8_string: - void **put_utf8_string** **(** :ref:`String` value **)** Put a zero-terminated utf8 string into the stream. - .. _class_StreamPeer_put_var: +.. _class_StreamPeer_put_var: - void **put_var** **(** :ref:`Variant` value **)** diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 975bd5e0c..6a906a39a 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -43,7 +43,7 @@ Methods Property Descriptions --------------------- - .. _class_StreamPeerBuffer_data_array: +.. _class_StreamPeerBuffer_data_array: - :ref:`PoolByteArray` **data_array** @@ -56,27 +56,27 @@ Property Descriptions Method Descriptions ------------------- - .. _class_StreamPeerBuffer_clear: +.. _class_StreamPeerBuffer_clear: - void **clear** **(** **)** - .. _class_StreamPeerBuffer_duplicate: +.. _class_StreamPeerBuffer_duplicate: - :ref:`StreamPeerBuffer` **duplicate** **(** **)** const - .. _class_StreamPeerBuffer_get_position: +.. _class_StreamPeerBuffer_get_position: - :ref:`int` **get_position** **(** **)** const - .. _class_StreamPeerBuffer_get_size: +.. _class_StreamPeerBuffer_get_size: - :ref:`int` **get_size** **(** **)** const - .. _class_StreamPeerBuffer_resize: +.. _class_StreamPeerBuffer_resize: - void **resize** **(** :ref:`int` size **)** - .. _class_StreamPeerBuffer_seek: +.. _class_StreamPeerBuffer_seek: - void **seek** **(** :ref:`int` position **)** diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 79a6f17b2..3997fcd56 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -41,7 +41,7 @@ Methods Enumerations ------------ - .. _enum_StreamPeerSSL_Status: +.. _enum_StreamPeerSSL_Status: enum **Status**: @@ -59,10 +59,11 @@ Tutorials --------- - :doc:`../tutorials/networking/ssl_certificates` + Property Descriptions --------------------- - .. _class_StreamPeerSSL_blocking_handshake: +.. _class_StreamPeerSSL_blocking_handshake: - :ref:`bool` **blocking_handshake** @@ -75,29 +76,29 @@ Property Descriptions Method Descriptions ------------------- - .. _class_StreamPeerSSL_accept_stream: +.. _class_StreamPeerSSL_accept_stream: - :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` base **)** - .. _class_StreamPeerSSL_connect_to_stream: +.. _class_StreamPeerSSL_connect_to_stream: - :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". - .. _class_StreamPeerSSL_disconnect_from_stream: +.. _class_StreamPeerSSL_disconnect_from_stream: - void **disconnect_from_stream** **(** **)** Disconnect from host. - .. _class_StreamPeerSSL_get_status: +.. _class_StreamPeerSSL_get_status: - :ref:`Status` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. - .. _class_StreamPeerSSL_poll: +.. _class_StreamPeerSSL_poll: - void **poll** **(** **)** diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 9b2948218..d95b0b1c6 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -38,7 +38,7 @@ Methods Enumerations ------------ - .. _enum_StreamPeerTCP_Status: +.. _enum_StreamPeerTCP_Status: enum **Status**: @@ -55,41 +55,41 @@ TCP Stream peer. This object can be used to connect to TCP servers, or also is r Method Descriptions ------------------- - .. _class_StreamPeerTCP_connect_to_host: +.. _class_StreamPeerTCP_connect_to_host: - :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. - .. _class_StreamPeerTCP_disconnect_from_host: +.. _class_StreamPeerTCP_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from host. - .. _class_StreamPeerTCP_get_connected_host: +.. _class_StreamPeerTCP_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. - .. _class_StreamPeerTCP_get_connected_port: +.. _class_StreamPeerTCP_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Return the port of this peer. - .. _class_StreamPeerTCP_get_status: +.. _class_StreamPeerTCP_get_status: - :ref:`Status` **get_status** **(** **)** Return the status of the connection, one of STATUS\_\* enum. - .. _class_StreamPeerTCP_is_connected_to_host: +.. _class_StreamPeerTCP_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const - .. _class_StreamPeerTCP_set_no_delay: +.. _class_StreamPeerTCP_set_no_delay: - void **set_no_delay** **(** :ref:`bool` enabled **)** diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index cd6529884..ba4069980 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -31,7 +31,7 @@ A texture that is loaded from a .stex file. Property Descriptions --------------------- - .. _class_StreamTexture_load_path: +.. _class_StreamTexture_load_path: - :ref:`String` **load_path** diff --git a/classes/class_string.rst b/classes/class_string.rst index 46e1b19f2..273bc6cd6 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -213,451 +213,451 @@ This is the built-in string class (and the one used by GDScript). It supports Un Method Descriptions ------------------- - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`bool` from **)** Constructs a new String from the given :ref:`bool`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`int` from **)** Constructs a new String from the given :ref:`int`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`float` from **)** Constructs a new String from the given :ref:`float`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector2` from **)** Constructs a new String from the given :ref:`Vector2`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Rect2` from **)** Constructs a new String from the given :ref:`Rect2`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Vector3` from **)** Constructs a new String from the given :ref:`Vector3`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform2D` from **)** Constructs a new String from the given :ref:`Transform2D`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Plane` from **)** Constructs a new String from the given :ref:`Plane`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Quat` from **)** Constructs a new String from the given :ref:`Quat`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`AABB` from **)** Constructs a new String from the given :ref:`AABB`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Basis` from **)** Constructs a new String from the given :ref:`Basis`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Transform` from **)** Constructs a new String from the given :ref:`Transform`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Color` from **)** Constructs a new String from the given :ref:`Color`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`NodePath` from **)** Constructs a new String from the given :ref:`NodePath`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`RID` from **)** Constructs a new String from the given :ref:`RID`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Dictionary` from **)** Constructs a new String from the given :ref:`Dictionary`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`Array` from **)** Constructs a new String from the given :ref:`Array`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolByteArray` from **)** Constructs a new String from the given :ref:`PoolByteArray`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolIntArray` from **)** Constructs a new String from the given :ref:`PoolIntArray`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolRealArray` from **)** Constructs a new String from the given :ref:`PoolRealArray`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolStringArray` from **)** Constructs a new String from the given :ref:`PoolStringArray`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector2Array` from **)** Constructs a new String from the given :ref:`PoolVector2Array`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolVector3Array` from **)** Constructs a new String from the given :ref:`PoolVector3Array`. - .. _class_String_String: +.. _class_String_String: - :ref:`String` **String** **(** :ref:`PoolColorArray` from **)** Constructs a new String from the given :ref:`PoolColorArray`. - .. _class_String_begins_with: +.. _class_String_begins_with: - :ref:`bool` **begins_with** **(** :ref:`String` text **)** Returns ``true`` if the string begins with the given string. - .. _class_String_bigrams: +.. _class_String_bigrams: - :ref:`PoolStringArray` **bigrams** **(** **)** Returns the bigrams (pairs of consecutive letters) of this string. - .. _class_String_c_escape: +.. _class_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: +.. _class_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: +.. _class_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: +.. _class_String_casecmp_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: +.. _class_String_dedent: - :ref:`String` **dedent** **(** **)** Removes indentation from string. - .. _class_String_empty: +.. _class_String_empty: - :ref:`bool` **empty** **(** **)** Returns ``true`` if the string is empty. - .. _class_String_ends_with: +.. _class_String_ends_with: - :ref:`bool` **ends_with** **(** :ref:`String` text **)** Returns ``true`` if the string ends with the given string. - .. _class_String_erase: +.. _class_String_erase: - void **erase** **(** :ref:`int` position, :ref:`int` chars **)** Erases ``chars`` characters from the string starting from ``position``. - .. _class_String_find: +.. _class_String_find: - :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: +.. _class_String_find_last: - :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: +.. _class_String_findn: - :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: +.. _class_String_format: - :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: +.. _class_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: +.. _class_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: +.. _class_String_get_extension: - :ref:`String` **get_extension** **(** **)** If the string is a valid file path, returns the extension. - .. _class_String_get_file: +.. _class_String_get_file: - :ref:`String` **get_file** **(** **)** If the string is a valid file path, returns the filename. - .. _class_String_hash: +.. _class_String_hash: - :ref:`int` **hash** **(** **)** Hashes the string and returns a 32-bit integer. - .. _class_String_hex_to_int: +.. _class_String_hex_to_int: - :ref:`int` **hex_to_int** **(** **)** Converts a string containing a hexadecimal number into an integer. - .. _class_String_insert: +.. _class_String_insert: - :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Inserts a substring at a given position. - .. _class_String_is_abs_path: +.. _class_String_is_abs_path: - :ref:`bool` **is_abs_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is absolute. - .. _class_String_is_rel_path: +.. _class_String_is_rel_path: - :ref:`bool` **is_rel_path** **(** **)** If the string is a path to a file or directory, returns ``true`` if the path is relative. - .. _class_String_is_subsequence_of: +.. _class_String_is_subsequence_of: - :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: +.. _class_String_is_subsequence_ofi: - :ref:`bool` **is_subsequence_ofi** **(** :ref:`String` text **)** Returns ``true`` if this string is a subsequence of the given string, without considering case. - .. _class_String_is_valid_float: +.. _class_String_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** Returns ``true`` if this string contains a valid float. - .. _class_String_is_valid_html_color: +.. _class_String_is_valid_html_color: - :ref:`bool` **is_valid_html_color** **(** **)** Returns ``true`` if this string contains a valid color in HTML notation. - .. _class_String_is_valid_identifier: +.. _class_String_is_valid_identifier: - :ref:`bool` **is_valid_identifier** **(** **)** Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (\_) and the first character may not be a digit. - .. _class_String_is_valid_integer: +.. _class_String_is_valid_integer: - :ref:`bool` **is_valid_integer** **(** **)** Returns ``true`` if this string contains a valid integer. - .. _class_String_is_valid_ip_address: +.. _class_String_is_valid_ip_address: - :ref:`bool` **is_valid_ip_address** **(** **)** Returns ``true`` if this string contains a valid IP address. - .. _class_String_json_escape: +.. _class_String_json_escape: - :ref:`String` **json_escape** **(** **)** Returns a copy of the string with special characters escaped using the JSON standard. - .. _class_String_left: +.. _class_String_left: - :ref:`String` **left** **(** :ref:`int` position **)** Returns a number of characters from the left of the string. - .. _class_String_length: +.. _class_String_length: - :ref:`int` **length** **(** **)** Returns the string's amount of characters. - .. _class_String_lstrip: +.. _class_String_lstrip: - :ref:`String` **lstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the left. - .. _class_String_match: +.. _class_String_match: - :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: +.. _class_String_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** Does a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). - .. _class_String_md5_buffer: +.. _class_String_md5_buffer: - :ref:`PoolByteArray` **md5_buffer** **(** **)** Returns the MD5 hash of the string as an array of bytes. - .. _class_String_md5_text: +.. _class_String_md5_text: - :ref:`String` **md5_text** **(** **)** Returns the MD5 hash of the string as a string. - .. _class_String_nocasecmp_to: +.. _class_String_nocasecmp_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. - .. _class_String_ord_at: +.. _class_String_ord_at: - :ref:`int` **ord_at** **(** :ref:`int` at **)** Returns the character code at position ``at``. - .. _class_String_pad_decimals: +.. _class_String_pad_decimals: - :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: +.. _class_String_pad_zeros: - :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: +.. _class_String_percent_decode: - :ref:`String` **percent_decode** **(** **)** Decode a percent-encoded string. See :ref:`percent_encode`. - .. _class_String_percent_encode: +.. _class_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: +.. _class_String_plus_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: +.. _class_String_replace: - :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** Replaces occurrences of a substring with the given one inside the string. - .. _class_String_replacen: +.. _class_String_replacen: - :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: +.. _class_String_rfind: - :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: +.. _class_String_rfindn: - :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: +.. _class_String_right: - :ref:`String` **right** **(** :ref:`int` position **)** Returns the right side of the string from a given position. - .. _class_String_rsplit: +.. _class_String_rsplit: - :ref:`PoolStringArray` **rsplit** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -667,29 +667,29 @@ Splits the string by a ``divisor`` string and returns an array of the substrings If ``maxsplit`` is specified, then it is number of splits to do, default is 0 which splits all the items. - .. _class_String_rstrip: +.. _class_String_rstrip: - :ref:`String` **rstrip** **(** :ref:`String` chars **)** Returns a copy of the string with characters removed from the right. - .. _class_String_sha256_buffer: +.. _class_String_sha256_buffer: - :ref:`PoolByteArray` **sha256_buffer** **(** **)** - .. _class_String_sha256_text: +.. _class_String_sha256_text: - :ref:`String` **sha256_text** **(** **)** Returns the SHA-256 hash of the string as a string. - .. _class_String_similarity: +.. _class_String_similarity: - :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: +.. _class_String_split: - :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True, :ref:`int` maxsplit=0 **)** @@ -699,7 +699,7 @@ Splits the string by a divisor string and returns an array of the substrings. If ``maxsplit`` is given, at most maxsplit number of splits occur, and the remainder of the string is returned as the final element of the list (thus, the list will have at most maxsplit+1 elements) - .. _class_String_split_floats: +.. _class_String_split_floats: - :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** @@ -707,73 +707,73 @@ Splits the string in floats by using a divisor string and returns an array of th **Example:** "1,2.5,3" will return 1,2.5,3 if split by ",". - .. _class_String_strip_edges: +.. _class_String_strip_edges: - :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: +.. _class_String_substr: - :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: +.. _class_String_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. - .. _class_String_to_float: +.. _class_String_to_float: - :ref:`float` **to_float** **(** **)** Converts a string containing a decimal number into a ``float``. - .. _class_String_to_int: +.. _class_String_to_int: - :ref:`int` **to_int** **(** **)** Converts a string containing an integer number into an ``int``. - .. _class_String_to_lower: +.. _class_String_to_lower: - :ref:`String` **to_lower** **(** **)** Returns the string converted to lowercase. - .. _class_String_to_upper: +.. _class_String_to_upper: - :ref:`String` **to_upper** **(** **)** Returns the string converted to uppercase. - .. _class_String_to_utf8: +.. _class_String_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(). - .. _class_String_trim_prefix: +.. _class_String_trim_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: +.. _class_String_trim_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: +.. _class_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: +.. _class_String_xml_unescape: - :ref:`String` **xml_unescape** **(** **)** diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 32d1d1c0f..5ca8577f2 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -56,7 +56,7 @@ StyleBox is :ref:`Resource` that provides an abstract base class Property Descriptions --------------------- - .. _class_StyleBox_content_margin_bottom: +.. _class_StyleBox_content_margin_bottom: - :ref:`float` **content_margin_bottom** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ - .. _class_StyleBox_content_margin_left: +.. _class_StyleBox_content_margin_left: - :ref:`float` **content_margin_left** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ - .. _class_StyleBox_content_margin_right: +.. _class_StyleBox_content_margin_right: - :ref:`float` **content_margin_right** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | get_default_margin() | +----------+---------------------------+ - .. _class_StyleBox_content_margin_top: +.. _class_StyleBox_content_margin_top: - :ref:`float` **content_margin_top** @@ -99,33 +99,33 @@ Property Descriptions Method Descriptions ------------------- - .. _class_StyleBox_draw: +.. _class_StyleBox_draw: - void **draw** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect **)** const - .. _class_StyleBox_get_center_size: +.. _class_StyleBox_get_center_size: - :ref:`Vector2` **get_center_size** **(** **)** const - .. _class_StyleBox_get_margin: +.. _class_StyleBox_get_margin: - :ref:`float` **get_margin** **(** :ref:`Margin` margin **)** const Return the offset of margin "margin" (see MARGIN\_\* enum). - .. _class_StyleBox_get_minimum_size: +.. _class_StyleBox_get_minimum_size: - :ref:`Vector2` **get_minimum_size** **(** **)** const Return the minimum size that this stylebox can be shrunk to. - .. _class_StyleBox_get_offset: +.. _class_StyleBox_get_offset: - :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: +.. _class_StyleBox_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** const diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index ac0f6d28b..100998313 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -113,7 +113,7 @@ The relative system now would take the 1:2 ratio of the two left corners to calc Property Descriptions --------------------- - .. _class_StyleBoxFlat_anti_aliasing: +.. _class_StyleBoxFlat_anti_aliasing: - :ref:`bool` **anti_aliasing** @@ -125,7 +125,7 @@ Property Descriptions Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. - .. _class_StyleBoxFlat_anti_aliasing_size: +.. _class_StyleBoxFlat_anti_aliasing_size: - :ref:`int` **anti_aliasing_size** @@ -137,7 +137,7 @@ Anti Aliasing draws a small ring around edges. This ring fades to transparent. A This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. - .. _class_StyleBoxFlat_bg_color: +.. _class_StyleBoxFlat_bg_color: - :ref:`Color` **bg_color** @@ -149,7 +149,7 @@ This changes the size of the faded ring. Higher values can be used to achieve a The background color of the stylebox. - .. _class_StyleBoxFlat_border_blend: +.. _class_StyleBoxFlat_border_blend: - :ref:`bool` **border_blend** @@ -161,7 +161,7 @@ The background color of the stylebox. When set to true, the border will fade into the background color. - .. _class_StyleBoxFlat_border_color: +.. _class_StyleBoxFlat_border_color: - :ref:`Color` **border_color** @@ -173,7 +173,7 @@ When set to true, the border will fade into the background color. Sets the color of the border. - .. _class_StyleBoxFlat_border_width_bottom: +.. _class_StyleBoxFlat_border_width_bottom: - :ref:`int` **border_width_bottom** @@ -185,7 +185,7 @@ Sets the color of the border. Border width for the bottom border. - .. _class_StyleBoxFlat_border_width_left: +.. _class_StyleBoxFlat_border_width_left: - :ref:`int` **border_width_left** @@ -197,7 +197,7 @@ Border width for the bottom border. Border width for the left border. - .. _class_StyleBoxFlat_border_width_right: +.. _class_StyleBoxFlat_border_width_right: - :ref:`int` **border_width_right** @@ -209,7 +209,7 @@ Border width for the left border. Border width for the right border. - .. _class_StyleBoxFlat_border_width_top: +.. _class_StyleBoxFlat_border_width_top: - :ref:`int` **border_width_top** @@ -221,7 +221,7 @@ Border width for the right border. Border width for the top border. - .. _class_StyleBoxFlat_corner_detail: +.. _class_StyleBoxFlat_corner_detail: - :ref:`int` **corner_detail** @@ -237,7 +237,7 @@ For corner radius smaller than 10: 4-5 should be enough For corner radius smaller than 30: 8-12 should be enough ... - .. _class_StyleBoxFlat_corner_radius_bottom_left: +.. _class_StyleBoxFlat_corner_radius_bottom_left: - :ref:`int` **corner_radius_bottom_left** @@ -249,7 +249,7 @@ For corner radius smaller than 30: 8-12 should be enough ... The corner radius of the bottom left corner. When set to 0 the corner is not rounded. - .. _class_StyleBoxFlat_corner_radius_bottom_right: +.. _class_StyleBoxFlat_corner_radius_bottom_right: - :ref:`int` **corner_radius_bottom_right** @@ -261,7 +261,7 @@ The corner radius of the bottom left corner. When set to 0 the corner is not rou The corner radius of the bottom right corner. When set to 0 the corner is not rounded. - .. _class_StyleBoxFlat_corner_radius_top_left: +.. _class_StyleBoxFlat_corner_radius_top_left: - :ref:`int` **corner_radius_top_left** @@ -273,7 +273,7 @@ The corner radius of the bottom right corner. When set to 0 the corner is not ro The corner radius of the top left corner. When set to 0 the corner is not rounded. - .. _class_StyleBoxFlat_corner_radius_top_right: +.. _class_StyleBoxFlat_corner_radius_top_right: - :ref:`int` **corner_radius_top_right** @@ -285,7 +285,7 @@ The corner radius of the top left corner. When set to 0 the corner is not rounde The corner radius of the top right corner. When set to 0 the corner is not rounded. - .. _class_StyleBoxFlat_draw_center: +.. _class_StyleBoxFlat_draw_center: - :ref:`bool` **draw_center** @@ -297,7 +297,7 @@ The corner radius of the top right corner. When set to 0 the corner is not round Toggels drawing of the inner part of the stylebox. - .. _class_StyleBoxFlat_expand_margin_bottom: +.. _class_StyleBoxFlat_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -309,7 +309,7 @@ Toggels drawing of the inner part of the stylebox. Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. - .. _class_StyleBoxFlat_expand_margin_left: +.. _class_StyleBoxFlat_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -321,7 +321,7 @@ Expands the stylebox outside of the control rect on the bottom edge. Useful in c Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. - .. _class_StyleBoxFlat_expand_margin_right: +.. _class_StyleBoxFlat_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -333,7 +333,7 @@ Expands the stylebox outside of the control rect on the left edge. Useful in com Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. - .. _class_StyleBoxFlat_expand_margin_top: +.. _class_StyleBoxFlat_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -345,7 +345,7 @@ Expands the stylebox outside of the control rect on the right edge. Useful in co Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. - .. _class_StyleBoxFlat_shadow_color: +.. _class_StyleBoxFlat_shadow_color: - :ref:`Color` **shadow_color** @@ -357,7 +357,7 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb The color of the shadow. (This has no effect when shadow_size < 1) - .. _class_StyleBoxFlat_shadow_size: +.. _class_StyleBoxFlat_shadow_size: - :ref:`int` **shadow_size** @@ -372,27 +372,27 @@ The shadow size in pixels. Method Descriptions ------------------- - .. _class_StyleBoxFlat_get_border_width_min: +.. _class_StyleBoxFlat_get_border_width_min: - :ref:`int` **get_border_width_min** **(** **)** const - .. _class_StyleBoxFlat_set_border_width_all: +.. _class_StyleBoxFlat_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** - .. _class_StyleBoxFlat_set_corner_radius_all: +.. _class_StyleBoxFlat_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** - .. _class_StyleBoxFlat_set_corner_radius_individual: +.. _class_StyleBoxFlat_set_corner_radius_individual: - void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** - .. _class_StyleBoxFlat_set_expand_margin_all: +.. _class_StyleBoxFlat_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** - .. _class_StyleBoxFlat_set_expand_margin_individual: +.. _class_StyleBoxFlat_set_expand_margin_individual: - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** diff --git a/classes/class_styleboxline.rst b/classes/class_styleboxline.rst index 19fb3800b..e23a221ad 100644 --- a/classes/class_styleboxline.rst +++ b/classes/class_styleboxline.rst @@ -34,7 +34,7 @@ Properties Property Descriptions --------------------- - .. _class_StyleBoxLine_color: +.. _class_StyleBoxLine_color: - :ref:`Color` **color** @@ -44,7 +44,7 @@ Property Descriptions | *Getter* | get_color() | +----------+------------------+ - .. _class_StyleBoxLine_grow_begin: +.. _class_StyleBoxLine_grow_begin: - :ref:`float` **grow_begin** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | get_grow_begin() | +----------+-----------------------+ - .. _class_StyleBoxLine_grow_end: +.. _class_StyleBoxLine_grow_end: - :ref:`float` **grow_end** @@ -64,7 +64,7 @@ Property Descriptions | *Getter* | get_grow_end() | +----------+---------------------+ - .. _class_StyleBoxLine_thickness: +.. _class_StyleBoxLine_thickness: - :ref:`int` **thickness** @@ -74,7 +74,7 @@ Property Descriptions | *Getter* | get_thickness() | +----------+----------------------+ - .. _class_StyleBoxLine_vertical: +.. _class_StyleBoxLine_vertical: - :ref:`bool` **vertical** diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 8726cfb5b..9917335b0 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -63,14 +63,14 @@ Methods Signals ------- - .. _class_StyleBoxTexture_texture_changed: +.. _class_StyleBoxTexture_texture_changed: - **texture_changed** **(** **)** Enumerations ------------ - .. _enum_StyleBoxTexture_AxisStretchMode: +.. _enum_StyleBoxTexture_AxisStretchMode: enum **AxisStretchMode**: @@ -86,7 +86,7 @@ Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture Property Descriptions --------------------- - .. _class_StyleBoxTexture_axis_stretch_horizontal: +.. _class_StyleBoxTexture_axis_stretch_horizontal: - :ref:`AxisStretchMode` **axis_stretch_horizontal** @@ -96,7 +96,7 @@ Property Descriptions | *Getter* | get_h_axis_stretch_mode() | +----------+--------------------------------+ - .. _class_StyleBoxTexture_axis_stretch_vertical: +.. _class_StyleBoxTexture_axis_stretch_vertical: - :ref:`AxisStretchMode` **axis_stretch_vertical** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | get_v_axis_stretch_mode() | +----------+--------------------------------+ - .. _class_StyleBoxTexture_draw_center: +.. _class_StyleBoxTexture_draw_center: - :ref:`bool` **draw_center** @@ -116,7 +116,7 @@ Property Descriptions | *Getter* | is_draw_center_enabled() | +----------+--------------------------+ - .. _class_StyleBoxTexture_expand_margin_bottom: +.. _class_StyleBoxTexture_expand_margin_bottom: - :ref:`float` **expand_margin_bottom** @@ -126,7 +126,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ - .. _class_StyleBoxTexture_expand_margin_left: +.. _class_StyleBoxTexture_expand_margin_left: - :ref:`float` **expand_margin_left** @@ -136,7 +136,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ - .. _class_StyleBoxTexture_expand_margin_right: +.. _class_StyleBoxTexture_expand_margin_right: - :ref:`float` **expand_margin_right** @@ -146,7 +146,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ - .. _class_StyleBoxTexture_expand_margin_top: +.. _class_StyleBoxTexture_expand_margin_top: - :ref:`float` **expand_margin_top** @@ -156,7 +156,7 @@ Property Descriptions | *Getter* | get_expand_margin_size() | +----------+-------------------------------+ - .. _class_StyleBoxTexture_margin_bottom: +.. _class_StyleBoxTexture_margin_bottom: - :ref:`float` **margin_bottom** @@ -166,7 +166,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ - .. _class_StyleBoxTexture_margin_left: +.. _class_StyleBoxTexture_margin_left: - :ref:`float` **margin_left** @@ -176,7 +176,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ - .. _class_StyleBoxTexture_margin_right: +.. _class_StyleBoxTexture_margin_right: - :ref:`float` **margin_right** @@ -186,7 +186,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ - .. _class_StyleBoxTexture_margin_top: +.. _class_StyleBoxTexture_margin_top: - :ref:`float` **margin_top** @@ -196,7 +196,7 @@ Property Descriptions | *Getter* | get_margin_size() | +----------+------------------------+ - .. _class_StyleBoxTexture_modulate_color: +.. _class_StyleBoxTexture_modulate_color: - :ref:`Color` **modulate_color** @@ -206,7 +206,7 @@ Property Descriptions | *Getter* | get_modulate() | +----------+---------------------+ - .. _class_StyleBoxTexture_normal_map: +.. _class_StyleBoxTexture_normal_map: - :ref:`Texture` **normal_map** @@ -216,7 +216,7 @@ Property Descriptions | *Getter* | get_normal_map() | +----------+-----------------------+ - .. _class_StyleBoxTexture_region_rect: +.. _class_StyleBoxTexture_region_rect: - :ref:`Rect2` **region_rect** @@ -226,7 +226,7 @@ Property Descriptions | *Getter* | get_region_rect() | +----------+------------------------+ - .. _class_StyleBoxTexture_texture: +.. _class_StyleBoxTexture_texture: - :ref:`Texture` **texture** @@ -239,11 +239,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_StyleBoxTexture_set_expand_margin_all: +.. _class_StyleBoxTexture_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** - .. _class_StyleBoxTexture_set_expand_margin_individual: +.. _class_StyleBoxTexture_set_expand_margin_individual: - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 336017cee..fd060ca16 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -85,109 +85,109 @@ It is very important that vertex attributes are passed **before** the call to :r Method Descriptions ------------------- - .. _class_SurfaceTool_add_bones: +.. _class_SurfaceTool_add_bones: - void **add_bones** **(** :ref:`PoolIntArray` bones **)** Add an array of bones for the next Vertex to use. - .. _class_SurfaceTool_add_color: +.. _class_SurfaceTool_add_color: - void **add_color** **(** :ref:`Color` color **)** Specify a :ref:`Color` for the next Vertex to use. - .. _class_SurfaceTool_add_index: +.. _class_SurfaceTool_add_index: - void **add_index** **(** :ref:`int` index **)** Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. - .. _class_SurfaceTool_add_normal: +.. _class_SurfaceTool_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** Specify a normal for the next Vertex to use. - .. _class_SurfaceTool_add_smooth_group: +.. _class_SurfaceTool_add_smooth_group: - void **add_smooth_group** **(** :ref:`bool` smooth **)** Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. - .. _class_SurfaceTool_add_tangent: +.. _class_SurfaceTool_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** Specify a Tangent for the next Vertex to use. - .. _class_SurfaceTool_add_to_format: +.. _class_SurfaceTool_add_to_format: - void **add_to_format** **(** :ref:`int` flags **)** - .. _class_SurfaceTool_add_triangle_fan: +.. _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=[ ] **)** Insert a triangle fan made of array data into :ref:`Mesh` being constructed. - .. _class_SurfaceTool_add_uv: +.. _class_SurfaceTool_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** Specify UV Coordinate for next Vertex to use. - .. _class_SurfaceTool_add_uv2: +.. _class_SurfaceTool_add_uv2: - void **add_uv2** **(** :ref:`Vector2` uv2 **)** Specify an optional second set of UV coordinates for next Vertex to use. - .. _class_SurfaceTool_add_vertex: +.. _class_SurfaceTool_add_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: +.. _class_SurfaceTool_add_weights: - void **add_weights** **(** :ref:`PoolRealArray` weights **)** Specify weight value for next Vertex to use. - .. _class_SurfaceTool_append_from: +.. _class_SurfaceTool_append_from: - void **append_from** **(** :ref:`Mesh` existing, :ref:`int` surface, :ref:`Transform` transform **)** - .. _class_SurfaceTool_begin: +.. _class_SurfaceTool_begin: - void **begin** **(** :ref:`PrimitiveType` primitive **)** Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). - .. _class_SurfaceTool_clear: +.. _class_SurfaceTool_clear: - void **clear** **(** **)** Clear all information passed into the surface tool so far. - .. _class_SurfaceTool_commit: +.. _class_SurfaceTool_commit: - :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`. - .. _class_SurfaceTool_create_from: +.. _class_SurfaceTool_create_from: - void **create_from** **(** :ref:`Mesh` existing, :ref:`int` surface **)** - .. _class_SurfaceTool_deindex: +.. _class_SurfaceTool_deindex: - void **deindex** **(** **)** Removes index array by expanding Vertex array. - .. _class_SurfaceTool_generate_normals: +.. _class_SurfaceTool_generate_normals: - void **generate_normals** **(** :ref:`bool` flip=false **)** @@ -195,17 +195,17 @@ Generates normals from Vertices so you do not have to do it manually. Setting "flip" ``true`` inverts resulting normals. - .. _class_SurfaceTool_generate_tangents: +.. _class_SurfaceTool_generate_tangents: - void **generate_tangents** **(** **)** - .. _class_SurfaceTool_index: +.. _class_SurfaceTool_index: - void **index** **(** **)** Shrinks Vertex array by creating an index array. Avoids reusing Vertices. - .. _class_SurfaceTool_set_material: +.. _class_SurfaceTool_set_material: - void **set_material** **(** :ref:`Material` material **)** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 520df957c..c7026fa63 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -106,19 +106,19 @@ Theme Properties Signals ------- - .. _class_TabContainer_pre_popup_pressed: +.. _class_TabContainer_pre_popup_pressed: - **pre_popup_pressed** **(** **)** Emitted when the ``TabContainer``'s :ref:`Popup` button is clicked. See :ref:`set_popup` for details. - .. _class_TabContainer_tab_changed: +.. _class_TabContainer_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** Emitted when switching to another tab. - .. _class_TabContainer_tab_selected: +.. _class_TabContainer_tab_selected: - **tab_selected** **(** :ref:`int` tab **)** @@ -127,7 +127,7 @@ Emitted when a tab is selected, even if it is the current tab. Enumerations ------------ - .. _enum_TabContainer_TabAlign: +.. _enum_TabContainer_TabAlign: enum **TabAlign**: @@ -149,7 +149,7 @@ To hide only a tab's content, nest the content inside a child :ref:`Control` **current_tab** @@ -161,7 +161,7 @@ Property Descriptions 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: +.. _class_TabContainer_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -171,7 +171,7 @@ The current tab index. When set, this index's :ref:`Control` node | *Getter* | get_drag_to_rearrange_enabled() | +----------+--------------------------------------+ - .. _class_TabContainer_tab_align: +.. _class_TabContainer_tab_align: - :ref:`TabAlign` **tab_align** @@ -183,7 +183,7 @@ The current tab index. When set, this index's :ref:`Control` node The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants for details. - .. _class_TabContainer_tabs_visible: +.. _class_TabContainer_tabs_visible: - :ref:`bool` **tabs_visible** @@ -198,83 +198,83 @@ If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Method Descriptions ------------------- - .. _class_TabContainer_get_current_tab_control: +.. _class_TabContainer_get_current_tab_control: - :ref:`Control` **get_current_tab_control** **(** **)** const Returns the child :ref:`Control` node located at the active tab index. - .. _class_TabContainer_get_popup: +.. _class_TabContainer_get_popup: - :ref:`Popup` **get_popup** **(** **)** const Returns the :ref:`Popup` node instance if one has been set already with :ref:`set_popup`. - .. _class_TabContainer_get_previous_tab: +.. _class_TabContainer_get_previous_tab: - :ref:`int` **get_previous_tab** **(** **)** const Returns the previously active tab index. - .. _class_TabContainer_get_tab_control: +.. _class_TabContainer_get_tab_control: - :ref:`Control` **get_tab_control** **(** :ref:`int` idx **)** const Returns the currently visible tab's :ref:`Control` node. - .. _class_TabContainer_get_tab_count: +.. _class_TabContainer_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const Returns the number of tabs. - .. _class_TabContainer_get_tab_disabled: +.. _class_TabContainer_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const Returns ``true`` if the tab at index ``tab_idx`` is disabled. - .. _class_TabContainer_get_tab_icon: +.. _class_TabContainer_get_tab_icon: - :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`. - .. _class_TabContainer_get_tab_title: +.. _class_TabContainer_get_tab_title: - :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`. - .. _class_TabContainer_get_tabs_rearrange_group: +.. _class_TabContainer_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const - .. _class_TabContainer_set_popup: +.. _class_TabContainer_set_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. - .. _class_TabContainer_set_tab_disabled: +.. _class_TabContainer_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. - .. _class_TabContainer_set_tab_icon: +.. _class_TabContainer_set_tab_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: +.. _class_TabContainer_set_tab_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`. - .. _class_TabContainer_set_tabs_rearrange_group: +.. _class_TabContainer_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 1e6476334..325e3a386 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -116,34 +116,34 @@ Theme Properties Signals ------- - .. _class_Tabs_reposition_active_tab_request: +.. _class_Tabs_reposition_active_tab_request: - **reposition_active_tab_request** **(** :ref:`int` idx_to **)** - .. _class_Tabs_right_button_pressed: +.. _class_Tabs_right_button_pressed: - **right_button_pressed** **(** :ref:`int` tab **)** - .. _class_Tabs_tab_changed: +.. _class_Tabs_tab_changed: - **tab_changed** **(** :ref:`int` tab **)** - .. _class_Tabs_tab_clicked: +.. _class_Tabs_tab_clicked: - **tab_clicked** **(** :ref:`int` tab **)** - .. _class_Tabs_tab_close: +.. _class_Tabs_tab_close: - **tab_close** **(** :ref:`int` tab **)** - .. _class_Tabs_tab_hover: +.. _class_Tabs_tab_hover: - **tab_hover** **(** :ref:`int` tab **)** Enumerations ------------ - .. _enum_Tabs_CloseButtonDisplayPolicy: +.. _enum_Tabs_CloseButtonDisplayPolicy: enum **CloseButtonDisplayPolicy**: @@ -152,7 +152,7 @@ enum **CloseButtonDisplayPolicy**: - **CLOSE_BUTTON_SHOW_ALWAYS** = **2** - **CLOSE_BUTTON_MAX** = **3** - .. _enum_Tabs_TabAlign: +.. _enum_Tabs_TabAlign: enum **TabAlign**: @@ -169,7 +169,7 @@ Simple tabs control, similar to :ref:`TabContainer` but is o Property Descriptions --------------------- - .. _class_Tabs_current_tab: +.. _class_Tabs_current_tab: - :ref:`int` **current_tab** @@ -179,7 +179,7 @@ Property Descriptions | *Getter* | get_current_tab() | +----------+------------------------+ - .. _class_Tabs_drag_to_rearrange_enabled: +.. _class_Tabs_drag_to_rearrange_enabled: - :ref:`bool` **drag_to_rearrange_enabled** @@ -189,7 +189,7 @@ Property Descriptions | *Getter* | get_drag_to_rearrange_enabled() | +----------+--------------------------------------+ - .. _class_Tabs_scrolling_enabled: +.. _class_Tabs_scrolling_enabled: - :ref:`bool` **scrolling_enabled** @@ -199,7 +199,7 @@ Property Descriptions | *Getter* | get_scrolling_enabled() | +----------+------------------------------+ - .. _class_Tabs_tab_align: +.. _class_Tabs_tab_align: - :ref:`TabAlign` **tab_align** @@ -209,7 +209,7 @@ Property Descriptions | *Getter* | get_tab_align() | +----------+----------------------+ - .. _class_Tabs_tab_close_display_policy: +.. _class_Tabs_tab_close_display_policy: - :ref:`CloseButtonDisplayPolicy` **tab_close_display_policy** @@ -222,79 +222,79 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Tabs_add_tab: +.. _class_Tabs_add_tab: - void **add_tab** **(** :ref:`String` title="", :ref:`Texture` icon=null **)** - .. _class_Tabs_ensure_tab_visible: +.. _class_Tabs_ensure_tab_visible: - void **ensure_tab_visible** **(** :ref:`int` idx **)** - .. _class_Tabs_get_offset_buttons_visible: +.. _class_Tabs_get_offset_buttons_visible: - :ref:`bool` **get_offset_buttons_visible** **(** **)** const - .. _class_Tabs_get_select_with_rmb: +.. _class_Tabs_get_select_with_rmb: - :ref:`bool` **get_select_with_rmb** **(** **)** const - .. _class_Tabs_get_tab_count: +.. _class_Tabs_get_tab_count: - :ref:`int` **get_tab_count** **(** **)** const - .. _class_Tabs_get_tab_disabled: +.. _class_Tabs_get_tab_disabled: - :ref:`bool` **get_tab_disabled** **(** :ref:`int` tab_idx **)** const - .. _class_Tabs_get_tab_icon: +.. _class_Tabs_get_tab_icon: - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const - .. _class_Tabs_get_tab_offset: +.. _class_Tabs_get_tab_offset: - :ref:`int` **get_tab_offset** **(** **)** const - .. _class_Tabs_get_tab_rect: +.. _class_Tabs_get_tab_rect: - :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** const Returns tab :ref:`Rect2` with local position and size. - .. _class_Tabs_get_tab_title: +.. _class_Tabs_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const - .. _class_Tabs_get_tabs_rearrange_group: +.. _class_Tabs_get_tabs_rearrange_group: - :ref:`int` **get_tabs_rearrange_group** **(** **)** const - .. _class_Tabs_move_tab: +.. _class_Tabs_move_tab: - void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** Rearrange tab. - .. _class_Tabs_remove_tab: +.. _class_Tabs_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** - .. _class_Tabs_set_select_with_rmb: +.. _class_Tabs_set_select_with_rmb: - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** - .. _class_Tabs_set_tab_disabled: +.. _class_Tabs_set_tab_disabled: - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** - .. _class_Tabs_set_tab_icon: +.. _class_Tabs_set_tab_icon: - void **set_tab_icon** **(** :ref:`int` tab_idx, :ref:`Texture` icon **)** - .. _class_Tabs_set_tab_title: +.. _class_Tabs_set_tab_title: - void **set_tab_title** **(** :ref:`int` tab_idx, :ref:`String` title **)** - .. _class_Tabs_set_tabs_rearrange_group: +.. _class_Tabs_set_tabs_rearrange_group: - void **set_tabs_rearrange_group** **(** :ref:`int` group_id **)** diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 3f76bdeae..23482e8ec 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -37,13 +37,13 @@ TCP Server class. Listens to connections on a port and returns a :ref:`StreamPee Method Descriptions ------------------- - .. _class_TCP_Server_is_connection_available: +.. _class_TCP_Server_is_connection_available: - :ref:`bool` **is_connection_available** **(** **)** const Return true if a connection is available for taking. - .. _class_TCP_Server_listen: +.. _class_TCP_Server_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`String` bind_address="*" **)** @@ -55,13 +55,13 @@ If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). - .. _class_TCP_Server_stop: +.. _class_TCP_Server_stop: - void **stop** **(** **)** Stop listening. - .. _class_TCP_Server_take_connection: +.. _class_TCP_Server_take_connection: - :ref:`StreamPeerTCP` **take_connection** **(** **)** diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 1edb96394..48528e1cb 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -218,27 +218,27 @@ Theme Properties Signals ------- - .. _class_TextEdit_breakpoint_toggled: +.. _class_TextEdit_breakpoint_toggled: - **breakpoint_toggled** **(** :ref:`int` row **)** Emitted when a breakpoint is placed via the breakpoint gutter. - .. _class_TextEdit_cursor_changed: +.. _class_TextEdit_cursor_changed: - **cursor_changed** **(** **)** Emitted when the cursor changes. - .. _class_TextEdit_request_completion: +.. _class_TextEdit_request_completion: - **request_completion** **(** **)** - .. _class_TextEdit_symbol_lookup: +.. _class_TextEdit_symbol_lookup: - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** - .. _class_TextEdit_text_changed: +.. _class_TextEdit_text_changed: - **text_changed** **(** **)** @@ -247,7 +247,7 @@ Emitted when the text changes. Enumerations ------------ - .. _enum_TextEdit_MenuItems: +.. _enum_TextEdit_MenuItems: enum **MenuItems**: @@ -259,7 +259,7 @@ enum **MenuItems**: - **MENU_UNDO** = **5** --- Undoes the previous action. - **MENU_MAX** = **6** - .. _enum_TextEdit_SearchFlags: +.. _enum_TextEdit_SearchFlags: enum **SearchFlags**: @@ -275,7 +275,7 @@ TextEdit is meant for editing large, multiline text. It also has facilities for Property Descriptions --------------------- - .. _class_TextEdit_breakpoint_gutter: +.. _class_TextEdit_breakpoint_gutter: - :ref:`bool` **breakpoint_gutter** @@ -287,7 +287,7 @@ Property Descriptions If ``true`` the breakpoint gutter is visible. - .. _class_TextEdit_caret_blink: +.. _class_TextEdit_caret_blink: - :ref:`bool` **caret_blink** @@ -299,7 +299,7 @@ If ``true`` the breakpoint gutter is visible. If ``true`` the caret (visual cursor) blinks. - .. _class_TextEdit_caret_blink_speed: +.. _class_TextEdit_caret_blink_speed: - :ref:`float` **caret_blink_speed** @@ -311,7 +311,7 @@ If ``true`` the caret (visual cursor) blinks. Duration (in seconds) of a caret's blinking cycle. - .. _class_TextEdit_caret_block_mode: +.. _class_TextEdit_caret_block_mode: - :ref:`bool` **caret_block_mode** @@ -325,7 +325,7 @@ If ``true`` the caret displays as a rectangle. If ``false`` the caret displays as a bar. - .. _class_TextEdit_caret_moving_by_right_click: +.. _class_TextEdit_caret_moving_by_right_click: - :ref:`bool` **caret_moving_by_right_click** @@ -339,7 +339,7 @@ If ``true`` a right click moves the cursor at the mouse position before displayi If ``false`` the context menu disregards mouse location. - .. _class_TextEdit_context_menu_enabled: +.. _class_TextEdit_context_menu_enabled: - :ref:`bool` **context_menu_enabled** @@ -351,7 +351,7 @@ If ``false`` the context menu disregards mouse location. If ``true`` a right click displays the context menu. - .. _class_TextEdit_hiding_enabled: +.. _class_TextEdit_hiding_enabled: - :ref:`int` **hiding_enabled** @@ -361,7 +361,7 @@ If ``true`` a right click displays the context menu. | *Getter* | is_hiding_enabled() | +----------+---------------------------+ - .. _class_TextEdit_highlight_all_occurrences: +.. _class_TextEdit_highlight_all_occurrences: - :ref:`bool` **highlight_all_occurrences** @@ -371,7 +371,7 @@ If ``true`` a right click displays the context menu. | *Getter* | is_highlight_all_occurrences_enabled() | +----------+----------------------------------------+ - .. _class_TextEdit_highlight_current_line: +.. _class_TextEdit_highlight_current_line: - :ref:`bool` **highlight_current_line** @@ -383,7 +383,7 @@ If ``true`` a right click displays the context menu. If ``true`` the line containing the cursor is highlighted. - .. _class_TextEdit_override_selected_font_color: +.. _class_TextEdit_override_selected_font_color: - :ref:`bool` **override_selected_font_color** @@ -393,7 +393,7 @@ If ``true`` the line containing the cursor is highlighted. | *Getter* | is_overriding_selected_font_color() | +----------+-----------------------------------------+ - .. _class_TextEdit_readonly: +.. _class_TextEdit_readonly: - :ref:`bool` **readonly** @@ -405,7 +405,7 @@ If ``true`` the line containing the cursor is highlighted. If ``true`` read-only mode is enabled. Existing text cannot be modified and new text cannot be added. - .. _class_TextEdit_show_line_numbers: +.. _class_TextEdit_show_line_numbers: - :ref:`bool` **show_line_numbers** @@ -417,7 +417,7 @@ If ``true`` read-only mode is enabled. Existing text cannot be modified and new If ``true`` line numbers are displayed to the left of the text. - .. _class_TextEdit_smooth_scrolling: +.. _class_TextEdit_smooth_scrolling: - :ref:`bool` **smooth_scrolling** @@ -427,7 +427,7 @@ If ``true`` line numbers are displayed to the left of the text. | *Getter* | is_smooth_scroll_enabled() | +----------+---------------------------------+ - .. _class_TextEdit_syntax_highlighting: +.. _class_TextEdit_syntax_highlighting: - :ref:`bool` **syntax_highlighting** @@ -437,7 +437,7 @@ If ``true`` line numbers are displayed to the left of the text. | *Getter* | is_syntax_coloring_enabled() | +----------+------------------------------+ - .. _class_TextEdit_text: +.. _class_TextEdit_text: - :ref:`String` **text** @@ -449,7 +449,7 @@ If ``true`` line numbers are displayed to the left of the text. String value of the :ref:`TextEdit`. - .. _class_TextEdit_v_scroll_speed: +.. _class_TextEdit_v_scroll_speed: - :ref:`float` **v_scroll_speed** @@ -461,7 +461,7 @@ String value of the :ref:`TextEdit`. If ``true``, enables text wrapping when it goes beyond he edge of what is visible. - .. _class_TextEdit_wrap_enabled: +.. _class_TextEdit_wrap_enabled: - :ref:`bool` **wrap_enabled** @@ -474,225 +474,225 @@ If ``true``, enables text wrapping when it goes beyond he edge of what is visibl Method Descriptions ------------------- - .. _class_TextEdit_add_color_region: +.. _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 **)** Add color region (given the delimiters) and its colors. - .. _class_TextEdit_add_keyword_color: +.. _class_TextEdit_add_keyword_color: - void **add_keyword_color** **(** :ref:`String` keyword, :ref:`Color` color **)** Add a keyword and its color. - .. _class_TextEdit_can_fold: +.. _class_TextEdit_can_fold: - :ref:`bool` **can_fold** **(** :ref:`int` line **)** const - .. _class_TextEdit_clear_colors: +.. _class_TextEdit_clear_colors: - void **clear_colors** **(** **)** Clear all the syntax coloring information. - .. _class_TextEdit_clear_undo_history: +.. _class_TextEdit_clear_undo_history: - void **clear_undo_history** **(** **)** Clear the undo history. - .. _class_TextEdit_copy: +.. _class_TextEdit_copy: - void **copy** **(** **)** Copy the current selection. - .. _class_TextEdit_cursor_get_column: +.. _class_TextEdit_cursor_get_column: - :ref:`int` **cursor_get_column** **(** **)** const Return the column the editing cursor is at. - .. _class_TextEdit_cursor_get_line: +.. _class_TextEdit_cursor_get_line: - :ref:`int` **cursor_get_line** **(** **)** const Return the line the editing cursor is at. - .. _class_TextEdit_cursor_set_column: +.. _class_TextEdit_cursor_set_column: - void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** - .. _class_TextEdit_cursor_set_line: +.. _class_TextEdit_cursor_set_line: - void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true, :ref:`bool` can_be_hidden=true, :ref:`int` wrap_index=0 **)** - .. _class_TextEdit_cut: +.. _class_TextEdit_cut: - void **cut** **(** **)** Cut the current selection. - .. _class_TextEdit_deselect: +.. _class_TextEdit_deselect: - void **deselect** **(** **)** Clears the current selection. - .. _class_TextEdit_fold_all_lines: +.. _class_TextEdit_fold_all_lines: - void **fold_all_lines** **(** **)** - .. _class_TextEdit_fold_line: +.. _class_TextEdit_fold_line: - void **fold_line** **(** :ref:`int` line **)** - .. _class_TextEdit_get_breakpoints: +.. _class_TextEdit_get_breakpoints: - :ref:`Array` **get_breakpoints** **(** **)** const Return an array containing the line number of each breakpoint. - .. _class_TextEdit_get_keyword_color: +.. _class_TextEdit_get_keyword_color: - :ref:`Color` **get_keyword_color** **(** :ref:`String` keyword **)** const - .. _class_TextEdit_get_line: +.. _class_TextEdit_get_line: - :ref:`String` **get_line** **(** :ref:`int` line **)** const Return the text of a specific line. - .. _class_TextEdit_get_line_count: +.. _class_TextEdit_get_line_count: - :ref:`int` **get_line_count** **(** **)** const Return the amount of total lines in the text. - .. _class_TextEdit_get_menu: +.. _class_TextEdit_get_menu: - :ref:`PopupMenu` **get_menu** **(** **)** const - .. _class_TextEdit_get_selection_from_column: +.. _class_TextEdit_get_selection_from_column: - :ref:`int` **get_selection_from_column** **(** **)** const Return the selection begin column. - .. _class_TextEdit_get_selection_from_line: +.. _class_TextEdit_get_selection_from_line: - :ref:`int` **get_selection_from_line** **(** **)** const Return the selection begin line. - .. _class_TextEdit_get_selection_text: +.. _class_TextEdit_get_selection_text: - :ref:`String` **get_selection_text** **(** **)** const Return the text inside the selection. - .. _class_TextEdit_get_selection_to_column: +.. _class_TextEdit_get_selection_to_column: - :ref:`int` **get_selection_to_column** **(** **)** const Return the selection end column. - .. _class_TextEdit_get_selection_to_line: +.. _class_TextEdit_get_selection_to_line: - :ref:`int` **get_selection_to_line** **(** **)** const Return the selection end line. - .. _class_TextEdit_get_word_under_cursor: +.. _class_TextEdit_get_word_under_cursor: - :ref:`String` **get_word_under_cursor** **(** **)** const - .. _class_TextEdit_has_keyword_color: +.. _class_TextEdit_has_keyword_color: - :ref:`bool` **has_keyword_color** **(** :ref:`String` keyword **)** const - .. _class_TextEdit_insert_text_at_cursor: +.. _class_TextEdit_insert_text_at_cursor: - void **insert_text_at_cursor** **(** :ref:`String` text **)** Insert a given text at the cursor position. - .. _class_TextEdit_is_folded: +.. _class_TextEdit_is_folded: - :ref:`bool` **is_folded** **(** :ref:`int` line **)** const - .. _class_TextEdit_is_line_hidden: +.. _class_TextEdit_is_line_hidden: - :ref:`bool` **is_line_hidden** **(** :ref:`int` line **)** const - .. _class_TextEdit_is_selection_active: +.. _class_TextEdit_is_selection_active: - :ref:`bool` **is_selection_active** **(** **)** const Return true if the selection is active. - .. _class_TextEdit_menu_option: +.. _class_TextEdit_menu_option: - void **menu_option** **(** :ref:`int` option **)** - .. _class_TextEdit_paste: +.. _class_TextEdit_paste: - void **paste** **(** **)** Paste the current selection. - .. _class_TextEdit_redo: +.. _class_TextEdit_redo: - void **redo** **(** **)** Perform redo operation. - .. _class_TextEdit_remove_breakpoints: +.. _class_TextEdit_remove_breakpoints: - void **remove_breakpoints** **(** **)** Removes all the breakpoints (without firing "breakpoint_toggled" signal). - .. _class_TextEdit_search: +.. _class_TextEdit_search: - :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. - .. _class_TextEdit_select: +.. _class_TextEdit_select: - void **select** **(** :ref:`int` from_line, :ref:`int` from_column, :ref:`int` to_line, :ref:`int` to_column **)** Perform selection, from line/column to line/column. - .. _class_TextEdit_select_all: +.. _class_TextEdit_select_all: - void **select_all** **(** **)** Select all the text. - .. _class_TextEdit_set_line_as_hidden: +.. _class_TextEdit_set_line_as_hidden: - void **set_line_as_hidden** **(** :ref:`int` line, :ref:`bool` enable **)** - .. _class_TextEdit_toggle_fold_line: +.. _class_TextEdit_toggle_fold_line: - void **toggle_fold_line** **(** :ref:`int` line **)** Toggle the folding of the code block at the given line. - .. _class_TextEdit_undo: +.. _class_TextEdit_undo: - void **undo** **(** **)** Perform undo operation. - .. _class_TextEdit_unfold_line: +.. _class_TextEdit_unfold_line: - void **unfold_line** **(** :ref:`int` line **)** - .. _class_TextEdit_unhide_all_lines: +.. _class_TextEdit_unhide_all_lines: - void **unhide_all_lines** **(** **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 4e0c563be..cbe79c7cf 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -49,7 +49,7 @@ Methods Enumerations ------------ - .. _enum_Texture_Flags: +.. _enum_Texture_Flags: enum **Flags**: @@ -74,7 +74,7 @@ Textures are often created by loading them from a file. See :ref:`@GDScript.load Property Descriptions --------------------- - .. _class_Texture_flags: +.. _class_Texture_flags: - :ref:`int` **flags** @@ -89,41 +89,41 @@ The texture's flags. Method Descriptions ------------------- - .. _class_Texture_draw: +.. _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 - .. _class_Texture_draw_rect: +.. _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 - .. _class_Texture_draw_rect_region: +.. _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 - .. _class_Texture_get_data: +.. _class_Texture_get_data: - :ref:`Image` **get_data** **(** **)** const - .. _class_Texture_get_height: +.. _class_Texture_get_height: - :ref:`int` **get_height** **(** **)** const Return the texture height. - .. _class_Texture_get_size: +.. _class_Texture_get_size: - :ref:`Vector2` **get_size** **(** **)** const Return the texture size. - .. _class_Texture_get_width: +.. _class_Texture_get_width: - :ref:`int` **get_width** **(** **)** const Return the texture width. - .. _class_Texture_has_alpha: +.. _class_Texture_has_alpha: - :ref:`bool` **has_alpha** **(** **)** const diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index cce3efab4..9bc8142c3 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -40,7 +40,7 @@ Properties Enumerations ------------ - .. _enum_TextureButton_StretchMode: +.. _enum_TextureButton_StretchMode: enum **StretchMode**: @@ -62,7 +62,7 @@ The Normal state's texture is required. Others are optional. Property Descriptions --------------------- - .. _class_TextureButton_expand: +.. _class_TextureButton_expand: - :ref:`bool` **expand** @@ -74,7 +74,7 @@ Property Descriptions 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: +.. _class_TextureButton_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -86,7 +86,7 @@ If ``true`` the texture stretches to the edges of the node's bounding rectangle 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: +.. _class_TextureButton_texture_click_mask: - :ref:`BitMap` **texture_click_mask** @@ -98,7 +98,7 @@ Controls the texture's behavior when you resize the node's bounding rectangle, * 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: +.. _class_TextureButton_texture_disabled: - :ref:`Texture` **texture_disabled** @@ -110,7 +110,7 @@ Pure black and white Bitmap image to use for click detection. On the mask, white Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. - .. _class_TextureButton_texture_focused: +.. _class_TextureButton_texture_focused: - :ref:`Texture` **texture_focused** @@ -122,7 +122,7 @@ Texture to display when the node is disabled. See :ref:`BaseButton.disabled` **texture_hover** @@ -134,7 +134,7 @@ Texture to display when the node has mouse or keyboard focus. Texture to display when the mouse hovers the node. - .. _class_TextureButton_texture_normal: +.. _class_TextureButton_texture_normal: - :ref:`Texture` **texture_normal** @@ -146,7 +146,7 @@ Texture to display when the mouse hovers the node. Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. - .. _class_TextureButton_texture_pressed: +.. _class_TextureButton_texture_pressed: - :ref:`Texture` **texture_pressed** diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 3d9aba157..d41aa9598 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -51,7 +51,7 @@ Methods Enumerations ------------ - .. _enum_TextureLayered_Flags: +.. _enum_TextureLayered_Flags: enum **Flags**: @@ -63,11 +63,11 @@ enum **Flags**: Property Descriptions --------------------- - .. _class_TextureLayered_data: +.. _class_TextureLayered_data: - :ref:`Dictionary` **data** - .. _class_TextureLayered_flags: +.. _class_TextureLayered_flags: - :ref:`int` **flags** @@ -80,35 +80,35 @@ Property Descriptions Method Descriptions ------------------- - .. _class_TextureLayered_create: +.. _class_TextureLayered_create: - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`Format` format, :ref:`int` flags=4 **)** - .. _class_TextureLayered_get_depth: +.. _class_TextureLayered_get_depth: - :ref:`int` **get_depth** **(** **)** const - .. _class_TextureLayered_get_format: +.. _class_TextureLayered_get_format: - :ref:`Format` **get_format** **(** **)** const - .. _class_TextureLayered_get_height: +.. _class_TextureLayered_get_height: - :ref:`int` **get_height** **(** **)** const - .. _class_TextureLayered_get_layer_data: +.. _class_TextureLayered_get_layer_data: - :ref:`Image` **get_layer_data** **(** :ref:`int` layer **)** const - .. _class_TextureLayered_get_width: +.. _class_TextureLayered_get_width: - :ref:`int` **get_width** **(** **)** const - .. _class_TextureLayered_set_data_partial: +.. _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 **)** - .. _class_TextureLayered_set_layer_data: +.. _class_TextureLayered_set_layer_data: - void **set_layer_data** **(** :ref:`Image` image, :ref:`int` layer **)** diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index a2710f81a..8cad1c19d 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -54,7 +54,7 @@ Properties Enumerations ------------ - .. _enum_TextureProgress_FillMode: +.. _enum_TextureProgress_FillMode: enum **FillMode**: @@ -76,7 +76,7 @@ TextureProgress works like :ref:`ProgressBar` but it uses up Property Descriptions --------------------- - .. _class_TextureProgress_fill_mode: +.. _class_TextureProgress_fill_mode: - :ref:`int` **fill_mode** @@ -88,7 +88,7 @@ Property Descriptions The fill direction. Uses FILL\_\* constants. - .. _class_TextureProgress_nine_patch_stretch: +.. _class_TextureProgress_nine_patch_stretch: - :ref:`bool` **nine_patch_stretch** @@ -100,7 +100,7 @@ The fill direction. Uses FILL\_\* constants. 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: +.. _class_TextureProgress_radial_center_offset: - :ref:`Vector2` **radial_center_offset** @@ -112,7 +112,7 @@ If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. - .. _class_TextureProgress_radial_fill_degrees: +.. _class_TextureProgress_radial_fill_degrees: - :ref:`float` **radial_fill_degrees** @@ -126,7 +126,7 @@ Upper limit for the fill of :ref:`texture_progress`, :ref:`Range.max_value`. - .. _class_TextureProgress_radial_initial_angle: +.. _class_TextureProgress_radial_initial_angle: - :ref:`float` **radial_initial_angle** @@ -138,7 +138,7 @@ See :ref:`Range.value`, :ref:`Range.max_value` if :ref:`fill_mode` is ``FILL_CLOCKWISE`` or ``FILL_COUNTER_CLOCKWISE``. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees`. - .. _class_TextureProgress_stretch_margin_bottom: +.. _class_TextureProgress_stretch_margin_bottom: - :ref:`int` **stretch_margin_bottom** @@ -150,7 +150,7 @@ Starting angle for the fill of :ref:`texture_progress` **stretch_margin_left** @@ -162,7 +162,7 @@ The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's botto The width of the 9-patch's left column. - .. _class_TextureProgress_stretch_margin_right: +.. _class_TextureProgress_stretch_margin_right: - :ref:`int` **stretch_margin_right** @@ -174,7 +174,7 @@ The width of the 9-patch's left column. The width of the 9-patch's right column. - .. _class_TextureProgress_stretch_margin_top: +.. _class_TextureProgress_stretch_margin_top: - :ref:`int` **stretch_margin_top** @@ -186,7 +186,7 @@ The width of the 9-patch's right column. The height of the 9-patch's top row. - .. _class_TextureProgress_texture_over: +.. _class_TextureProgress_texture_over: - :ref:`Texture` **texture_over** @@ -198,7 +198,7 @@ The height of the 9-patch's top row. :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: +.. _class_TextureProgress_texture_progress: - :ref:`Texture` **texture_progress** @@ -212,7 +212,7 @@ The height of the 9-patch's top row. The ``value`` property comes from :ref:`Range`. See :ref:`Range.value`, :ref:`Range.min_value`, :ref:`Range.max_value`. - .. _class_TextureProgress_texture_under: +.. _class_TextureProgress_texture_under: - :ref:`Texture` **texture_under** @@ -224,7 +224,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val :ref:`Texture` that draws under the progress bar. The bar's background. - .. _class_TextureProgress_tint_over: +.. _class_TextureProgress_tint_over: - :ref:`Color` **tint_over** @@ -234,7 +234,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val | *Getter* | get_tint_over() | +----------+----------------------+ - .. _class_TextureProgress_tint_progress: +.. _class_TextureProgress_tint_progress: - :ref:`Color` **tint_progress** @@ -244,7 +244,7 @@ The ``value`` property comes from :ref:`Range`. See :ref:`Range.val | *Getter* | get_tint_progress() | +----------+--------------------------+ - .. _class_TextureProgress_tint_under: +.. _class_TextureProgress_tint_under: - :ref:`Color` **tint_under** diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 3f64fa3a0..2a1253618 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -30,7 +30,7 @@ Properties Enumerations ------------ - .. _enum_TextureRect_StretchMode: +.. _enum_TextureRect_StretchMode: enum **StretchMode**: @@ -51,7 +51,7 @@ Used to draw icons and sprites in a user interface. The texture's placement can Property Descriptions --------------------- - .. _class_TextureRect_expand: +.. _class_TextureRect_expand: - :ref:`bool` **expand** @@ -63,7 +63,7 @@ Property Descriptions If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. - .. _class_TextureRect_stretch_mode: +.. _class_TextureRect_stretch_mode: - :ref:`StretchMode` **stretch_mode** @@ -75,7 +75,7 @@ If ``true`` the texture scales to fit its bounding rectangle. Default value: ``f Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode`. - .. _class_TextureRect_texture: +.. _class_TextureRect_texture: - :ref:`Texture` **texture** diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 42d954c46..64e8536ee 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -94,7 +94,7 @@ Theme resources can be alternatively loaded by writing them in a .theme file, se Property Descriptions --------------------- - .. _class_Theme_default_font: +.. _class_Theme_default_font: - :ref:`Font` **default_font** @@ -109,115 +109,115 @@ The theme's default font. Method Descriptions ------------------- - .. _class_Theme_clear_color: +.. _class_Theme_clear_color: - void **clear_color** **(** :ref:`String` name, :ref:`String` type **)** Clears theme :ref:`Color` at ``name`` if Theme has ``type``. - .. _class_Theme_clear_constant: +.. _class_Theme_clear_constant: - void **clear_constant** **(** :ref:`String` name, :ref:`String` type **)** Clears theme constant at ``name`` if Theme has ``type``. - .. _class_Theme_clear_font: +.. _class_Theme_clear_font: - void **clear_font** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`Font` at ``name`` if Theme has ``type``. - .. _class_Theme_clear_icon: +.. _class_Theme_clear_icon: - void **clear_icon** **(** :ref:`String` name, :ref:`String` type **)** Clears icon at ``name`` if Theme has ``type``. - .. _class_Theme_clear_stylebox: +.. _class_Theme_clear_stylebox: - void **clear_stylebox** **(** :ref:`String` name, :ref:`String` type **)** Clears :ref:`StyleBox` at ``name`` if Theme has ``type``. - .. _class_Theme_copy_default_theme: +.. _class_Theme_copy_default_theme: - void **copy_default_theme** **(** **)** Sets theme values to a copy of the default theme values. - .. _class_Theme_get_color: +.. _class_Theme_get_color: - :ref:`Color` **get_color** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Color` at ``name`` if Theme has ``type``. - .. _class_Theme_get_color_list: +.. _class_Theme_get_color_list: - :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``. - .. _class_Theme_get_constant: +.. _class_Theme_get_constant: - :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: +.. _class_Theme_get_constant_list: - :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``. - .. _class_Theme_get_font: +.. _class_Theme_get_font: - :ref:`Font` **get_font** **(** :ref:`String` name, :ref:`String` type **)** const Returns the :ref:`Font` at ``name`` if Theme has ``type``. - .. _class_Theme_get_font_list: +.. _class_Theme_get_font_list: - :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``. - .. _class_Theme_get_icon: +.. _class_Theme_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`Texture` at ``name`` if Theme has ``type``. - .. _class_Theme_get_icon_list: +.. _class_Theme_get_icon_list: - :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``. - .. _class_Theme_get_stylebox: +.. _class_Theme_get_stylebox: - :ref:`StyleBox` **get_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const Returns the icon :ref:`StyleBox` at ``name`` if Theme has ``type``. - .. _class_Theme_get_stylebox_list: +.. _class_Theme_get_stylebox_list: - :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``. - .. _class_Theme_get_stylebox_types: +.. _class_Theme_get_stylebox_types: - :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``. - .. _class_Theme_get_type_list: +.. _class_Theme_get_type_list: - :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``. - .. _class_Theme_has_color: +.. _class_Theme_has_color: - :ref:`bool` **has_color** **(** :ref:`String` name, :ref:`String` type **)** const @@ -225,7 +225,7 @@ Returns ``true`` if :ref:`Color` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. - .. _class_Theme_has_constant: +.. _class_Theme_has_constant: - :ref:`bool` **has_constant** **(** :ref:`String` name, :ref:`String` type **)** const @@ -233,7 +233,7 @@ Returns ``true`` if constant with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. - .. _class_Theme_has_font: +.. _class_Theme_has_font: - :ref:`bool` **has_font** **(** :ref:`String` name, :ref:`String` type **)** const @@ -241,7 +241,7 @@ Returns ``true`` if :ref:`Font` with ``name`` is in ``type``. Returns ``false`` if Theme does not have ``type``. - .. _class_Theme_has_icon: +.. _class_Theme_has_icon: - :ref:`bool` **has_icon** **(** :ref:`String` name, :ref:`String` type **)** const @@ -249,7 +249,7 @@ Returns ``true`` if icon :ref:`Texture` with ``name`` is in ``typ Returns ``false`` if Theme does not have ``type``. - .. _class_Theme_has_stylebox: +.. _class_Theme_has_stylebox: - :ref:`bool` **has_stylebox** **(** :ref:`String` name, :ref:`String` type **)** const @@ -257,7 +257,7 @@ Returns ``true`` if :ref:`StyleBox` with ``name`` is in ``type`` Returns ``false`` if Theme does not have ``type``. - .. _class_Theme_set_color: +.. _class_Theme_set_color: - void **set_color** **(** :ref:`String` name, :ref:`String` type, :ref:`Color` color **)** @@ -265,7 +265,7 @@ Sets Theme's :ref:`Color` to ``color`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. - .. _class_Theme_set_constant: +.. _class_Theme_set_constant: - void **set_constant** **(** :ref:`String` name, :ref:`String` type, :ref:`int` constant **)** @@ -273,7 +273,7 @@ Sets Theme's constant to ``constant`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. - .. _class_Theme_set_font: +.. _class_Theme_set_font: - void **set_font** **(** :ref:`String` name, :ref:`String` type, :ref:`Font` font **)** @@ -281,7 +281,7 @@ Sets Theme's :ref:`Font` to ``font`` at ``name`` in ``type``. Does nothing if Theme does not have ``type``. - .. _class_Theme_set_icon: +.. _class_Theme_set_icon: - void **set_icon** **(** :ref:`String` name, :ref:`String` type, :ref:`Texture` texture **)** @@ -289,7 +289,7 @@ Sets Theme's icon :ref:`Texture` to ``texture`` at ``name`` in `` Does nothing if Theme does not have ``type``. - .. _class_Theme_set_stylebox: +.. _class_Theme_set_stylebox: - void **set_stylebox** **(** :ref:`String` name, :ref:`String` type, :ref:`StyleBox` texture **)** diff --git a/classes/class_thread.rst b/classes/class_thread.rst index 8b9a6ddf1..372cc980d 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -32,7 +32,7 @@ Methods Enumerations ------------ - .. _enum_Thread_Priority: +.. _enum_Thread_Priority: enum **Priority**: @@ -48,19 +48,19 @@ A unit of execution in a process. Can run methods on :ref:`Object` Method Descriptions ------------------- - .. _class_Thread_get_id: +.. _class_Thread_get_id: - :ref:`String` **get_id** **(** **)** const Returns the current ``Thread``\ s id, uniquely identifying it among all threads. - .. _class_Thread_is_active: +.. _class_Thread_is_active: - :ref:`bool` **is_active** **(** **)** const Returns true if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. - .. _class_Thread_start: +.. _class_Thread_start: - :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** @@ -68,7 +68,7 @@ Starts a new ``Thread`` that runs "method" on object "instance" with "userdata" Returns OK on success, or ERR_CANT_CREATE on failure. - .. _class_Thread_wait_to_finish: +.. _class_Thread_wait_to_finish: - :ref:`Variant` **wait_to_finish** **(** **)** diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 4bd6d7cb6..dec9c9886 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -101,7 +101,7 @@ Methods Signals ------- - .. _class_TileMap_settings_changed: +.. _class_TileMap_settings_changed: - **settings_changed** **(** **)** @@ -110,7 +110,7 @@ Emitted when a tilemap setting has changed. Enumerations ------------ - .. _enum_TileMap_HalfOffset: +.. _enum_TileMap_HalfOffset: enum **HalfOffset**: @@ -118,7 +118,7 @@ enum **HalfOffset**: - **HALF_OFFSET_Y** = **1** --- Half offset on the Y coordinate. - **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled. - .. _enum_TileMap_TileOrigin: +.. _enum_TileMap_TileOrigin: enum **TileOrigin**: @@ -126,7 +126,7 @@ enum **TileOrigin**: - **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_TileMap_Mode: enum **Mode**: @@ -138,6 +138,7 @@ Constants --------- - **INVALID_CELL** = **-1** --- Returned when a cell doesn't exist. + Description ----------- @@ -147,10 +148,11 @@ Tutorials --------- - :doc:`../tutorials/2d/using_tilemaps` + Property Descriptions --------------------- - .. _class_TileMap_cell_clip_uv: +.. _class_TileMap_cell_clip_uv: - :ref:`bool` **cell_clip_uv** @@ -160,7 +162,7 @@ Property Descriptions | *Getter* | get_clip_uv() | +----------+--------------------+ - .. _class_TileMap_cell_custom_transform: +.. _class_TileMap_cell_custom_transform: - :ref:`Transform2D` **cell_custom_transform** @@ -172,7 +174,7 @@ Property Descriptions The custom :ref:`Transform2D` to be applied to the TileMap's cells. - .. _class_TileMap_cell_half_offset: +.. _class_TileMap_cell_half_offset: - :ref:`HalfOffset` **cell_half_offset** @@ -184,7 +186,7 @@ The custom :ref:`Transform2D` to be applied to the TileMap's Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default value: HALF_OFFSET_DISABLED. - .. _class_TileMap_cell_quadrant_size: +.. _class_TileMap_cell_quadrant_size: - :ref:`int` **cell_quadrant_size** @@ -196,7 +198,7 @@ Amount to offset alternating tiles. Uses HALF_OFFSET\_\* constants. Default valu The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. - .. _class_TileMap_cell_size: +.. _class_TileMap_cell_size: - :ref:`Vector2` **cell_size** @@ -208,7 +210,7 @@ The TileMap's quadrant size. Optimizes drawing by batching, using chunks of thi The TileMap's cell size. - .. _class_TileMap_cell_tile_origin: +.. _class_TileMap_cell_tile_origin: - :ref:`TileOrigin` **cell_tile_origin** @@ -220,7 +222,7 @@ The TileMap's cell size. Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_ORIGIN_TOP_LEFT. - .. _class_TileMap_cell_y_sort: +.. _class_TileMap_cell_y_sort: - :ref:`bool` **cell_y_sort** @@ -232,7 +234,7 @@ Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_OR If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. - .. _class_TileMap_collision_bounce: +.. _class_TileMap_collision_bounce: - :ref:`float` **collision_bounce** @@ -244,7 +246,7 @@ If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Bounce value for static body collisions (see ``collision_use_kinematic``). Default value: 0. - .. _class_TileMap_collision_friction: +.. _class_TileMap_collision_friction: - :ref:`float` **collision_friction** @@ -256,7 +258,7 @@ Bounce value for static body collisions (see ``collision_use_kinematic``). Defau Friction value for static body collisions (see ``collision_use_kinematic``). Default value: 1. - .. _class_TileMap_collision_layer: +.. _class_TileMap_collision_layer: - :ref:`int` **collision_layer** @@ -268,7 +270,7 @@ Friction value for static body collisions (see ``collision_use_kinematic``). Def The collision layer(s) for all colliders in the TileMap. - .. _class_TileMap_collision_mask: +.. _class_TileMap_collision_mask: - :ref:`int` **collision_mask** @@ -280,7 +282,7 @@ The collision layer(s) for all colliders in the TileMap. The collision mask(s) for all colliders in the TileMap. - .. _class_TileMap_collision_use_kinematic: +.. _class_TileMap_collision_use_kinematic: - :ref:`bool` **collision_use_kinematic** @@ -292,7 +294,7 @@ The collision mask(s) for all colliders in the TileMap. If ``true`` TileMap collisions will be handled as a kinematic body. If ``false`` collisions will be handled as static body. Default value: ``false``. - .. _class_TileMap_mode: +.. _class_TileMap_mode: - :ref:`Mode` **mode** @@ -304,7 +306,7 @@ If ``true`` TileMap collisions will be handled as a kinematic body. If ``false`` The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUARE. - .. _class_TileMap_occluder_light_mask: +.. _class_TileMap_occluder_light_mask: - :ref:`int` **occluder_light_mask** @@ -316,7 +318,7 @@ The TileMap orientation mode. Uses MODE\_\* constants. Default value: MODE_SQUAR The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). - .. _class_TileMap_tile_set: +.. _class_TileMap_tile_set: - :ref:`TileSet` **tile_set** @@ -331,79 +333,79 @@ The assigned :ref:`TileSet`. Method Descriptions ------------------- - .. _class_TileMap_clear: +.. _class_TileMap_clear: - void **clear** **(** **)** Clears all cells. - .. _class_TileMap_fix_invalid_tiles: +.. _class_TileMap_fix_invalid_tiles: - void **fix_invalid_tiles** **(** **)** Clears cells that do not exist in the tileset. - .. _class_TileMap_get_cell: +.. _class_TileMap_get_cell: - :ref:`int` **get_cell** **(** :ref:`int` x, :ref:`int` y **)** const Returns the tile index of the given cell. - .. _class_TileMap_get_cellv: +.. _class_TileMap_get_cellv: - :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Returns the tile index of the cell given by a Vector2. - .. _class_TileMap_get_collision_layer_bit: +.. _class_TileMap_get_collision_layer_bit: - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision layer bit is set. - .. _class_TileMap_get_collision_mask_bit: +.. _class_TileMap_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const Returns ``true`` if the given collision mask bit is set. - .. _class_TileMap_get_used_cells: +.. _class_TileMap_get_used_cells: - :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``). - .. _class_TileMap_get_used_cells_by_id: +.. _class_TileMap_get_used_cells_by_id: - :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: +.. _class_TileMap_get_used_rect: - :ref:`Rect2` **get_used_rect** **(** **)** Returns a rectangle enclosing the used (non-empty) tiles of the map. - .. _class_TileMap_is_cell_transposed: +.. _class_TileMap_is_cell_transposed: - :ref:`bool` **is_cell_transposed** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is transposed, i.e. the x and y axes are swapped. - .. _class_TileMap_is_cell_x_flipped: +.. _class_TileMap_is_cell_x_flipped: - :ref:`bool` **is_cell_x_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is flipped in the x axis. - .. _class_TileMap_is_cell_y_flipped: +.. _class_TileMap_is_cell_y_flipped: - :ref:`bool` **is_cell_y_flipped** **(** :ref:`int` x, :ref:`int` y **)** const Returns ``true`` if the given cell is flipped in the y axis. - .. _class_TileMap_map_to_world: +.. _class_TileMap_map_to_world: - :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const @@ -411,7 +413,7 @@ Returns the global position corresponding to the given tilemap (grid-based) coor Optionally, the tilemap's half offset can be ignored. - .. _class_TileMap_set_cell: +.. _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 ) **)** @@ -425,7 +427,7 @@ 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_cellv: +.. _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 **)** @@ -439,25 +441,25 @@ 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_collision_layer_bit: +.. _class_TileMap_set_collision_layer_bit: - void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision layer bit. - .. _class_TileMap_set_collision_mask_bit: +.. _class_TileMap_set_collision_mask_bit: - void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets the given collision mask bit. - .. _class_TileMap_update_bitmask_area: +.. _class_TileMap_update_bitmask_area: - 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: +.. _class_TileMap_update_bitmask_region: - void **update_bitmask_region** **(** :ref:`Vector2` start=Vector2( 0, 0 ), :ref:`Vector2` end=Vector2( 0, 0 ) **)** @@ -465,13 +467,13 @@ Applies autotiling rules to the cells in the given region (specified by grid-bas Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. - .. _class_TileMap_update_dirty_quadrants: +.. _class_TileMap_update_dirty_quadrants: - void **update_dirty_quadrants** **(** **)** Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. - .. _class_TileMap_world_to_map: +.. _class_TileMap_world_to_map: - :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 33fa68a2d..e83212553 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -124,7 +124,7 @@ Methods Enumerations ------------ - .. _enum_TileSet_BitmaskMode: +.. _enum_TileSet_BitmaskMode: enum **BitmaskMode**: @@ -132,7 +132,7 @@ enum **BitmaskMode**: - **BITMASK_3X3_MINIMAL** = **1** - **BITMASK_3X3** = **2** - .. _enum_TileSet_TileMode: +.. _enum_TileSet_TileMode: enum **TileMode**: @@ -140,7 +140,7 @@ enum **TileMode**: - **AUTO_TILE** = **1** - **ATLAS_TILE** = **2** - .. _enum_TileSet_AutotileBindings: +.. _enum_TileSet_AutotileBindings: enum **AutotileBindings**: @@ -163,261 +163,261 @@ Tiles are referenced by a unique integer ID. Method Descriptions ------------------- - .. _class_TileSet__forward_subtile_selection: +.. _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 - .. _class_TileSet__is_tile_bound: +.. _class_TileSet__is_tile_bound: - :ref:`bool` **_is_tile_bound** **(** :ref:`int` drawn_id, :ref:`int` neighbor_id **)** virtual - .. _class_TileSet_autotile_get_bitmask_mode: +.. _class_TileSet_autotile_get_bitmask_mode: - :ref:`BitmaskMode` **autotile_get_bitmask_mode** **(** :ref:`int` id **)** const - .. _class_TileSet_autotile_get_size: +.. _class_TileSet_autotile_get_size: - :ref:`Vector2` **autotile_get_size** **(** :ref:`int` id **)** const - .. _class_TileSet_autotile_set_bitmask_mode: +.. _class_TileSet_autotile_set_bitmask_mode: - void **autotile_set_bitmask_mode** **(** :ref:`int` id, :ref:`BitmaskMode` mode **)** - .. _class_TileSet_autotile_set_size: +.. _class_TileSet_autotile_set_size: - void **autotile_set_size** **(** :ref:`int` id, :ref:`Vector2` size **)** - .. _class_TileSet_clear: +.. _class_TileSet_clear: - void **clear** **(** **)** Clears all tiles. - .. _class_TileSet_create_tile: +.. _class_TileSet_create_tile: - void **create_tile** **(** :ref:`int` id **)** Creates a new tile which will be referenced by the given ID. - .. _class_TileSet_find_tile_by_name: +.. _class_TileSet_find_tile_by_name: - :ref:`int` **find_tile_by_name** **(** :ref:`String` name **)** const Returns the first tile matching the given name. - .. _class_TileSet_get_last_unused_tile_id: +.. _class_TileSet_get_last_unused_tile_id: - :ref:`int` **get_last_unused_tile_id** **(** **)** const Returns the ID following the last currently used ID, useful when creating a new tile. - .. _class_TileSet_get_tiles_ids: +.. _class_TileSet_get_tiles_ids: - :ref:`Array` **get_tiles_ids** **(** **)** const Returns an array of all currently used tile IDs. - .. _class_TileSet_remove_tile: +.. _class_TileSet_remove_tile: - void **remove_tile** **(** :ref:`int` id **)** Removes the tile referenced by the given ID. - .. _class_TileSet_tile_add_shape: +.. _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 ) **)** - .. _class_TileSet_tile_get_light_occluder: +.. _class_TileSet_tile_get_light_occluder: - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const Returns the light occluder of the tile. - .. _class_TileSet_tile_get_material: +.. _class_TileSet_tile_get_material: - :ref:`ShaderMaterial` **tile_get_material** **(** :ref:`int` id **)** const Returns the material of the tile. - .. _class_TileSet_tile_get_modulate: +.. _class_TileSet_tile_get_modulate: - :ref:`Color` **tile_get_modulate** **(** :ref:`int` id **)** const - .. _class_TileSet_tile_get_name: +.. _class_TileSet_tile_get_name: - :ref:`String` **tile_get_name** **(** :ref:`int` id **)** const Returns the name of the tile. - .. _class_TileSet_tile_get_navigation_polygon: +.. _class_TileSet_tile_get_navigation_polygon: - :ref:`NavigationPolygon` **tile_get_navigation_polygon** **(** :ref:`int` id **)** const Returns the navigation polygon of the tile. - .. _class_TileSet_tile_get_navigation_polygon_offset: +.. _class_TileSet_tile_get_navigation_polygon_offset: - :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: +.. _class_TileSet_tile_get_normal_map: - :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const - .. _class_TileSet_tile_get_occluder_offset: +.. _class_TileSet_tile_get_occluder_offset: - :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const Returns the offset of the tile's light occluder. - .. _class_TileSet_tile_get_region: +.. _class_TileSet_tile_get_region: - :ref:`Rect2` **tile_get_region** **(** :ref:`int` id **)** const Returns the tile sub-region in the texture. - .. _class_TileSet_tile_get_shape: +.. _class_TileSet_tile_get_shape: - :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const - .. _class_TileSet_tile_get_shape_count: +.. _class_TileSet_tile_get_shape_count: - :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const - .. _class_TileSet_tile_get_shape_offset: +.. _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: +.. _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: +.. _class_TileSet_tile_get_shape_transform: - :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const - .. _class_TileSet_tile_get_shapes: +.. _class_TileSet_tile_get_shapes: - :ref:`Array` **tile_get_shapes** **(** :ref:`int` id **)** const Returns the array of shapes of the tile. - .. _class_TileSet_tile_get_texture: +.. _class_TileSet_tile_get_texture: - :ref:`Texture` **tile_get_texture** **(** :ref:`int` id **)** const Returns the texture of the tile. - .. _class_TileSet_tile_get_texture_offset: +.. _class_TileSet_tile_get_texture_offset: - :ref:`Vector2` **tile_get_texture_offset** **(** :ref:`int` id **)** const Returns the texture offset of the tile. - .. _class_TileSet_tile_get_tile_mode: +.. _class_TileSet_tile_get_tile_mode: - :ref:`TileMode` **tile_get_tile_mode** **(** :ref:`int` id **)** const - .. _class_TileSet_tile_get_z_index: +.. _class_TileSet_tile_get_z_index: - :ref:`int` **tile_get_z_index** **(** :ref:`int` id **)** const - .. _class_TileSet_tile_set_light_occluder: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_material: - void **tile_set_material** **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** Sets the tile's material. - .. _class_TileSet_tile_set_modulate: +.. _class_TileSet_tile_set_modulate: - void **tile_set_modulate** **(** :ref:`int` id, :ref:`Color` color **)** Sets the tile's modulation color. - .. _class_TileSet_tile_set_name: +.. _class_TileSet_tile_set_name: - void **tile_set_name** **(** :ref:`int` id, :ref:`String` name **)** Sets the tile's name. - .. _class_TileSet_tile_set_navigation_polygon: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_shape: - void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** - .. _class_TileSet_tile_set_shape_offset: +.. _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: +.. _class_TileSet_tile_set_shape_one_way: - void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** - .. _class_TileSet_tile_set_shape_transform: +.. _class_TileSet_tile_set_shape_transform: - void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** - .. _class_TileSet_tile_set_shapes: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_texture: - void **tile_set_texture** **(** :ref:`int` id, :ref:`Texture` texture **)** Sets the tile's texture. - .. _class_TileSet_tile_set_texture_offset: +.. _class_TileSet_tile_set_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: +.. _class_TileSet_tile_set_tile_mode: - void **tile_set_tile_mode** **(** :ref:`int` id, :ref:`TileMode` tilemode **)** Sets the tile's :ref:`TileMode`. - .. _class_TileSet_tile_set_z_index: +.. _class_TileSet_tile_set_z_index: - void **tile_set_z_index** **(** :ref:`int` id, :ref:`int` z_index **)** diff --git a/classes/class_timer.rst b/classes/class_timer.rst index a9e7a07ed..20a5738b6 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -47,7 +47,7 @@ Methods Signals ------- - .. _class_Timer_timeout: +.. _class_Timer_timeout: - **timeout** **(** **)** @@ -56,7 +56,7 @@ Emitted when the timer reaches 0. Enumerations ------------ - .. _enum_Timer_TimerProcessMode: +.. _enum_Timer_TimerProcessMode: enum **TimerProcessMode**: @@ -71,7 +71,7 @@ Counts down a specified interval and emits a signal on reaching 0. Can be set to Property Descriptions --------------------- - .. _class_Timer_autostart: +.. _class_Timer_autostart: - :ref:`bool` **autostart** @@ -83,7 +83,7 @@ Property Descriptions If ``true`` the timer will automatically start when entering the scene tree. Default value: ``false``. - .. _class_Timer_one_shot: +.. _class_Timer_one_shot: - :ref:`bool` **one_shot** @@ -95,7 +95,7 @@ If ``true`` the timer will automatically start when entering the scene tree. Def If ``true`` the timer will stop when reaching 0. If ``false`` it will restart. Default value: ``false``. - .. _class_Timer_paused: +.. _class_Timer_paused: - :ref:`bool` **paused** @@ -107,7 +107,7 @@ If ``true`` the timer will stop when reaching 0. If ``false`` it will restart. D If ``true`` the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. - .. _class_Timer_process_mode: +.. _class_Timer_process_mode: - :ref:`TimerProcessMode` **process_mode** @@ -119,7 +119,7 @@ If ``true`` the timer is paused and will not process until it is unpaused again, Processing mode. See :ref:`TimerProcessMode`. - .. _class_Timer_time_left: +.. _class_Timer_time_left: - :ref:`float` **time_left** @@ -131,7 +131,7 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive. Note: You cannot set this value. To change the timer's remaining time, use :ref:`wait_time`. - .. _class_Timer_wait_time: +.. _class_Timer_wait_time: - :ref:`float` **wait_time** @@ -146,13 +146,13 @@ Wait time in seconds. Method Descriptions ------------------- - .. _class_Timer_is_stopped: +.. _class_Timer_is_stopped: - :ref:`bool` **is_stopped** **(** **)** const Returns ``true`` if the timer is stopped. - .. _class_Timer_start: +.. _class_Timer_start: - void **start** **(** :ref:`float` time_sec=-1 **)** @@ -160,7 +160,7 @@ Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec`` > 0. This a Note: this method will not resume a paused timer. See :ref:`set_paused`. - .. _class_Timer_stop: +.. _class_Timer_stop: - void **stop** **(** **)** diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 2979be3a6..afd38f30a 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -49,13 +49,13 @@ Methods Signals ------- - .. _class_TouchScreenButton_pressed: +.. _class_TouchScreenButton_pressed: - **pressed** **(** **)** Emitted when the button is pressed (down). - .. _class_TouchScreenButton_released: +.. _class_TouchScreenButton_released: - **released** **(** **)** @@ -64,7 +64,7 @@ Emitted when the button is released (up). Enumerations ------------ - .. _enum_TouchScreenButton_VisibilityMode: +.. _enum_TouchScreenButton_VisibilityMode: enum **VisibilityMode**: @@ -79,7 +79,7 @@ Button for touch screen devices. You can set it to be visible on all screens, or Property Descriptions --------------------- - .. _class_TouchScreenButton_action: +.. _class_TouchScreenButton_action: - :ref:`String` **action** @@ -91,7 +91,7 @@ Property Descriptions The button's action. Actions can be handled with :ref:`InputEventAction`. - .. _class_TouchScreenButton_bitmask: +.. _class_TouchScreenButton_bitmask: - :ref:`BitMap` **bitmask** @@ -103,7 +103,7 @@ The button's action. Actions can be handled with :ref:`InputEventAction` **normal** @@ -115,7 +115,7 @@ The button's bitmask. The button's texture for the normal state. - .. _class_TouchScreenButton_passby_press: +.. _class_TouchScreenButton_passby_press: - :ref:`bool` **passby_press** @@ -127,7 +127,7 @@ The button's texture for the normal state. If ``true`` passby presses are enabled. - .. _class_TouchScreenButton_pressed: +.. _class_TouchScreenButton_pressed: - :ref:`Texture` **pressed** @@ -139,7 +139,7 @@ If ``true`` passby presses are enabled. The button's texture for the pressed state. - .. _class_TouchScreenButton_shape: +.. _class_TouchScreenButton_shape: - :ref:`Shape2D` **shape** @@ -151,7 +151,7 @@ The button's texture for the pressed state. The button's shape. - .. _class_TouchScreenButton_shape_centered: +.. _class_TouchScreenButton_shape_centered: - :ref:`bool` **shape_centered** @@ -163,7 +163,7 @@ The button's shape. If ``true`` the button's shape is centered. - .. _class_TouchScreenButton_shape_visible: +.. _class_TouchScreenButton_shape_visible: - :ref:`bool` **shape_visible** @@ -175,7 +175,7 @@ If ``true`` the button's shape is centered. If ``true`` the button's shape is visible. - .. _class_TouchScreenButton_visibility_mode: +.. _class_TouchScreenButton_visibility_mode: - :ref:`VisibilityMode` **visibility_mode** @@ -190,7 +190,7 @@ The button's visibility mode. See ``VISIBILITY_*`` constants. Method Descriptions ------------------- - .. _class_TouchScreenButton_is_pressed: +.. _class_TouchScreenButton_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 51eaf1089..087244688 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -65,6 +65,7 @@ Constants - **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_Y** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** - **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** + Description ----------- @@ -74,17 +75,19 @@ Tutorials --------- - :doc:`../tutorials/math/index` + - :doc:`../tutorials/3d/using_transforms` + Property Descriptions --------------------- - .. _class_Transform_basis: +.. _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: +.. _class_Transform_origin: - :ref:`Vector3` **origin** @@ -93,55 +96,55 @@ The translation offset of the transform. Method Descriptions ------------------- - .. _class_Transform_Transform: +.. _class_Transform_Transform: - :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). - .. _class_Transform_Transform: +.. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. - .. _class_Transform_Transform: +.. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** Constructs the Transform from a :ref:`Transform2D`. - .. _class_Transform_Transform: +.. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). - .. _class_Transform_Transform: +.. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). - .. _class_Transform_affine_inverse: +.. _class_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: +.. _class_Transform_interpolate_with: - :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** Interpolates the transform to other Transform by weight amount (0-1). - .. _class_Transform_inverse: +.. _class_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: +.. _class_Transform_looking_at: - :ref:`Transform` **looking_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** @@ -151,37 +154,37 @@ The transform will first be rotated around the given ``up`` vector, and then ful Operations take place in global space. - .. _class_Transform_orthonormalized: +.. _class_Transform_orthonormalized: - :ref:`Transform` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. - .. _class_Transform_rotated: +.. _class_Transform_rotated: - :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: +.. _class_Transform_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** Scales the transform by the specified 3D scaling factors. - .. _class_Transform_translated: +.. _class_Transform_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** Translates the transform by the specified offset. - .. _class_Transform_xform: +.. _class_Transform_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector3`, :ref:`Plane`, or :ref:`AABB` by this transform. - .. _class_Transform_xform_inv: +.. _class_Transform_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index b43db4c29..d2c463e00 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -70,6 +70,7 @@ Constants - **IDENTITY** = **Transform2D( 1, 0, 0, 1, 0, 0 )** - **FLIP_X** = **Transform2D( -1, 0, 0, 1, 0, 0 )** - **FLIP_Y** = **Transform2D( 1, 0, 0, -1, 0, 0 )** + Description ----------- @@ -78,19 +79,19 @@ Represents one or many transformations in 2D space such as translation, rotation Property Descriptions --------------------- - .. _class_Transform2D_origin: +.. _class_Transform2D_origin: - :ref:`Vector2` **origin** The transform's translation offset. - .. _class_Transform2D_x: +.. _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: +.. _class_Transform2D_y: - :ref:`Vector2` **y** @@ -99,103 +100,103 @@ The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2`\ s as Method Descriptions ------------------- - .. _class_Transform2D_Transform2D: +.. _class_Transform2D_Transform2D: - :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** Constructs the transform from a 3D :ref:`Transform`. - .. _class_Transform2D_Transform2D: +.. _class_Transform2D_Transform2D: - :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. - .. _class_Transform2D_Transform2D: +.. _class_Transform2D_Transform2D: - :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. - .. _class_Transform2D_affine_inverse: +.. _class_Transform2D_affine_inverse: - :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the matrix. - .. _class_Transform2D_basis_xform: +.. _class_Transform2D_basis_xform: - :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Transforms the given vector by this transform's basis (no translation). - .. _class_Transform2D_basis_xform_inv: +.. _class_Transform2D_basis_xform_inv: - :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Inverse-transforms the given vector by this transform's basis (no translation). - .. _class_Transform2D_get_origin: +.. _class_Transform2D_get_origin: - :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). - .. _class_Transform2D_get_rotation: +.. _class_Transform2D_get_rotation: - :ref:`float` **get_rotation** **(** **)** Returns the transform's rotation (in radians). - .. _class_Transform2D_get_scale: +.. _class_Transform2D_get_scale: - :ref:`Vector2` **get_scale** **(** **)** Returns the scale. - .. _class_Transform2D_interpolate_with: +.. _class_Transform2D_interpolate_with: - :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: +.. _class_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: +.. _class_Transform2D_orthonormalized: - :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. - .. _class_Transform2D_rotated: +.. _class_Transform2D_rotated: - :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** Rotates the transform by the given angle (in radians). - .. _class_Transform2D_scaled: +.. _class_Transform2D_scaled: - :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Scales the transform by the given factor. - .. _class_Transform2D_translated: +.. _class_Transform2D_translated: - :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Translates the transform by the given offset. - .. _class_Transform2D_xform: +.. _class_Transform2D_xform: - :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector2` or :ref:`Rect2` by this transform. - .. _class_Transform2D_xform_inv: +.. _class_Transform2D_xform_inv: - :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** diff --git a/classes/class_translation.rst b/classes/class_translation.rst index e236b75ef..fe1476c47 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -48,7 +48,7 @@ Translations are resources that can be loaded/unloaded on demand. They map a str Property Descriptions --------------------- - .. _class_Translation_locale: +.. _class_Translation_locale: - :ref:`String` **locale** @@ -61,29 +61,29 @@ Property Descriptions Method Descriptions ------------------- - .. _class_Translation_add_message: +.. _class_Translation_add_message: - void **add_message** **(** :ref:`String` src_message, :ref:`String` xlated_message **)** Add a message for translation. - .. _class_Translation_erase_message: +.. _class_Translation_erase_message: - void **erase_message** **(** :ref:`String` src_message **)** Erase a message. - .. _class_Translation_get_message: +.. _class_Translation_get_message: - :ref:`String` **get_message** **(** :ref:`String` src_message **)** const Return a message for translation. - .. _class_Translation_get_message_count: +.. _class_Translation_get_message_count: - :ref:`int` **get_message_count** **(** **)** const - .. _class_Translation_get_message_list: +.. _class_Translation_get_message_list: - :ref:`PoolStringArray` **get_message_list** **(** **)** const diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 12e2ef323..3a42d4293 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -38,31 +38,31 @@ Methods Method Descriptions ------------------- - .. _class_TranslationServer_add_translation: +.. _class_TranslationServer_add_translation: - void **add_translation** **(** :ref:`Translation` translation **)** - .. _class_TranslationServer_clear: +.. _class_TranslationServer_clear: - void **clear** **(** **)** - .. _class_TranslationServer_get_locale: +.. _class_TranslationServer_get_locale: - :ref:`String` **get_locale** **(** **)** const - .. _class_TranslationServer_get_locale_name: +.. _class_TranslationServer_get_locale_name: - :ref:`String` **get_locale_name** **(** :ref:`String` locale **)** const - .. _class_TranslationServer_remove_translation: +.. _class_TranslationServer_remove_translation: - void **remove_translation** **(** :ref:`Translation` translation **)** - .. _class_TranslationServer_set_locale: +.. _class_TranslationServer_set_locale: - void **set_locale** **(** :ref:`String` locale **)** - .. _class_TranslationServer_translate: +.. _class_TranslationServer_translate: - :ref:`String` **translate** **(** :ref:`String` message **)** const diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 613d4edc9..c9732cc9b 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -170,96 +170,96 @@ Theme Properties Signals ------- - .. _class_Tree_button_pressed: +.. _class_Tree_button_pressed: - **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`). - .. _class_Tree_cell_selected: +.. _class_Tree_cell_selected: - **cell_selected** **(** **)** Emitted when a cell is selected. - .. _class_Tree_column_title_pressed: +.. _class_Tree_column_title_pressed: - **column_title_pressed** **(** :ref:`int` column **)** Emitted when a column's title is pressed. - .. _class_Tree_custom_popup_edited: +.. _class_Tree_custom_popup_edited: - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. - .. _class_Tree_empty_tree_rmb_selected: +.. _class_Tree_empty_tree_rmb_selected: - **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. - .. _class_Tree_item_activated: +.. _class_Tree_item_activated: - **item_activated** **(** **)** Emitted when an item's label is double-clicked. - .. _class_Tree_item_collapsed: +.. _class_Tree_item_collapsed: - **item_collapsed** **(** :ref:`TreeItem` item **)** Emitted when an item is collapsed by a click on the folding arrow. - .. _class_Tree_item_custom_button_pressed: +.. _class_Tree_item_custom_button_pressed: - **item_custom_button_pressed** **(** **)** - .. _class_Tree_item_double_clicked: +.. _class_Tree_item_double_clicked: - **item_double_clicked** **(** **)** Emitted when an item's icon is double-clicked. - .. _class_Tree_item_edited: +.. _class_Tree_item_edited: - **item_edited** **(** **)** Emitted when an item is edited. - .. _class_Tree_item_rmb_edited: +.. _class_Tree_item_rmb_edited: - **item_rmb_edited** **(** **)** Emitted when an item is edited using the right mouse button. - .. _class_Tree_item_rmb_selected: +.. _class_Tree_item_rmb_selected: - **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. - .. _class_Tree_item_selected: +.. _class_Tree_item_selected: - **item_selected** **(** **)** Emitted when an item is selected with right mouse button. - .. _class_Tree_multi_selected: +.. _class_Tree_multi_selected: - **multi_selected** **(** :ref:`TreeItem` item, :ref:`int` column, :ref:`bool` selected **)** Emitted instead of ``item_selected`` when ``select_mode`` is ``SELECT_MULTI``. - .. _class_Tree_nothing_selected: +.. _class_Tree_nothing_selected: - **nothing_selected** **(** **)** Enumerations ------------ - .. _enum_Tree_DropModeFlags: +.. _enum_Tree_DropModeFlags: enum **DropModeFlags**: @@ -267,7 +267,7 @@ enum **DropModeFlags**: - **DROP_MODE_ON_ITEM** = **1** - **DROP_MODE_INBETWEEN** = **2** - .. _enum_Tree_SelectMode: +.. _enum_Tree_SelectMode: enum **SelectMode**: @@ -296,7 +296,7 @@ Trees are built via code, using :ref:`TreeItem` objects to creat Property Descriptions --------------------- - .. _class_Tree_allow_reselect: +.. _class_Tree_allow_reselect: - :ref:`bool` **allow_reselect** @@ -308,7 +308,7 @@ Property Descriptions If ``true`` the currently selected cell may be selected again. - .. _class_Tree_allow_rmb_select: +.. _class_Tree_allow_rmb_select: - :ref:`bool` **allow_rmb_select** @@ -320,7 +320,7 @@ If ``true`` the currently selected cell may be selected again. If ``true`` a right mouse button click can select items. - .. _class_Tree_columns: +.. _class_Tree_columns: - :ref:`int` **columns** @@ -332,7 +332,7 @@ If ``true`` a right mouse button click can select items. The amount of columns. - .. _class_Tree_drop_mode_flags: +.. _class_Tree_drop_mode_flags: - :ref:`int` **drop_mode_flags** @@ -344,7 +344,7 @@ The amount of columns. The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once dropping is done, reverts to ``DROP_MODE_DISABLED``. Setting this during :ref:`can_drop_data` is recommended. - .. _class_Tree_hide_folding: +.. _class_Tree_hide_folding: - :ref:`bool` **hide_folding** @@ -356,7 +356,7 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once If ``true`` the folding arrow is hidden. - .. _class_Tree_hide_root: +.. _class_Tree_hide_root: - :ref:`bool` **hide_root** @@ -368,7 +368,7 @@ If ``true`` the folding arrow is hidden. If ``true`` the tree's root is hidden. - .. _class_Tree_select_mode: +.. _class_Tree_select_mode: - :ref:`SelectMode` **select_mode** @@ -383,55 +383,55 @@ Allow single or multiple selection. See the ``SELECT_*`` constants. Method Descriptions ------------------- - .. _class_Tree_are_column_titles_visible: +.. _class_Tree_are_column_titles_visible: - :ref:`bool` **are_column_titles_visible** **(** **)** const Returns ``true`` if the column titles are being shown. - .. _class_Tree_clear: +.. _class_Tree_clear: - void **clear** **(** **)** Clears the tree. This removes all items. - .. _class_Tree_create_item: +.. _class_Tree_create_item: - :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. - .. _class_Tree_ensure_cursor_is_visible: +.. _class_Tree_ensure_cursor_is_visible: - void **ensure_cursor_is_visible** **(** **)** Makes the currently selected item visible. This will scroll the tree to make sure the selected item is visible. - .. _class_Tree_get_column_at_position: +.. _class_Tree_get_column_at_position: - :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Returns the column index under the given point. - .. _class_Tree_get_column_title: +.. _class_Tree_get_column_title: - :ref:`String` **get_column_title** **(** :ref:`int` column **)** const Returns the column's title. - .. _class_Tree_get_column_width: +.. _class_Tree_get_column_width: - :ref:`int` **get_column_width** **(** :ref:`int` column **)** const Returns the column's width in pixels. - .. _class_Tree_get_custom_popup_rect: +.. _class_Tree_get_custom_popup_rect: - :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: +.. _class_Tree_get_drop_section_at_position: - :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const @@ -439,85 +439,85 @@ If :ref:`drop_mode_flags` includes ``DROP_MODE_INBET Otherwise, returns 0. If there are no tree item at ``position``, returns -100. - .. _class_Tree_get_edited: +.. _class_Tree_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const Returns the currently edited item. This is only available for custom cell mode. - .. _class_Tree_get_edited_column: +.. _class_Tree_get_edited_column: - :ref:`int` **get_edited_column** **(** **)** const Returns the column for the currently edited item. This is only available for custom cell mode. - .. _class_Tree_get_item_area_rect: +.. _class_Tree_get_item_area_rect: - :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: +.. _class_Tree_get_item_at_position: - :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: +.. _class_Tree_get_next_selected: - :ref:`TreeItem` **get_next_selected** **(** :ref:`Object` from **)** Returns the next selected item after the given one. - .. _class_Tree_get_pressed_button: +.. _class_Tree_get_pressed_button: - :ref:`int` **get_pressed_button** **(** **)** const Returns the last pressed button's index. - .. _class_Tree_get_root: +.. _class_Tree_get_root: - :ref:`TreeItem` **get_root** **(** **)** Returns the tree's root item. - .. _class_Tree_get_scroll: +.. _class_Tree_get_scroll: - :ref:`Vector2` **get_scroll** **(** **)** const Returns the current scrolling position. - .. _class_Tree_get_selected: +.. _class_Tree_get_selected: - :ref:`TreeItem` **get_selected** **(** **)** const Returns the currently selected item. - .. _class_Tree_get_selected_column: +.. _class_Tree_get_selected_column: - :ref:`int` **get_selected_column** **(** **)** const Returns the current selection's column. - .. _class_Tree_set_column_expand: +.. _class_Tree_set_column_expand: - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** If ``true`` the column will have the "Expand" flag of :ref:`Control`. - .. _class_Tree_set_column_min_width: +.. _class_Tree_set_column_min_width: - void **set_column_min_width** **(** :ref:`int` column, :ref:`int` min_width **)** Set the minimum width of a column. - .. _class_Tree_set_column_title: +.. _class_Tree_set_column_title: - void **set_column_title** **(** :ref:`int` column, :ref:`String` title **)** Set the title of a column. - .. _class_Tree_set_column_titles_visible: +.. _class_Tree_set_column_titles_visible: - void **set_column_titles_visible** **(** :ref:`bool` visible **)** diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 58c7de428..5f1194e08 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -143,7 +143,7 @@ Methods Enumerations ------------ - .. _enum_TreeItem_TreeCellMode: +.. _enum_TreeItem_TreeCellMode: enum **TreeCellMode**: @@ -154,7 +154,7 @@ enum **TreeCellMode**: - **CELL_MODE_ICON** = **4** --- Cell contains an icon. - **CELL_MODE_CUSTOM** = **5** - .. _enum_TreeItem_TextAlign: +.. _enum_TreeItem_TextAlign: enum **TextAlign**: @@ -170,7 +170,7 @@ Control for a single item inside a :ref:`Tree`. May have child ``Tre Property Descriptions --------------------- - .. _class_TreeItem_collapsed: +.. _class_TreeItem_collapsed: - :ref:`bool` **collapsed** @@ -182,7 +182,7 @@ Property Descriptions If ``true`` the TreeItem is collapsed. - .. _class_TreeItem_custom_minimum_height: +.. _class_TreeItem_custom_minimum_height: - :ref:`int` **custom_minimum_height** @@ -194,7 +194,7 @@ If ``true`` the TreeItem is collapsed. The custom minimum height. - .. _class_TreeItem_disable_folding: +.. _class_TreeItem_disable_folding: - :ref:`bool` **disable_folding** @@ -209,307 +209,307 @@ If ``true`` folding is disabled for this TreeItem. Method Descriptions ------------------- - .. _class_TreeItem_add_button: +.. _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="" **)** 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: +.. _class_TreeItem_clear_custom_bg_color: - void **clear_custom_bg_color** **(** :ref:`int` column **)** Resets the background color for the given column to default. - .. _class_TreeItem_clear_custom_color: +.. _class_TreeItem_clear_custom_color: - void **clear_custom_color** **(** :ref:`int` column **)** Resets the color for the given column to default. - .. _class_TreeItem_deselect: +.. _class_TreeItem_deselect: - void **deselect** **(** :ref:`int` column **)** Deselects the given column. - .. _class_TreeItem_erase_button: +.. _class_TreeItem_erase_button: - void **erase_button** **(** :ref:`int` column, :ref:`int` button_idx **)** Removes the button at index ``button_idx`` in column ``column``. - .. _class_TreeItem_get_button: +.. _class_TreeItem_get_button: - :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``. - .. _class_TreeItem_get_button_count: +.. _class_TreeItem_get_button_count: - :ref:`int` **get_button_count** **(** :ref:`int` column **)** const Returns the number of buttons in column ``column``. May be used to get the most recently added button's index, if no index was specified. - .. _class_TreeItem_get_cell_mode: +.. _class_TreeItem_get_cell_mode: - :ref:`TreeCellMode` **get_cell_mode** **(** :ref:`int` column **)** const Returns the column's cell mode. See ``CELL_MODE_*`` constants. - .. _class_TreeItem_get_children: +.. _class_TreeItem_get_children: - :ref:`TreeItem` **get_children** **(** **)** Returns the TreeItem's child items. - .. _class_TreeItem_get_custom_bg_color: +.. _class_TreeItem_get_custom_bg_color: - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const Returns the custom background color of column ``column``. - .. _class_TreeItem_get_expand_right: +.. _class_TreeItem_get_expand_right: - :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const Returns ``true`` if ``expand_right`` is set. - .. _class_TreeItem_get_icon: +.. _class_TreeItem_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const Returns the given column's icon :ref:`Texture`. Error if no icon is set. - .. _class_TreeItem_get_icon_max_width: +.. _class_TreeItem_get_icon_max_width: - :ref:`int` **get_icon_max_width** **(** :ref:`int` column **)** const Returns the column's icon's maximum width. - .. _class_TreeItem_get_icon_region: +.. _class_TreeItem_get_icon_region: - :ref:`Rect2` **get_icon_region** **(** :ref:`int` column **)** const Returns the icon :ref:`Texture` region as :ref:`Rect2`. - .. _class_TreeItem_get_metadata: +.. _class_TreeItem_get_metadata: - :ref:`Variant` **get_metadata** **(** :ref:`int` column **)** const - .. _class_TreeItem_get_next: +.. _class_TreeItem_get_next: - :ref:`TreeItem` **get_next** **(** **)** Returns the next TreeItem in the tree. - .. _class_TreeItem_get_next_visible: +.. _class_TreeItem_get_next_visible: - :ref:`TreeItem` **get_next_visible** **(** **)** Returns the next visible TreeItem in the tree. - .. _class_TreeItem_get_parent: +.. _class_TreeItem_get_parent: - :ref:`TreeItem` **get_parent** **(** **)** Returns the parent TreeItem. - .. _class_TreeItem_get_prev: +.. _class_TreeItem_get_prev: - :ref:`TreeItem` **get_prev** **(** **)** Returns the previous TreeItem in the tree. - .. _class_TreeItem_get_prev_visible: +.. _class_TreeItem_get_prev_visible: - :ref:`TreeItem` **get_prev_visible** **(** **)** Returns the previous visible TreeItem in the tree. - .. _class_TreeItem_get_range: +.. _class_TreeItem_get_range: - :ref:`float` **get_range** **(** :ref:`int` column **)** const - .. _class_TreeItem_get_range_config: +.. _class_TreeItem_get_range_config: - :ref:`Dictionary` **get_range_config** **(** :ref:`int` column **)** - .. _class_TreeItem_get_text: +.. _class_TreeItem_get_text: - :ref:`String` **get_text** **(** :ref:`int` column **)** const Returns the given column's text. - .. _class_TreeItem_get_text_align: +.. _class_TreeItem_get_text_align: - :ref:`TextAlign` **get_text_align** **(** :ref:`int` column **)** const Returns the given column's text alignment. - .. _class_TreeItem_get_tooltip: +.. _class_TreeItem_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const Returns the given column's tooltip. - .. _class_TreeItem_is_button_disabled: +.. _class_TreeItem_is_button_disabled: - :ref:`bool` **is_button_disabled** **(** :ref:`int` column, :ref:`int` button_idx **)** const Returns ``true`` if the button at index ``button_idx`` for the given column is disabled. - .. _class_TreeItem_is_checked: +.. _class_TreeItem_is_checked: - :ref:`bool` **is_checked** **(** :ref:`int` column **)** const Returns ``true`` if the given column is checked. - .. _class_TreeItem_is_custom_set_as_button: +.. _class_TreeItem_is_custom_set_as_button: - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const - .. _class_TreeItem_is_editable: +.. _class_TreeItem_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is editable. - .. _class_TreeItem_is_selectable: +.. _class_TreeItem_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const Returns ``true`` if column ``column`` is selectable. - .. _class_TreeItem_is_selected: +.. _class_TreeItem_is_selected: - :ref:`bool` **is_selected** **(** :ref:`int` column **)** Returns ``true`` if column ``column`` is selected. - .. _class_TreeItem_move_to_bottom: +.. _class_TreeItem_move_to_bottom: - void **move_to_bottom** **(** **)** Moves this TreeItem to the bottom in the :ref:`Tree` hierarchy. - .. _class_TreeItem_move_to_top: +.. _class_TreeItem_move_to_top: - void **move_to_top** **(** **)** Moves this TreeItem to the top in the :ref:`Tree` hierarchy. - .. _class_TreeItem_remove_child: +.. _class_TreeItem_remove_child: - void **remove_child** **(** :ref:`Object` child **)** Removes the given child TreeItem. - .. _class_TreeItem_select: +.. _class_TreeItem_select: - void **select** **(** :ref:`int` column **)** Selects the column ``column``. - .. _class_TreeItem_set_button: +.. _class_TreeItem_set_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``. - .. _class_TreeItem_set_cell_mode: +.. _class_TreeItem_set_cell_mode: - void **set_cell_mode** **(** :ref:`int` column, :ref:`TreeCellMode` mode **)** Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. - .. _class_TreeItem_set_checked: +.. _class_TreeItem_set_checked: - void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** If ``true`` the column ``column`` is checked. - .. _class_TreeItem_set_custom_as_button: +.. _class_TreeItem_set_custom_as_button: - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** - .. _class_TreeItem_set_custom_bg_color: +.. _class_TreeItem_set_custom_bg_color: - 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: +.. _class_TreeItem_set_custom_color: - void **set_custom_color** **(** :ref:`int` column, :ref:`Color` color **)** Sets the given column's custom color. - .. _class_TreeItem_set_custom_draw: +.. _class_TreeItem_set_custom_draw: - 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``. - .. _class_TreeItem_set_editable: +.. _class_TreeItem_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** If ``true`` column ``column`` is editable. - .. _class_TreeItem_set_expand_right: +.. _class_TreeItem_set_expand_right: - void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** If ``true`` column ``column`` is expanded to the right. - .. _class_TreeItem_set_icon: +.. _class_TreeItem_set_icon: - void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** Sets the given column's icon :ref:`Texture`. - .. _class_TreeItem_set_icon_max_width: +.. _class_TreeItem_set_icon_max_width: - void **set_icon_max_width** **(** :ref:`int` column, :ref:`int` width **)** Sets the given column's icon's maximum width. - .. _class_TreeItem_set_icon_region: +.. _class_TreeItem_set_icon_region: - void **set_icon_region** **(** :ref:`int` column, :ref:`Rect2` region **)** Sets the given column's icon's texture region. - .. _class_TreeItem_set_metadata: +.. _class_TreeItem_set_metadata: - void **set_metadata** **(** :ref:`int` column, :ref:`Variant` meta **)** - .. _class_TreeItem_set_range: +.. _class_TreeItem_set_range: - void **set_range** **(** :ref:`int` column, :ref:`float` value **)** - .. _class_TreeItem_set_range_config: +.. _class_TreeItem_set_range_config: - void **set_range_config** **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** - .. _class_TreeItem_set_selectable: +.. _class_TreeItem_set_selectable: - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** If ``true`` the given column is selectable. - .. _class_TreeItem_set_text: +.. _class_TreeItem_set_text: - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** - .. _class_TreeItem_set_text_align: +.. _class_TreeItem_set_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: +.. _class_TreeItem_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** diff --git a/classes/class_tween.rst b/classes/class_tween.rst index bf69d6a6d..9fe0f346b 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -79,19 +79,19 @@ Methods Signals ------- - .. _class_Tween_tween_completed: +.. _class_Tween_tween_completed: - **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween ends. - .. _class_Tween_tween_started: +.. _class_Tween_tween_started: - **tween_started** **(** :ref:`Object` object, :ref:`NodePath` key **)** Emitted when a tween starts. - .. _class_Tween_tween_step: +.. _class_Tween_tween_step: - **tween_step** **(** :ref:`Object` object, :ref:`NodePath` key, :ref:`float` elapsed, :ref:`Object` value **)** @@ -100,14 +100,14 @@ Emitted at each step of the animation. Enumerations ------------ - .. _enum_Tween_TweenProcessMode: +.. _enum_Tween_TweenProcessMode: enum **TweenProcessMode**: - **TWEEN_PROCESS_PHYSICS** = **0** --- The tween updates with the ``_physics_process`` callback. - **TWEEN_PROCESS_IDLE** = **1** --- The tween updates with the ``_process`` callback. - .. _enum_Tween_EaseType: +.. _enum_Tween_EaseType: enum **EaseType**: @@ -116,7 +116,7 @@ enum **EaseType**: - **EASE_IN_OUT** = **2** --- A combination of EASE_IN and EASE_OUT. The interpolation is slowest at both ends. - **EASE_OUT_IN** = **3** --- A combination of EASE_IN and EASE_OUT. The interpolation is fastest at both ends. - .. _enum_Tween_TransitionType: +.. _enum_Tween_TransitionType: enum **TransitionType**: @@ -154,7 +154,7 @@ Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts a Property Descriptions --------------------- - .. _class_Tween_playback_process_mode: +.. _class_Tween_playback_process_mode: - :ref:`TweenProcessMode` **playback_process_mode** @@ -166,7 +166,7 @@ Property Descriptions The tween's animation process thread. See :ref:`TweenProcessMode`. Default value: :ref:`TWEEN_PROCESS_IDLE`. - .. _class_Tween_playback_speed: +.. _class_Tween_playback_speed: - :ref:`float` **playback_speed** @@ -178,7 +178,7 @@ The tween's animation process thread. See :ref:`TweenProcessMode` or :ref:`stop_all` for this. - .. _class_Tween_repeat: +.. _class_Tween_repeat: - :ref:`bool` **repeat** @@ -193,7 +193,7 @@ If ``true`` the tween loops. Method Descriptions ------------------- - .. _class_Tween_follow_method: +.. _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 **)** @@ -201,7 +201,7 @@ Follows ``method`` of ``object`` and applies the returned value on ``target_meth 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: +.. _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 **)** @@ -209,25 +209,25 @@ Follows ``property`` of ``object`` and applies it on ``target_property`` of ``ta 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: +.. _class_Tween_get_runtime: - :ref:`float` **get_runtime** **(** **)** const Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. - .. _class_Tween_interpolate_callback: +.. _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 **)** Calls ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are arguments to be passed to the callback. - .. _class_Tween_interpolate_deferred_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 **)** 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: +.. _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 **)** @@ -235,7 +235,7 @@ Animates ``method`` of ``object`` from ``initial_val`` to ``final_val`` for ``du 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: +.. _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 **)** @@ -243,79 +243,79 @@ Animates ``property`` of ``object`` from ``initial_val`` to ``final_val`` for `` 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: +.. _class_Tween_is_active: - :ref:`bool` **is_active** **(** **)** const Returns ``true`` if any tweens are currently running. Note that this method doesn't consider tweens that have ended. - .. _class_Tween_remove: +.. _class_Tween_remove: - :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. - .. _class_Tween_remove_all: +.. _class_Tween_remove_all: - :ref:`bool` **remove_all** **(** **)** Stops animation and removes all tweens. - .. _class_Tween_reset: +.. _class_Tween_reset: - :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. - .. _class_Tween_reset_all: +.. _class_Tween_reset_all: - :ref:`bool` **reset_all** **(** **)** Resets all tweens to their initial values (the ones given, not those before the tween). - .. _class_Tween_resume: +.. _class_Tween_resume: - :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. - .. _class_Tween_resume_all: +.. _class_Tween_resume_all: - :ref:`bool` **resume_all** **(** **)** Continues animating all stopped tweens. - .. _class_Tween_seek: +.. _class_Tween_seek: - :ref:`bool` **seek** **(** :ref:`float` time **)** Sets the interpolation to the given ``time`` in seconds. - .. _class_Tween_set_active: +.. _class_Tween_set_active: - void **set_active** **(** :ref:`bool` active **)** Activates/deactivates the tween. See also :ref:`stop_all` and :ref:`resume_all`. - .. _class_Tween_start: +.. _class_Tween_start: - :ref:`bool` **start** **(** **)** Starts the tween. You can define animations both before and after this. - .. _class_Tween_stop: +.. _class_Tween_stop: - :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. - .. _class_Tween_stop_all: +.. _class_Tween_stop_all: - :ref:`bool` **stop_all** **(** **)** Stops animating all tweens. - .. _class_Tween_targeting_method: +.. _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 **)** @@ -323,7 +323,7 @@ Animates ``method`` of ``object`` from the value returned by ``initial_method`` 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: +.. _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 **)** @@ -331,7 +331,7 @@ Animates ``property`` of ``object`` from the current value of the ``initial_val` 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: +.. _class_Tween_tell: - :ref:`float` **tell** **(** **)** const diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 42a2e2253..a3e3c1b0f 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -50,7 +50,7 @@ Methods Enumerations ------------ - .. _enum_UndoRedo_MergeMode: +.. _enum_UndoRedo_MergeMode: enum **MergeMode**: @@ -93,67 +93,67 @@ If you don't need to register a method you can leave :ref:`add_do_method` **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: +.. _class_UndoRedo_add_do_property: - void **add_do_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'do'. - .. _class_UndoRedo_add_do_reference: +.. _class_UndoRedo_add_do_reference: - void **add_do_reference** **(** :ref:`Object` object **)** 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: +.. _class_UndoRedo_add_undo_method: - :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: +.. _class_UndoRedo_add_undo_property: - void **add_undo_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** Register a property value change for 'undo'. - .. _class_UndoRedo_add_undo_reference: +.. _class_UndoRedo_add_undo_reference: - void **add_undo_reference** **(** :ref:`Object` object **)** 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: +.. _class_UndoRedo_clear_history: - void **clear_history** **(** **)** Clear the undo/redo history and associated references. - .. _class_UndoRedo_commit_action: +.. _class_UndoRedo_commit_action: - void **commit_action** **(** **)** Commit the action. All 'do' methods/properties are called/set when this function is called. - .. _class_UndoRedo_create_action: +.. _class_UndoRedo_create_action: - 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`, then commit the action with :ref:`commit_action`. - .. _class_UndoRedo_get_current_action_name: +.. _class_UndoRedo_get_current_action_name: - :ref:`String` **get_current_action_name** **(** **)** const Get the name of the current action. - .. _class_UndoRedo_get_version: +.. _class_UndoRedo_get_version: - :ref:`int` **get_version** **(** **)** const @@ -161,13 +161,13 @@ Get the version, each time a new action is committed, the version number of the This is useful mostly to check if something changed from a saved version. - .. _class_UndoRedo_redo: +.. _class_UndoRedo_redo: - :ref:`bool` **redo** **(** **)** Redo last action. - .. _class_UndoRedo_undo: +.. _class_UndoRedo_undo: - :ref:`bool` **undo** **(** **)** diff --git a/classes/class_upnp.rst b/classes/class_upnp.rst index 1308392b4..d67fdd212 100644 --- a/classes/class_upnp.rst +++ b/classes/class_upnp.rst @@ -57,7 +57,7 @@ Methods Enumerations ------------ - .. _enum_UPNP_UPNPResult: +.. _enum_UPNP_UPNPResult: enum **UPNPResult**: @@ -99,7 +99,7 @@ Provides UPNP functionality to discover :ref:`UPNPDevice`\ s o Property Descriptions --------------------- - .. _class_UPNP_discover_ipv6: +.. _class_UPNP_discover_ipv6: - :ref:`bool` **discover_ipv6** @@ -111,7 +111,7 @@ Property Descriptions If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. - .. _class_UPNP_discover_local_port: +.. _class_UPNP_discover_local_port: - :ref:`int` **discover_local_port** @@ -123,7 +123,7 @@ If ``true``, IPv6 is used for :ref:`UPNPDevice` discovery. 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: +.. _class_UPNP_discover_multicast_if: - :ref:`String` **discover_multicast_if** @@ -138,13 +138,13 @@ Multicast interface to use for discovery. Uses the default multicast interface i Method Descriptions ------------------- - .. _class_UPNP_add_device: +.. _class_UPNP_add_device: - void **add_device** **(** :ref:`UPNPDevice` device **)** Adds the given :ref:`UPNPDevice` to the list of discovered devices. - .. _class_UPNP_add_port_mapping: +.. _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 @@ -156,19 +156,19 @@ The description (``desc``) is shown in some router UIs and can be used to point See :ref:`UPNPResult` for possible return values. - .. _class_UPNP_clear_devices: +.. _class_UPNP_clear_devices: - void **clear_devices** **(** **)** Clears the list of discovered devices. - .. _class_UPNP_delete_port_mapping: +.. _class_UPNP_delete_port_mapping: - :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. - .. _class_UPNP_discover: +.. _class_UPNP_discover: - :ref:`int` **discover** **(** :ref:`int` timeout=2000, :ref:`int` ttl=2, :ref:`String` device_filter="InternetGatewayDevice" **)** @@ -178,37 +178,37 @@ Filters for IGD (InternetGatewayDevice) type devices by default, as those manage See :ref:`UPNPResult` for possible return values. - .. _class_UPNP_get_device: +.. _class_UPNP_get_device: - :ref:`UPNPDevice` **get_device** **(** :ref:`int` index **)** const Returns the :ref:`UPNPDevice` at the given ``index``. - .. _class_UPNP_get_device_count: +.. _class_UPNP_get_device_count: - :ref:`int` **get_device_count** **(** **)** const Returns the number of discovered :ref:`UPNPDevice`\ s. - .. _class_UPNP_get_gateway: +.. _class_UPNP_get_gateway: - :ref:`UPNPDevice` **get_gateway** **(** **)** const Returns the default gateway. That is the first discovered :ref:`UPNPDevice` that is also a valid IGD (InternetGatewayDevice). - .. _class_UPNP_query_external_address: +.. _class_UPNP_query_external_address: - :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. - .. _class_UPNP_remove_device: +.. _class_UPNP_remove_device: - void **remove_device** **(** :ref:`int` index **)** Removes the device at ``index`` from the list of discovered devices. - .. _class_UPNP_set_device: +.. _class_UPNP_set_device: - void **set_device** **(** :ref:`int` index, :ref:`UPNPDevice` device **)** diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 6ed8fc99d..4f9a955da 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -49,7 +49,7 @@ Methods Enumerations ------------ - .. _enum_UPNPDevice_IGDStatus: +.. _enum_UPNPDevice_IGDStatus: enum **IGDStatus**: @@ -72,7 +72,7 @@ UPNP device. See :ref:`UPNP` for UPNP discovery and utility function Property Descriptions --------------------- - .. _class_UPNPDevice_description_url: +.. _class_UPNPDevice_description_url: - :ref:`String` **description_url** @@ -84,7 +84,7 @@ Property Descriptions URL to the device description. - .. _class_UPNPDevice_igd_control_url: +.. _class_UPNPDevice_igd_control_url: - :ref:`String` **igd_control_url** @@ -96,7 +96,7 @@ URL to the device description. IDG control URL. - .. _class_UPNPDevice_igd_our_addr: +.. _class_UPNPDevice_igd_our_addr: - :ref:`String` **igd_our_addr** @@ -108,7 +108,7 @@ IDG control URL. Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. - .. _class_UPNPDevice_igd_service_type: +.. _class_UPNPDevice_igd_service_type: - :ref:`String` **igd_service_type** @@ -120,7 +120,7 @@ Address of the local machine in the network connecting it to this :ref:`UPNPDevi IGD service type. - .. _class_UPNPDevice_igd_status: +.. _class_UPNPDevice_igd_status: - :ref:`IGDStatus` **igd_status** @@ -132,7 +132,7 @@ IGD service type. IGD status. See :ref:`IGDStatus`. - .. _class_UPNPDevice_service_type: +.. _class_UPNPDevice_service_type: - :ref:`String` **service_type** @@ -147,25 +147,25 @@ Service type. Method Descriptions ------------------- - .. _class_UPNPDevice_add_port_mapping: +.. _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 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: +.. _class_UPNPDevice_delete_port_mapping: - :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`. - .. _class_UPNPDevice_is_valid_gateway: +.. _class_UPNPDevice_is_valid_gateway: - :ref:`bool` **is_valid_gateway** **(** **)** const Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. - .. _class_UPNPDevice_query_external_address: +.. _class_UPNPDevice_query_external_address: - :ref:`String` **query_external_address** **(** **)** const diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index c6c96bfc4..67dbc64c6 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -93,6 +93,7 @@ Constants - **RIGHT** = **Vector2( 1, 0 )** --- Right unit vector. - **UP** = **Vector2( 0, -1 )** --- Up unit vector. - **DOWN** = **Vector2( 0, 1 )** --- Down unit vector. + Description ----------- @@ -102,16 +103,17 @@ Tutorials --------- - :doc:`../tutorials/math/index` + Property Descriptions --------------------- - .. _class_Vector2_x: +.. _class_Vector2_x: - :ref:`float` **x** The vector's x component. - .. _class_Vector2_y: +.. _class_Vector2_y: - :ref:`float` **y** @@ -120,19 +122,19 @@ The vector's y component. Method Descriptions ------------------- - .. _class_Vector2_Vector2: +.. _class_Vector2_Vector2: - :ref:`Vector2` **Vector2** **(** :ref:`float` x, :ref:`float` y **)** Constructs a new Vector2 from the given x and y. - .. _class_Vector2_abs: +.. _class_Vector2_abs: - :ref:`Vector2` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). - .. _class_Vector2_angle: +.. _class_Vector2_angle: - :ref:`float` **angle** **(** **)** @@ -140,133 +142,133 @@ Returns the vector's angle in radians with respect to the x-axis, or ``(1, 0)`` Equivalent to the result of atan2 when called with the vector's x and y as parameters: ``atan2(x, y)``. - .. _class_Vector2_angle_to: +.. _class_Vector2_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector2` to **)** Returns the angle in radians between the two vectors. - .. _class_Vector2_angle_to_point: +.. _class_Vector2_angle_to_point: - :ref:`float` **angle_to_point** **(** :ref:`Vector2` to **)** Returns the angle in radians between the line connecting the two points and the x coordinate. - .. _class_Vector2_aspect: +.. _class_Vector2_aspect: - :ref:`float` **aspect** **(** **)** Returns the ratio of x to y. - .. _class_Vector2_bounce: +.. _class_Vector2_bounce: - :ref:`Vector2` **bounce** **(** :ref:`Vector2` n **)** Returns the vector "bounced off" from a plane defined by the given normal. - .. _class_Vector2_ceil: +.. _class_Vector2_ceil: - :ref:`Vector2` **ceil** **(** **)** Returns the vector with all components rounded up. - .. _class_Vector2_clamped: +.. _class_Vector2_clamped: - :ref:`Vector2` **clamped** **(** :ref:`float` length **)** Returns the vector with a maximum length. - .. _class_Vector2_cross: +.. _class_Vector2_cross: - :ref:`float` **cross** **(** :ref:`Vector2` with **)** Returns the 2 dimensional analog of the cross product with the given vector. - .. _class_Vector2_cubic_interpolate: +.. _class_Vector2_cubic_interpolate: - :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``, representing the amount of interpolation. - .. _class_Vector2_distance_squared_to: +.. _class_Vector2_distance_squared_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: +.. _class_Vector2_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector2` to **)** Returns the distance to vector ``b``. - .. _class_Vector2_dot: +.. _class_Vector2_dot: - :ref:`float` **dot** **(** :ref:`Vector2` with **)** Returns the dot product with vector ``b``. - .. _class_Vector2_floor: +.. _class_Vector2_floor: - :ref:`Vector2` **floor** **(** **)** Returns the vector with all components rounded down. - .. _class_Vector2_is_normalized: +.. _class_Vector2_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. - .. _class_Vector2_length: +.. _class_Vector2_length: - :ref:`float` **length** **(** **)** Returns the vector's length. - .. _class_Vector2_length_squared: +.. _class_Vector2_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. - .. _class_Vector2_linear_interpolate: +.. _class_Vector2_linear_interpolate: - :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``, representing the amount of interpolation. - .. _class_Vector2_normalized: +.. _class_Vector2_normalized: - :ref:`Vector2` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. - .. _class_Vector2_project: +.. _class_Vector2_project: - :ref:`Vector2` **project** **(** :ref:`Vector2` b **)** Returns the vector projected onto the vector ``b``. - .. _class_Vector2_reflect: +.. _class_Vector2_reflect: - :ref:`Vector2` **reflect** **(** :ref:`Vector2` n **)** Returns the vector reflected from a plane defined by the given normal. - .. _class_Vector2_rotated: +.. _class_Vector2_rotated: - :ref:`Vector2` **rotated** **(** :ref:`float` phi **)** Returns the vector rotated by ``phi`` radians. - .. _class_Vector2_round: +.. _class_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: +.. _class_Vector2_slerp: - :ref:`Vector2` **slerp** **(** :ref:`Vector2` b, :ref:`float` t **)** @@ -274,19 +276,19 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. - .. _class_Vector2_slide: +.. _class_Vector2_slide: - :ref:`Vector2` **slide** **(** :ref:`Vector2` n **)** Returns the component of the vector along a plane defined by the given normal. - .. _class_Vector2_snapped: +.. _class_Vector2_snapped: - :ref:`Vector2` **snapped** **(** :ref:`Vector2` by **)** Returns the vector snapped to a grid with the given size. - .. _class_Vector2_tangent: +.. _class_Vector2_tangent: - :ref:`Vector2` **tangent** **(** **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 304406cb6..d997fb33c 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -100,6 +100,7 @@ Constants - **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 ----------- @@ -109,22 +110,23 @@ Tutorials --------- - :doc:`../tutorials/math/index` + Property Descriptions --------------------- - .. _class_Vector3_x: +.. _class_Vector3_x: - :ref:`float` **x** The vector's x component. - .. _class_Vector3_y: +.. _class_Vector3_y: - :ref:`float` **y** The vector's y component. - .. _class_Vector3_z: +.. _class_Vector3_z: - :ref:`float` **z** @@ -133,151 +135,151 @@ The vector's z component. Method Descriptions ------------------- - .. _class_Vector3_Vector3: +.. _class_Vector3_Vector3: - :ref:`Vector3` **Vector3** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z **)** Returns a Vector3 with the given components. - .. _class_Vector3_abs: +.. _class_Vector3_abs: - :ref:`Vector3` **abs** **(** **)** Returns a new vector with all components in absolute values (i.e. positive). - .. _class_Vector3_angle_to: +.. _class_Vector3_angle_to: - :ref:`float` **angle_to** **(** :ref:`Vector3` to **)** Returns the minimum angle to the given vector. - .. _class_Vector3_bounce: +.. _class_Vector3_bounce: - :ref:`Vector3` **bounce** **(** :ref:`Vector3` n **)** Returns the vector "bounced off" from a plane defined by the given normal. - .. _class_Vector3_ceil: +.. _class_Vector3_ceil: - :ref:`Vector3` **ceil** **(** **)** Returns a new vector with all components rounded up. - .. _class_Vector3_cross: +.. _class_Vector3_cross: - :ref:`Vector3` **cross** **(** :ref:`Vector3` b **)** Returns the cross product with ``b``. - .. _class_Vector3_cubic_interpolate: +.. _class_Vector3_cubic_interpolate: - :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`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. - .. _class_Vector3_distance_squared_to: +.. _class_Vector3_distance_squared_to: - :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: +.. _class_Vector3_distance_to: - :ref:`float` **distance_to** **(** :ref:`Vector3` b **)** Returns the distance to ``b``. - .. _class_Vector3_dot: +.. _class_Vector3_dot: - :ref:`float` **dot** **(** :ref:`Vector3` b **)** Returns the dot product with ``b``. - .. _class_Vector3_floor: +.. _class_Vector3_floor: - :ref:`Vector3` **floor** **(** **)** Returns a new vector with all components rounded down. - .. _class_Vector3_inverse: +.. _class_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 )``. - .. _class_Vector3_is_normalized: +.. _class_Vector3_is_normalized: - :ref:`bool` **is_normalized** **(** **)** Returns ``true`` if the vector is normalized. - .. _class_Vector3_length: +.. _class_Vector3_length: - :ref:`float` **length** **(** **)** Returns the vector's length. - .. _class_Vector3_length_squared: +.. _class_Vector3_length_squared: - :ref:`float` **length_squared** **(** **)** Returns the vector's length squared. Prefer this function over :ref:`length` if you need to sort vectors or need the squared length for some formula. - .. _class_Vector3_linear_interpolate: +.. _class_Vector3_linear_interpolate: - :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``, representing the amount of interpolation.. - .. _class_Vector3_max_axis: +.. _class_Vector3_max_axis: - :ref:`int` **max_axis** **(** **)** Returns the axis of the vector's largest value. See ``AXIS_*`` constants. - .. _class_Vector3_min_axis: +.. _class_Vector3_min_axis: - :ref:`int` **min_axis** **(** **)** Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. - .. _class_Vector3_normalized: +.. _class_Vector3_normalized: - :ref:`Vector3` **normalized** **(** **)** Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. - .. _class_Vector3_outer: +.. _class_Vector3_outer: - :ref:`Basis` **outer** **(** :ref:`Vector3` b **)** Returns the outer product with ``b``. - .. _class_Vector3_project: +.. _class_Vector3_project: - :ref:`Vector3` **project** **(** :ref:`Vector3` b **)** Returns the vector projected onto the vector ``b``. - .. _class_Vector3_reflect: +.. _class_Vector3_reflect: - :ref:`Vector3` **reflect** **(** :ref:`Vector3` n **)** Returns the vector reflected from a plane defined by the given normal. - .. _class_Vector3_rotated: +.. _class_Vector3_rotated: - :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: +.. _class_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: +.. _class_Vector3_slerp: - :ref:`Vector3` **slerp** **(** :ref:`Vector3` b, :ref:`float` t **)** @@ -285,19 +287,19 @@ Returns the result of SLERP between this vector and ``b``, by amount ``t``. ``t` Both vectors need to be normalized. - .. _class_Vector3_slide: +.. _class_Vector3_slide: - :ref:`Vector3` **slide** **(** :ref:`Vector3` n **)** Returns the component of the vector along a plane defined by the given normal. - .. _class_Vector3_snapped: +.. _class_Vector3_snapped: - :ref:`Vector3` **snapped** **(** :ref:`Vector3` by **)** Returns a copy of the vector, snapped to the lowest neared multiple. - .. _class_Vector3_to_diagonal_matrix: +.. _class_Vector3_to_diagonal_matrix: - :ref:`Basis` **to_diagonal_matrix** **(** **)** diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index d469dc8b8..17dab6348 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -37,7 +37,7 @@ Note that the origin point of your VehicleBody will determine the center of grav Property Descriptions --------------------- - .. _class_VehicleBody_brake: +.. _class_VehicleBody_brake: - :ref:`float` **brake** @@ -49,7 +49,7 @@ Property Descriptions Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the :ref:`RigidBody.mass` of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking. - .. _class_VehicleBody_engine_force: +.. _class_VehicleBody_engine_force: - :ref:`float` **engine_force** @@ -63,7 +63,7 @@ Accelerates the vehicle by applying an engine force. The vehicle is only speed u A negative value will result in the vehicle reversing. - .. _class_VehicleBody_steering: +.. _class_VehicleBody_steering: - :ref:`float` **steering** diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 4a7344941..2a10df779 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -60,7 +60,7 @@ This node needs to be used as a child node of :ref:`VehicleBody` **damping_compression** @@ -72,7 +72,7 @@ Property Descriptions The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car. - .. _class_VehicleWheel_damping_relaxation: +.. _class_VehicleWheel_damping_relaxation: - :ref:`float` **damping_relaxation** @@ -84,7 +84,7 @@ The damping applied to the spring when the spring is being compressed. This valu The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the :ref:`damping_compression` property. For a :ref:`damping_compression` value of 0.3, try a relaxation value of 0.5 - .. _class_VehicleWheel_suspension_max_force: +.. _class_VehicleWheel_suspension_max_force: - :ref:`float` **suspension_max_force** @@ -96,7 +96,7 @@ The damping applied to the spring when relaxing. This value should be between 0. 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: +.. _class_VehicleWheel_suspension_stiffness: - :ref:`float` **suspension_stiffness** @@ -108,7 +108,7 @@ The maximum force the spring can resist. This value should be higher than a quar This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car. - .. _class_VehicleWheel_suspension_travel: +.. _class_VehicleWheel_suspension_travel: - :ref:`float` **suspension_travel** @@ -120,7 +120,7 @@ This value defines the stiffness of the suspension. Use a value lower than 50 fo This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car . - .. _class_VehicleWheel_use_as_steering: +.. _class_VehicleWheel_use_as_steering: - :ref:`bool` **use_as_steering** @@ -132,7 +132,7 @@ This is the distance the suspension can travel. As Godot measures are in meters If true this wheel will be turned when the car steers. - .. _class_VehicleWheel_use_as_traction: +.. _class_VehicleWheel_use_as_traction: - :ref:`bool` **use_as_traction** @@ -144,7 +144,7 @@ If true this wheel will be turned when the car steers. If true this wheel transfers engine force to the ground to propel the vehicle forward. - .. _class_VehicleWheel_wheel_friction_slip: +.. _class_VehicleWheel_wheel_friction_slip: - :ref:`float` **wheel_friction_slip** @@ -158,7 +158,7 @@ This determines how much grip this wheel has. It is combined with the friction s It's best to set this to 1.0 when starting out. - .. _class_VehicleWheel_wheel_radius: +.. _class_VehicleWheel_wheel_radius: - :ref:`float` **wheel_radius** @@ -170,7 +170,7 @@ It's best to set this to 1.0 when starting out. The radius of the wheel in meters. - .. _class_VehicleWheel_wheel_rest_length: +.. _class_VehicleWheel_wheel_rest_length: - :ref:`float` **wheel_rest_length** @@ -182,7 +182,7 @@ The radius of the wheel in meters. This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest. - .. _class_VehicleWheel_wheel_roll_influence: +.. _class_VehicleWheel_wheel_roll_influence: - :ref:`float` **wheel_roll_influence** @@ -197,13 +197,13 @@ This value effects the roll of your vehicle. If set to 0.0 for all wheels your v Method Descriptions ------------------- - .. _class_VehicleWheel_get_skidinfo: +.. _class_VehicleWheel_get_skidinfo: - :ref:`float` **get_skidinfo** **(** **)** const Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is not skidding, 1.0 means the wheel has lost grip. - .. _class_VehicleWheel_is_in_contact: +.. _class_VehicleWheel_is_in_contact: - :ref:`bool` **is_in_contact** **(** **)** const diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index ecb396837..0dc3d3517 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -59,7 +59,7 @@ Methods Signals ------- - .. _class_VideoPlayer_finished: +.. _class_VideoPlayer_finished: - **finished** **(** **)** @@ -73,7 +73,7 @@ Control node for playing video streams. Supported formats are WebM and OGV Theor Property Descriptions --------------------- - .. _class_VideoPlayer_audio_track: +.. _class_VideoPlayer_audio_track: - :ref:`int` **audio_track** @@ -85,7 +85,7 @@ Property Descriptions The embedded audio track to play. - .. _class_VideoPlayer_autoplay: +.. _class_VideoPlayer_autoplay: - :ref:`bool` **autoplay** @@ -97,7 +97,7 @@ The embedded audio track to play. If ``true`` playback starts when the scene loads. Default value: ``false``. - .. _class_VideoPlayer_buffering_msec: +.. _class_VideoPlayer_buffering_msec: - :ref:`int` **buffering_msec** @@ -109,7 +109,7 @@ If ``true`` playback starts when the scene loads. Default value: ``false``. Amount of time in milliseconds to store in buffer while playing. - .. _class_VideoPlayer_bus: +.. _class_VideoPlayer_bus: - :ref:`String` **bus** @@ -121,7 +121,7 @@ Amount of time in milliseconds to store in buffer while playing. Audio bus to use for sound playback. - .. _class_VideoPlayer_expand: +.. _class_VideoPlayer_expand: - :ref:`bool` **expand** @@ -133,7 +133,7 @@ Audio bus to use for sound playback. If ``true`` the video scales to the control size. Default value: ``true``. - .. _class_VideoPlayer_paused: +.. _class_VideoPlayer_paused: - :ref:`bool` **paused** @@ -145,7 +145,7 @@ If ``true`` the video scales to the control size. Default value: ``true``. If ``true`` the video is paused. - .. _class_VideoPlayer_stream: +.. _class_VideoPlayer_stream: - :ref:`VideoStream` **stream** @@ -155,7 +155,7 @@ If ``true`` the video is paused. | *Getter* | get_stream() | +----------+-------------------+ - .. _class_VideoPlayer_stream_position: +.. _class_VideoPlayer_stream_position: - :ref:`float` **stream_position** @@ -167,7 +167,7 @@ If ``true`` the video is paused. The current position of the stream, in seconds. - .. _class_VideoPlayer_volume: +.. _class_VideoPlayer_volume: - :ref:`float` **volume** @@ -179,7 +179,7 @@ The current position of the stream, in seconds. Audio volume as a linear value. - .. _class_VideoPlayer_volume_db: +.. _class_VideoPlayer_volume_db: - :ref:`float` **volume_db** @@ -194,31 +194,31 @@ Audio volume in dB. Method Descriptions ------------------- - .. _class_VideoPlayer_get_stream_name: +.. _class_VideoPlayer_get_stream_name: - :ref:`String` **get_stream_name** **(** **)** const Returns the video stream's name. - .. _class_VideoPlayer_get_video_texture: +.. _class_VideoPlayer_get_video_texture: - :ref:`Texture` **get_video_texture** **(** **)** Returns the current frame as a :ref:`Texture`. - .. _class_VideoPlayer_is_playing: +.. _class_VideoPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const Returns ``true`` if the video is playing. - .. _class_VideoPlayer_play: +.. _class_VideoPlayer_play: - void **play** **(** **)** Starts the video playback. - .. _class_VideoPlayer_stop: +.. _class_VideoPlayer_stop: - void **stop** **(** **)** diff --git a/classes/class_videostreamtheora.rst b/classes/class_videostreamtheora.rst index b51f42cb6..3ee874a4e 100644 --- a/classes/class_videostreamtheora.rst +++ b/classes/class_videostreamtheora.rst @@ -28,11 +28,11 @@ Methods Method Descriptions ------------------- - .. _class_VideoStreamTheora_get_file: +.. _class_VideoStreamTheora_get_file: - :ref:`String` **get_file** **(** **)** - .. _class_VideoStreamTheora_set_file: +.. _class_VideoStreamTheora_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_videostreamwebm.rst b/classes/class_videostreamwebm.rst index 5a9283e61..118901739 100644 --- a/classes/class_videostreamwebm.rst +++ b/classes/class_videostreamwebm.rst @@ -28,11 +28,11 @@ Methods Method Descriptions ------------------- - .. _class_VideoStreamWebm_get_file: +.. _class_VideoStreamWebm_get_file: - :ref:`String` **get_file** **(** **)** - .. _class_VideoStreamWebm_set_file: +.. _class_VideoStreamWebm_set_file: - void **set_file** **(** :ref:`String` file **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index dcace3d56..51d5c3ba0 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -129,7 +129,7 @@ Methods Signals ------- - .. _class_Viewport_size_changed: +.. _class_Viewport_size_changed: - **size_changed** **(** **)** @@ -138,7 +138,7 @@ Emitted when the size of the viewport is changed, whether by :ref:`set_size_over Enumerations ------------ - .. _enum_Viewport_UpdateMode: +.. _enum_Viewport_UpdateMode: enum **UpdateMode**: @@ -147,7 +147,7 @@ enum **UpdateMode**: - **UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value. - **UPDATE_ALWAYS** = **3** --- Always update the render target. - .. _enum_Viewport_RenderInfo: +.. _enum_Viewport_RenderInfo: enum **RenderInfo**: @@ -159,7 +159,7 @@ enum **RenderInfo**: - **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** --- Amount of draw calls in frame. - **RENDER_INFO_MAX** = **6** --- Enum limiter. Do not use it directly. - .. _enum_Viewport_MSAA: +.. _enum_Viewport_MSAA: enum **MSAA**: @@ -169,7 +169,7 @@ enum **MSAA**: - **MSAA_8X** = **3** - **MSAA_16X** = **4** - .. _enum_Viewport_ClearMode: +.. _enum_Viewport_ClearMode: enum **ClearMode**: @@ -177,7 +177,7 @@ enum **ClearMode**: - **CLEAR_MODE_NEVER** = **1** --- Never clear the render target. - **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** --- Clear the render target next frame, then switch to ``CLEAR_MODE_NEVER``. - .. _enum_Viewport_Usage: +.. _enum_Viewport_Usage: enum **Usage**: @@ -186,7 +186,7 @@ enum **Usage**: - **USAGE_3D** = **2** - **USAGE_3D_NO_EFFECTS** = **3** - .. _enum_Viewport_DebugDraw: +.. _enum_Viewport_DebugDraw: enum **DebugDraw**: @@ -195,7 +195,7 @@ enum **DebugDraw**: - **DEBUG_DRAW_OVERDRAW** = **2** --- Objected are displayed semi-transparent with additive blending so you can see where they intersect. - **DEBUG_DRAW_WIREFRAME** = **3** --- Objects are displayed in wireframe style. - .. _enum_Viewport_ShadowAtlasQuadrantSubdiv: +.. _enum_Viewport_ShadowAtlasQuadrantSubdiv: enum **ShadowAtlasQuadrantSubdiv**: @@ -227,11 +227,13 @@ Tutorials --------- - :doc:`../tutorials/2d/2d_transforms` + - :doc:`../tutorials/viewports/index` + Property Descriptions --------------------- - .. _class_Viewport_arvr: +.. _class_Viewport_arvr: - :ref:`bool` **arvr** @@ -243,7 +245,7 @@ Property Descriptions If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. - .. _class_Viewport_audio_listener_enable_2d: +.. _class_Viewport_audio_listener_enable_2d: - :ref:`bool` **audio_listener_enable_2d** @@ -255,7 +257,7 @@ If ``true`` the viewport will be used in AR/VR process. Default value: ``false`` If ``true`` the viewport will process 2D audio streams. Default value: ``false``. - .. _class_Viewport_audio_listener_enable_3d: +.. _class_Viewport_audio_listener_enable_3d: - :ref:`bool` **audio_listener_enable_3d** @@ -267,7 +269,7 @@ If ``true`` the viewport will process 2D audio streams. Default value: ``false`` If ``true`` the viewport will process 3D audio streams. Default value: ``false``. - .. _class_Viewport_canvas_transform: +.. _class_Viewport_canvas_transform: - :ref:`Transform2D` **canvas_transform** @@ -279,7 +281,7 @@ If ``true`` the viewport will process 3D audio streams. Default value: ``false`` 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: +.. _class_Viewport_debug_draw: - :ref:`DebugDraw` **debug_draw** @@ -291,7 +293,7 @@ The canvas transform of the viewport, useful for changing the on-screen position The overlay mode for test rendered geometry in debug purposes. Default value: ``DEBUG_DRAW_DISABLED``. - .. _class_Viewport_disable_3d: +.. _class_Viewport_disable_3d: - :ref:`bool` **disable_3d** @@ -303,7 +305,7 @@ The overlay mode for test rendered geometry in debug purposes. Default value: `` If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. - .. _class_Viewport_global_canvas_transform: +.. _class_Viewport_global_canvas_transform: - :ref:`Transform2D` **global_canvas_transform** @@ -315,7 +317,7 @@ If ``true`` the viewport will disable 3D rendering. For actual disabling use ``u The global canvas transform of the viewport. The canvas transform is relative to this. - .. _class_Viewport_gui_disable_input: +.. _class_Viewport_gui_disable_input: - :ref:`bool` **gui_disable_input** @@ -327,7 +329,7 @@ The global canvas transform of the viewport. The canvas transform is relative to If ``true`` the viewport will not receive input event. Default value: ``false``. - .. _class_Viewport_gui_snap_controls_to_pixels: +.. _class_Viewport_gui_snap_controls_to_pixels: - :ref:`bool` **gui_snap_controls_to_pixels** @@ -339,7 +341,7 @@ If ``true`` the viewport will not receive input event. Default value: ``false``. If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. - .. _class_Viewport_hdr: +.. _class_Viewport_hdr: - :ref:`bool` **hdr** @@ -351,7 +353,7 @@ If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default v If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. - .. _class_Viewport_keep_3d_linear: +.. _class_Viewport_keep_3d_linear: - :ref:`bool` **keep_3d_linear** @@ -363,7 +365,7 @@ If ``true`` the viewport rendering will receive benefits from High Dynamic Range 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: +.. _class_Viewport_msaa: - :ref:`MSAA` **msaa** @@ -375,7 +377,7 @@ If ``true`` the result after 3D rendering will not have a linear to sRGB color c The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. - .. _class_Viewport_own_world: +.. _class_Viewport_own_world: - :ref:`bool` **own_world** @@ -387,7 +389,7 @@ The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. - .. _class_Viewport_physics_object_picking: +.. _class_Viewport_physics_object_picking: - :ref:`bool` **physics_object_picking** @@ -399,7 +401,7 @@ If ``true`` the viewport will use :ref:`World` defined in ``world`` If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. - .. _class_Viewport_render_target_clear_mode: +.. _class_Viewport_render_target_clear_mode: - :ref:`ClearMode` **render_target_clear_mode** @@ -411,7 +413,7 @@ If ``true`` the objects rendered by viewport become subjects of mouse picking pr The clear mode when viewport used as a render target. Default value: ``CLEAR_MODE_ALWAYS``. - .. _class_Viewport_render_target_update_mode: +.. _class_Viewport_render_target_update_mode: - :ref:`UpdateMode` **render_target_update_mode** @@ -423,7 +425,7 @@ The clear mode when viewport used as a render target. Default value: ``CLEAR_MOD The update mode when viewport used as a render target. Default value: ``UPDATE_WHEN_VISIBLE``. - .. _class_Viewport_render_target_v_flip: +.. _class_Viewport_render_target_v_flip: - :ref:`bool` **render_target_v_flip** @@ -435,7 +437,7 @@ The update mode when viewport used as a render target. Default value: ``UPDATE_W If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. - .. _class_Viewport_shadow_atlas_quad_0: +.. _class_Viewport_shadow_atlas_quad_0: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_0** @@ -447,7 +449,7 @@ If ``true`` the result of rendering will be flipped vertically. Default value: ` The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. - .. _class_Viewport_shadow_atlas_quad_1: +.. _class_Viewport_shadow_atlas_quad_1: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_1** @@ -459,7 +461,7 @@ The subdivision amount of first quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of second quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_4``. - .. _class_Viewport_shadow_atlas_quad_2: +.. _class_Viewport_shadow_atlas_quad_2: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_2** @@ -471,7 +473,7 @@ The subdivision amount of second quadrant on shadow atlas. Default value: ``SHAD The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_16``. - .. _class_Viewport_shadow_atlas_quad_3: +.. _class_Viewport_shadow_atlas_quad_3: - :ref:`ShadowAtlasQuadrantSubdiv` **shadow_atlas_quad_3** @@ -483,7 +485,7 @@ The subdivision amount of third quadrant on shadow atlas. Default value: ``SHADO The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHADOW_ATLAS_QUADRANT_SUBDIV_64``. - .. _class_Viewport_shadow_atlas_size: +.. _class_Viewport_shadow_atlas_size: - :ref:`int` **shadow_atlas_size** @@ -495,7 +497,7 @@ The subdivision amount of fourth quadrant on shadow atlas. Default value: ``SHAD The resolution of shadow atlas. Both width and height is equal to one value. - .. _class_Viewport_size: +.. _class_Viewport_size: - :ref:`Vector2` **size** @@ -507,7 +509,7 @@ The resolution of shadow atlas. Both width and height is equal to one value. The width and height of viewport. - .. _class_Viewport_transparent_bg: +.. _class_Viewport_transparent_bg: - :ref:`bool` **transparent_bg** @@ -519,7 +521,7 @@ The width and height of viewport. If ``true`` the viewport should render its background as transparent. Default value: ``false``. - .. _class_Viewport_usage: +.. _class_Viewport_usage: - :ref:`Usage` **usage** @@ -531,7 +533,7 @@ If ``true`` the viewport should render its background as transparent. Default va The rendering mode of viewport. Default value: ``USAGE_3D``. - .. _class_Viewport_world: +.. _class_Viewport_world: - :ref:`World` **world** @@ -543,7 +545,7 @@ The rendering mode of viewport. Default value: ``USAGE_3D``. The custom :ref:`World` which can be used as 3D environment source. - .. _class_Viewport_world_2d: +.. _class_Viewport_world_2d: - :ref:`World2D` **world_2d** @@ -558,131 +560,131 @@ The custom :ref:`World2D` which can be used as 2D environment sou Method Descriptions ------------------- - .. _class_Viewport_find_world: +.. _class_Viewport_find_world: - :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: +.. _class_Viewport_find_world_2d: - :ref:`World2D` **find_world_2d** **(** **)** const Returns the 2D world of the viewport. - .. _class_Viewport_get_camera: +.. _class_Viewport_get_camera: - :ref:`Camera` **get_camera** **(** **)** const Returns the active 3D camera. - .. _class_Viewport_get_final_transform: +.. _class_Viewport_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const Returns the total transform of the viewport. - .. _class_Viewport_get_modal_stack_top: +.. _class_Viewport_get_modal_stack_top: - :ref:`Control` **get_modal_stack_top** **(** **)** const Returns the topmost modal in the stack. - .. _class_Viewport_get_mouse_position: +.. _class_Viewport_get_mouse_position: - :ref:`Vector2` **get_mouse_position** **(** **)** const Returns the mouse position relative to the viewport. - .. _class_Viewport_get_render_info: +.. _class_Viewport_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns information about the viewport from the rendering pipeline. - .. _class_Viewport_get_size_override: +.. _class_Viewport_get_size_override: - :ref:`Vector2` **get_size_override** **(** **)** const Returns the size override set with :ref:`set_size_override`. - .. _class_Viewport_get_texture: +.. _class_Viewport_get_texture: - :ref:`ViewportTexture` **get_texture** **(** **)** const Returns the viewport's texture. - .. _class_Viewport_get_viewport_rid: +.. _class_Viewport_get_viewport_rid: - :ref:`RID` **get_viewport_rid** **(** **)** const Returns the viewport's RID from the :ref:`VisualServer`. - .. _class_Viewport_get_visible_rect: +.. _class_Viewport_get_visible_rect: - :ref:`Rect2` **get_visible_rect** **(** **)** const Returns the visible rectangle in global screen coordinates. - .. _class_Viewport_gui_get_drag_data: +.. _class_Viewport_gui_get_drag_data: - :ref:`Variant` **gui_get_drag_data** **(** **)** const Returns the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data`. - .. _class_Viewport_gui_has_modal_stack: +.. _class_Viewport_gui_has_modal_stack: - :ref:`bool` **gui_has_modal_stack** **(** **)** const Returns ``true`` if there are visible modals on-screen. - .. _class_Viewport_gui_is_dragging: +.. _class_Viewport_gui_is_dragging: - :ref:`bool` **gui_is_dragging** **(** **)** const - .. _class_Viewport_input: +.. _class_Viewport_input: - void **input** **(** :ref:`InputEvent` local_event **)** - .. _class_Viewport_is_size_override_enabled: +.. _class_Viewport_is_size_override_enabled: - :ref:`bool` **is_size_override_enabled** **(** **)** const Returns ``true`` if the size override is enabled. See :ref:`set_size_override`. - .. _class_Viewport_is_size_override_stretch_enabled: +.. _class_Viewport_is_size_override_stretch_enabled: - :ref:`bool` **is_size_override_stretch_enabled** **(** **)** const Returns ``true`` if the size stretch override is enabled. See :ref:`set_size_override_stretch`. - .. _class_Viewport_set_attach_to_screen_rect: +.. _class_Viewport_set_attach_to_screen_rect: - void **set_attach_to_screen_rect** **(** :ref:`Rect2` rect **)** - .. _class_Viewport_set_size_override: +.. _class_Viewport_set_size_override: - 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. - .. _class_Viewport_set_size_override_stretch: +.. _class_Viewport_set_size_override_stretch: - void **set_size_override_stretch** **(** :ref:`bool` enabled **)** If ``true`` the size override affects stretch as well. - .. _class_Viewport_unhandled_input: +.. _class_Viewport_unhandled_input: - void **unhandled_input** **(** :ref:`InputEvent` local_event **)** - .. _class_Viewport_update_worlds: +.. _class_Viewport_update_worlds: - void **update_worlds** **(** **)** Forces update of the 2D and 3D worlds. - .. _class_Viewport_warp_mouse: +.. _class_Viewport_warp_mouse: - void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 509ab787e..09e558479 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -33,7 +33,7 @@ A :ref:`Container` node that holds a :ref:`Viewport` **stretch** @@ -45,7 +45,7 @@ Property Descriptions If ``true`` the viewport will be scaled to the control's size. Default value:``false``. - .. _class_ViewportContainer_stretch_shrink: +.. _class_ViewportContainer_stretch_shrink: - :ref:`int` **stretch_shrink** diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index b47ab66e5..e538b0000 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -33,7 +33,7 @@ To create a ViewportTexture in code, use the :ref:`Viewport.get_texture` **viewport_path** diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index b2cbf40f6..932dd7ebf 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_VisibilityEnabler_Enabler: +.. _enum_VisibilityEnabler_Enabler: enum **Enabler**: @@ -44,7 +44,7 @@ The VisibilityEnabler will disable :ref:`RigidBody` and :ref:`A Property Descriptions --------------------- - .. _class_VisibilityEnabler_freeze_bodies: +.. _class_VisibilityEnabler_freeze_bodies: - :ref:`bool` **freeze_bodies** @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler_pause_animations: +.. _class_VisibilityEnabler_pause_animations: - :ref:`bool` **pause_animations** diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 8d9f5917c..4951c62bb 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -36,7 +36,7 @@ Properties Enumerations ------------ - .. _enum_VisibilityEnabler2D_Enabler: +.. _enum_VisibilityEnabler2D_Enabler: enum **Enabler**: @@ -56,7 +56,7 @@ The VisibilityEnabler2D will disable :ref:`RigidBody2D`, :ref Property Descriptions --------------------- - .. _class_VisibilityEnabler2D_freeze_bodies: +.. _class_VisibilityEnabler2D_freeze_bodies: - :ref:`bool` **freeze_bodies** @@ -66,7 +66,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler2D_pause_animated_sprites: +.. _class_VisibilityEnabler2D_pause_animated_sprites: - :ref:`bool` **pause_animated_sprites** @@ -76,7 +76,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler2D_pause_animations: +.. _class_VisibilityEnabler2D_pause_animations: - :ref:`bool` **pause_animations** @@ -86,7 +86,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler2D_pause_particles: +.. _class_VisibilityEnabler2D_pause_particles: - :ref:`bool` **pause_particles** @@ -96,7 +96,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler2D_physics_process_parent: +.. _class_VisibilityEnabler2D_physics_process_parent: - :ref:`bool` **physics_process_parent** @@ -106,7 +106,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ - .. _class_VisibilityEnabler2D_process_parent: +.. _class_VisibilityEnabler2D_process_parent: - :ref:`bool` **process_parent** diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 480f1fab4..2000fdfa6 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -35,25 +35,25 @@ Methods Signals ------- - .. _class_VisibilityNotifier_camera_entered: +.. _class_VisibilityNotifier_camera_entered: - **camera_entered** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. - .. _class_VisibilityNotifier_camera_exited: +.. _class_VisibilityNotifier_camera_exited: - **camera_exited** **(** :ref:`Camera` camera **)** Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. - .. _class_VisibilityNotifier_screen_entered: +.. _class_VisibilityNotifier_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier enters the screen. - .. _class_VisibilityNotifier_screen_exited: +.. _class_VisibilityNotifier_screen_exited: - **screen_exited** **(** **)** @@ -67,7 +67,7 @@ The VisibilityNotifier detects when it is visible on the screen. It also notifie Property Descriptions --------------------- - .. _class_VisibilityNotifier_aabb: +.. _class_VisibilityNotifier_aabb: - :ref:`AABB` **aabb** @@ -82,7 +82,7 @@ The VisibilityNotifier's bounding box. Method Descriptions ------------------- - .. _class_VisibilityNotifier_is_on_screen: +.. _class_VisibilityNotifier_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 56e8d4920..497ba6f22 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -35,25 +35,25 @@ Methods Signals ------- - .. _class_VisibilityNotifier2D_screen_entered: +.. _class_VisibilityNotifier2D_screen_entered: - **screen_entered** **(** **)** Emitted when the VisibilityNotifier2D enters the screen. - .. _class_VisibilityNotifier2D_screen_exited: +.. _class_VisibilityNotifier2D_screen_exited: - **screen_exited** **(** **)** Emitted when the VisibilityNotifier2D exits the screen. - .. _class_VisibilityNotifier2D_viewport_entered: +.. _class_VisibilityNotifier2D_viewport_entered: - **viewport_entered** **(** :ref:`Viewport` viewport **)** Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. - .. _class_VisibilityNotifier2D_viewport_exited: +.. _class_VisibilityNotifier2D_viewport_exited: - **viewport_exited** **(** :ref:`Viewport` viewport **)** @@ -67,7 +67,7 @@ The VisibilityNotifier2D detects when it is visible on the screen. It also notif Property Descriptions --------------------- - .. _class_VisibilityNotifier2D_rect: +.. _class_VisibilityNotifier2D_rect: - :ref:`Rect2` **rect** @@ -82,7 +82,7 @@ The VisibilityNotifier2D's bounding rectangle. Method Descriptions ------------------- - .. _class_VisibilityNotifier2D_is_on_screen: +.. _class_VisibilityNotifier2D_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index d2dbe563d..a8aaea236 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -43,7 +43,7 @@ Methods Property Descriptions --------------------- - .. _class_VisualInstance_layers: +.. _class_VisualInstance_layers: - :ref:`int` **layers** @@ -60,17 +60,17 @@ This object will only be visible for :ref:`Camera`\ s whose cull m Method Descriptions ------------------- - .. _class_VisualInstance_get_aabb: +.. _class_VisualInstance_get_aabb: - :ref:`AABB` **get_aabb** **(** **)** const Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. - .. _class_VisualInstance_get_layer_mask_bit: +.. _class_VisualInstance_get_layer_mask_bit: - :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const - .. _class_VisualInstance_get_transformed_aabb: +.. _class_VisualInstance_get_transformed_aabb: - :ref:`AABB` **get_transformed_aabb** **(** **)** const @@ -78,7 +78,7 @@ Returns the transformed :ref:`AABB` (also known as the bounding box) 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: +.. _class_VisualInstance_set_base: - void **set_base** **(** :ref:`RID` base **)** @@ -86,7 +86,7 @@ Sets the base of the VisualInstance, which changes how the engine handles the Vi It is recommended to only use set_base if you know what you're doing. - .. _class_VisualInstance_set_layer_mask_bit: +.. _class_VisualInstance_set_layer_mask_bit: - void **set_layer_mask_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index 309d2ed68..244730509 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -108,7 +108,7 @@ Methods Signals ------- - .. _class_VisualScript_node_ports_changed: +.. _class_VisualScript_node_ports_changed: - **node_ports_changed** **(** :ref:`String` function, :ref:`int` id **)** @@ -127,214 +127,215 @@ Tutorials --------- - :doc:`../getting_started/scripting/visual_script/index` + Method Descriptions ------------------- - .. _class_VisualScript_add_custom_signal: +.. _class_VisualScript_add_custom_signal: - void **add_custom_signal** **(** :ref:`String` name **)** Add a custom signal with the specified name to the VisualScript. - .. _class_VisualScript_add_function: +.. _class_VisualScript_add_function: - void **add_function** **(** :ref:`String` name **)** Add a function with the specified name to the VisualScript. - .. _class_VisualScript_add_node: +.. _class_VisualScript_add_node: - 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: +.. _class_VisualScript_add_variable: - 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: +.. _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 **)** Add an argument to a custom signal added with :ref:`add_custom_signal`. - .. _class_VisualScript_custom_signal_get_argument_count: +.. _class_VisualScript_custom_signal_get_argument_count: - :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: +.. _class_VisualScript_custom_signal_get_argument_name: - :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: +.. _class_VisualScript_custom_signal_get_argument_type: - :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: +.. _class_VisualScript_custom_signal_remove_argument: - 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: +.. _class_VisualScript_custom_signal_set_argument_name: - 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: +.. _class_VisualScript_custom_signal_set_argument_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: +.. _class_VisualScript_custom_signal_swap_argument: - 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: +.. _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 **)** 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: +.. _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 **)** Disconnect two data ports previously connected with :ref:`data_connect`. - .. _class_VisualScript_get_function_node_id: +.. _class_VisualScript_get_function_node_id: - :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: +.. _class_VisualScript_get_function_scroll: - :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: +.. _class_VisualScript_get_node: - :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: +.. _class_VisualScript_get_node_position: - :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: +.. _class_VisualScript_get_variable_default_value: - :ref:`Variant` **get_variable_default_value** **(** :ref:`String` name **)** const Returns the default (initial) value of a variable. - .. _class_VisualScript_get_variable_export: +.. _class_VisualScript_get_variable_export: - :ref:`bool` **get_variable_export** **(** :ref:`String` name **)** const Returns whether a variable is exported. - .. _class_VisualScript_get_variable_info: +.. _class_VisualScript_get_variable_info: - :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: +.. _class_VisualScript_has_custom_signal: - :ref:`bool` **has_custom_signal** **(** :ref:`String` name **)** const Returns whether a signal exists with the specified name. - .. _class_VisualScript_has_data_connection: +.. _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 Returns whether the specified data ports are connected. - .. _class_VisualScript_has_function: +.. _class_VisualScript_has_function: - :ref:`bool` **has_function** **(** :ref:`String` name **)** const Returns whether a function exists with the specified name. - .. _class_VisualScript_has_node: +.. _class_VisualScript_has_node: - :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: +.. _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 Returns whether the specified sequence ports are connected. - .. _class_VisualScript_has_variable: +.. _class_VisualScript_has_variable: - :ref:`bool` **has_variable** **(** :ref:`String` name **)** const Returns whether a variable exists with the specified name. - .. _class_VisualScript_remove_custom_signal: +.. _class_VisualScript_remove_custom_signal: - void **remove_custom_signal** **(** :ref:`String` name **)** Remove a custom signal with the given name. - .. _class_VisualScript_remove_function: +.. _class_VisualScript_remove_function: - void **remove_function** **(** :ref:`String` name **)** Remove a specific function and its nodes from the script. - .. _class_VisualScript_remove_node: +.. _class_VisualScript_remove_node: - void **remove_node** **(** :ref:`String` func, :ref:`int` id **)** Remove a specific node. - .. _class_VisualScript_remove_variable: +.. _class_VisualScript_remove_variable: - void **remove_variable** **(** :ref:`String` name **)** Remove a variable with the given name. - .. _class_VisualScript_rename_custom_signal: +.. _class_VisualScript_rename_custom_signal: - void **rename_custom_signal** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a custom signal. - .. _class_VisualScript_rename_function: +.. _class_VisualScript_rename_function: - void **rename_function** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a function. - .. _class_VisualScript_rename_variable: +.. _class_VisualScript_rename_variable: - void **rename_variable** **(** :ref:`String` name, :ref:`String` new_name **)** Change the name of a variable. - .. _class_VisualScript_sequence_connect: +.. _class_VisualScript_sequence_connect: - void **sequence_connect** **(** :ref:`String` func, :ref:`int` from_node, :ref:`int` from_output, :ref:`int` to_node **)** @@ -342,43 +343,43 @@ Connect two sequence ports. The execution will flow from of ``from_node``'s ``fr Unlike :ref:`data_connect`, there isn't a ``to_port``, since the target node can have only one sequence port. - .. _class_VisualScript_sequence_disconnect: +.. _class_VisualScript_sequence_disconnect: - 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: +.. _class_VisualScript_set_function_scroll: - 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: +.. _class_VisualScript_set_instance_base_type: - void **set_instance_base_type** **(** :ref:`String` type **)** Set the base type of the script. - .. _class_VisualScript_set_node_position: +.. _class_VisualScript_set_node_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: +.. _class_VisualScript_set_variable_default_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: +.. _class_VisualScript_set_variable_export: - void **set_variable_export** **(** :ref:`String` name, :ref:`bool` enable **)** Change whether a variable is exported. - .. _class_VisualScript_set_variable_info: +.. _class_VisualScript_set_variable_info: - void **set_variable_info** **(** :ref:`String` name, :ref:`Dictionary` value **)** diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index 6df1402bb..89fa9fd37 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -33,7 +33,7 @@ A Visual Script node representing a constant from base types, such as Vector3.AX Property Descriptions --------------------- - .. _class_VisualScriptBasicTypeConstant_basic_type: +.. _class_VisualScriptBasicTypeConstant_basic_type: - :ref:`Variant.Type` **basic_type** @@ -45,7 +45,7 @@ Property Descriptions The type to get the constant from. - .. _class_VisualScriptBasicTypeConstant_constant: +.. _class_VisualScriptBasicTypeConstant_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index c699a1bb5..501cfd9fd 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptBuiltinFunc_BuiltinFunc: +.. _enum_VisualScriptBuiltinFunc_BuiltinFunc: enum **BuiltinFunc**: @@ -105,7 +105,7 @@ See also :ref:`@GDScript`, for the same functions in the GDScri Property Descriptions --------------------- - .. _class_VisualScriptBuiltinFunc_function: +.. _class_VisualScriptBuiltinFunc_function: - :ref:`BuiltinFunc` **function** diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index 174218ea4..dfeffc28f 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -41,7 +41,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptClassConstant_base_type: +.. _class_VisualScriptClassConstant_base_type: - :ref:`String` **base_type** @@ -53,7 +53,7 @@ Property Descriptions The constant's parent class. - .. _class_VisualScriptClassConstant_constant: +.. _class_VisualScriptClassConstant_constant: - :ref:`String` **constant** diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index c7531e606..cd1616ce0 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -37,7 +37,7 @@ Comment nodes can be resized so they encompass a group of nodes. Property Descriptions --------------------- - .. _class_VisualScriptComment_description: +.. _class_VisualScriptComment_description: - :ref:`String` **description** @@ -49,7 +49,7 @@ Property Descriptions The text inside the comment node. - .. _class_VisualScriptComment_size: +.. _class_VisualScriptComment_size: - :ref:`Vector2` **size** @@ -61,7 +61,7 @@ The text inside the comment node. The comment node's size (in pixels). - .. _class_VisualScriptComment_title: +.. _class_VisualScriptComment_title: - :ref:`String` **title** diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 38bf88f90..4d0e23aa7 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -41,7 +41,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptConstant_type: +.. _class_VisualScriptConstant_type: - :ref:`Variant.Type` **type** @@ -53,7 +53,7 @@ Property Descriptions The constant's type. - .. _class_VisualScriptConstant_value: +.. _class_VisualScriptConstant_value: - :ref:`Variant` **value** diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index 0151e6d11..1e0577d61 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -37,19 +37,19 @@ A Visual Script node which calls a base type constructor. It can be used for typ Method Descriptions ------------------- - .. _class_VisualScriptConstructor_get_constructor: +.. _class_VisualScriptConstructor_get_constructor: - :ref:`Dictionary` **get_constructor** **(** **)** const - .. _class_VisualScriptConstructor_get_constructor_type: +.. _class_VisualScriptConstructor_get_constructor_type: - :ref:`Variant.Type` **get_constructor_type** **(** **)** const - .. _class_VisualScriptConstructor_set_constructor: +.. _class_VisualScriptConstructor_set_constructor: - void **set_constructor** **(** :ref:`Dictionary` constructor **)** - .. _class_VisualScriptConstructor_set_constructor_type: +.. _class_VisualScriptConstructor_set_constructor_type: - void **set_constructor_type** **(** :ref:`Variant.Type` type **)** diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index a2411a4f9..775493b2e 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -52,7 +52,7 @@ Methods Enumerations ------------ - .. _enum_VisualScriptCustomNode_StartMode: +.. _enum_VisualScriptCustomNode_StartMode: enum **StartMode**: @@ -72,6 +72,7 @@ This is used by :ref:`VisualScriptCondition` to red - **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 ----------- @@ -80,85 +81,85 @@ A custom Visual Script node which can be scripted in powerful ways. Method Descriptions ------------------- - .. _class_VisualScriptCustomNode__get_caption: +.. _class_VisualScriptCustomNode__get_caption: - :ref:`String` **_get_caption** **(** **)** virtual Return the node's title. - .. _class_VisualScriptCustomNode__get_category: +.. _class_VisualScriptCustomNode__get_category: - :ref:`String` **_get_category** **(** **)** virtual Return the node's category. - .. _class_VisualScriptCustomNode__get_input_value_port_count: +.. _class_VisualScriptCustomNode__get_input_value_port_count: - :ref:`int` **_get_input_value_port_count** **(** **)** virtual Return the count of input value ports. - .. _class_VisualScriptCustomNode__get_input_value_port_name: +.. _class_VisualScriptCustomNode__get_input_value_port_name: - :ref:`String` **_get_input_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified input port's name. - .. _class_VisualScriptCustomNode__get_input_value_port_type: +.. _class_VisualScriptCustomNode__get_input_value_port_type: - :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`. - .. _class_VisualScriptCustomNode__get_output_sequence_port_count: +.. _class_VisualScriptCustomNode__get_output_sequence_port_count: - :ref:`int` **_get_output_sequence_port_count** **(** **)** virtual Return the amount of output **sequence** ports. - .. _class_VisualScriptCustomNode__get_output_sequence_port_text: +.. _class_VisualScriptCustomNode__get_output_sequence_port_text: - :ref:`String` **_get_output_sequence_port_text** **(** :ref:`int` idx **)** virtual Return the specified **sequence** output's name. - .. _class_VisualScriptCustomNode__get_output_value_port_count: +.. _class_VisualScriptCustomNode__get_output_value_port_count: - :ref:`int` **_get_output_value_port_count** **(** **)** virtual Return the amount of output value ports. - .. _class_VisualScriptCustomNode__get_output_value_port_name: +.. _class_VisualScriptCustomNode__get_output_value_port_name: - :ref:`String` **_get_output_value_port_name** **(** :ref:`int` idx **)** virtual Return the specified output's name. - .. _class_VisualScriptCustomNode__get_output_value_port_type: +.. _class_VisualScriptCustomNode__get_output_value_port_type: - :ref:`int` **_get_output_value_port_type** **(** :ref:`int` idx **)** virtual Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope`. - .. _class_VisualScriptCustomNode__get_text: +.. _class_VisualScriptCustomNode__get_text: - :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). - .. _class_VisualScriptCustomNode__get_working_memory_size: +.. _class_VisualScriptCustomNode__get_working_memory_size: - :ref:`int` **_get_working_memory_size** **(** **)** virtual Return the size of the custom node's working memory. See :ref:`_step` for more details. - .. _class_VisualScriptCustomNode__has_input_sequence_port: +.. _class_VisualScriptCustomNode__has_input_sequence_port: - :ref:`bool` **_has_input_sequence_port** **(** **)** virtual Return whether the custom node has an input **sequence** port. - .. _class_VisualScriptCustomNode__step: +.. _class_VisualScriptCustomNode__step: - :ref:`Variant` **_step** **(** :ref:`Array` inputs, :ref:`Array` outputs, :ref:`int` start_mode, :ref:`Array` working_mem **)** virtual diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index cf272236f..ae920ffd4 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -31,7 +31,7 @@ A Visual Script node which deconstructs a base type instance into its parts. Property Descriptions --------------------- - .. _class_VisualScriptDeconstruct_type: +.. _class_VisualScriptDeconstruct_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscripteditor.rst b/classes/class_visualscripteditor.rst index dcdac1d86..3b81e9f50 100644 --- a/classes/class_visualscripteditor.rst +++ b/classes/class_visualscripteditor.rst @@ -28,7 +28,7 @@ Methods Signals ------- - .. _class_VisualScriptEditor_custom_nodes_updated: +.. _class_VisualScriptEditor_custom_nodes_updated: - **custom_nodes_updated** **(** **)** @@ -37,13 +37,13 @@ Emitted when a custom Visual Script node is added or removed. Method Descriptions ------------------- - .. _class_VisualScriptEditor_add_custom_node: +.. _class_VisualScriptEditor_add_custom_node: - 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: +.. _class_VisualScriptEditor_remove_custom_node: - void **remove_custom_node** **(** :ref:`String` name, :ref:`String` category **)** diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 9b9b6c8d1..5e23a0cf3 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -39,7 +39,7 @@ Emits a specified signal when it is executed. Property Descriptions --------------------- - .. _class_VisualScriptEmitSignal_signal: +.. _class_VisualScriptEmitSignal_signal: - :ref:`String` **signal** diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 2b2463c0c..3fea58a98 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -31,7 +31,7 @@ A Visual Script node returning a singleton from :ref:`@GlobalScope` **constant** diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index 9717e4f17..7fb9118ef 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -44,7 +44,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptFunctionCall_CallMode: +.. _enum_VisualScriptFunctionCall_CallMode: enum **CallMode**: @@ -54,7 +54,7 @@ enum **CallMode**: - **CALL_MODE_BASIC_TYPE** = **3** - **CALL_MODE_SINGLETON** = **4** - .. _enum_VisualScriptFunctionCall_RPCCallMode: +.. _enum_VisualScriptFunctionCall_RPCCallMode: enum **RPCCallMode**: @@ -67,7 +67,7 @@ enum **RPCCallMode**: Property Descriptions --------------------- - .. _class_VisualScriptFunctionCall_base_script: +.. _class_VisualScriptFunctionCall_base_script: - :ref:`String` **base_script** @@ -77,7 +77,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ - .. _class_VisualScriptFunctionCall_base_type: +.. _class_VisualScriptFunctionCall_base_type: - :ref:`String` **base_type** @@ -87,7 +87,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ - .. _class_VisualScriptFunctionCall_basic_type: +.. _class_VisualScriptFunctionCall_basic_type: - :ref:`Variant.Type` **basic_type** @@ -97,7 +97,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ - .. _class_VisualScriptFunctionCall_call_mode: +.. _class_VisualScriptFunctionCall_call_mode: - :ref:`CallMode` **call_mode** @@ -107,7 +107,7 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ - .. _class_VisualScriptFunctionCall_function: +.. _class_VisualScriptFunctionCall_function: - :ref:`String` **function** @@ -117,7 +117,7 @@ Property Descriptions | *Getter* | get_function() | +----------+---------------------+ - .. _class_VisualScriptFunctionCall_node_path: +.. _class_VisualScriptFunctionCall_node_path: - :ref:`NodePath` **node_path** @@ -127,7 +127,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ - .. _class_VisualScriptFunctionCall_rpc_call_mode: +.. _class_VisualScriptFunctionCall_rpc_call_mode: - :ref:`RPCCallMode` **rpc_call_mode** @@ -137,7 +137,7 @@ Property Descriptions | *Getter* | get_rpc_call_mode() | +----------+--------------------------+ - .. _class_VisualScriptFunctionCall_singleton: +.. _class_VisualScriptFunctionCall_singleton: - :ref:`String` **singleton** @@ -147,7 +147,7 @@ Property Descriptions | *Getter* | get_singleton() | +----------+----------------------+ - .. _class_VisualScriptFunctionCall_use_default_args: +.. _class_VisualScriptFunctionCall_use_default_args: - :ref:`int` **use_default_args** @@ -157,7 +157,7 @@ Property Descriptions | *Getter* | get_use_default_args() | +----------+-----------------------------+ - .. _class_VisualScriptFunctionCall_validate: +.. _class_VisualScriptFunctionCall_validate: - :ref:`bool` **validate** diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index b0df906e5..64a160657 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -30,15 +30,15 @@ Methods Method Descriptions ------------------- - .. _class_VisualScriptFunctionState_connect_to_signal: +.. _class_VisualScriptFunctionState_connect_to_signal: - void **connect_to_signal** **(** :ref:`Object` obj, :ref:`String` signals, :ref:`Array` args **)** - .. _class_VisualScriptFunctionState_is_valid: +.. _class_VisualScriptFunctionState_is_valid: - :ref:`bool` **is_valid** **(** **)** const - .. _class_VisualScriptFunctionState_resume: +.. _class_VisualScriptFunctionState_resume: - :ref:`Variant` **resume** **(** :ref:`Array` args=null **)** diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 6d352c9fe..9d79e00ad 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualScriptGlobalConstant_constant: +.. _class_VisualScriptGlobalConstant_constant: - :ref:`int` **constant** diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index ff1c638c9..4ad3cd89b 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptInputAction_Mode: +.. _enum_VisualScriptInputAction_Mode: enum **Mode**: @@ -40,7 +40,7 @@ enum **Mode**: Property Descriptions --------------------- - .. _class_VisualScriptInputAction_action: +.. _class_VisualScriptInputAction_action: - :ref:`String` **action** @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_action_name() | +----------+------------------------+ - .. _class_VisualScriptInputAction_mode: +.. _class_VisualScriptInputAction_mode: - :ref:`Mode` **mode** diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index 44f91c939..26b979353 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -41,7 +41,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptLocalVar_type: +.. _class_VisualScriptLocalVar_type: - :ref:`Variant.Type` **type** @@ -53,7 +53,7 @@ Property Descriptions The local variable's type. - .. _class_VisualScriptLocalVar_var_name: +.. _class_VisualScriptLocalVar_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index ba4ef383e..e177cbbf0 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -45,7 +45,7 @@ Changes a local variable's value to the given input. The new value is also provi Property Descriptions --------------------- - .. _class_VisualScriptLocalVarSet_type: +.. _class_VisualScriptLocalVarSet_type: - :ref:`Variant.Type` **type** @@ -57,7 +57,7 @@ Property Descriptions The local variable's type. - .. _class_VisualScriptLocalVarSet_var_name: +.. _class_VisualScriptLocalVarSet_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index 84942f5c0..986d7d44e 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptMathConstant_MathConstant: +.. _enum_VisualScriptMathConstant_MathConstant: enum **MathConstant**: @@ -56,7 +56,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptMathConstant_constant: +.. _class_VisualScriptMathConstant_constant: - :ref:`MathConstant` **constant** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 71f64047b..ed575e54a 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -34,7 +34,7 @@ Methods Signals ------- - .. _class_VisualScriptNode_ports_changed: +.. _class_VisualScriptNode_ports_changed: - **ports_changed** **(** **)** @@ -48,25 +48,25 @@ A node which is part of a :ref:`VisualScript`. Not to be con Method Descriptions ------------------- - .. _class_VisualScriptNode_get_default_input_value: +.. _class_VisualScriptNode_get_default_input_value: - :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: +.. _class_VisualScriptNode_get_visual_script: - :ref:`VisualScript` **get_visual_script** **(** **)** const Returns the :ref:`VisualScript` instance the node is bound to. - .. _class_VisualScriptNode_ports_changed_notify: +.. _class_VisualScriptNode_ports_changed_notify: - void **ports_changed_notify** **(** **)** Notify that the node's ports have changed. Usually used in conjunction with :ref:`VisualScriptCustomNode` . - .. _class_VisualScriptNode_set_default_input_value: +.. _class_VisualScriptNode_set_default_input_value: - void **set_default_input_value** **(** :ref:`int` port_idx, :ref:`Variant` value **)** diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index a88f13f8b..9578b3230 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -41,7 +41,7 @@ Description Property Descriptions --------------------- - .. _class_VisualScriptOperator_operator: +.. _class_VisualScriptOperator_operator: - :ref:`Variant.Operator` **operator** @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | get_operator() | +----------+---------------------+ - .. _class_VisualScriptOperator_type: +.. _class_VisualScriptOperator_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index eb1cee460..37ce6fd96 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -39,7 +39,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptPreload_resource: +.. _class_VisualScriptPreload_resource: - :ref:`Resource` **resource** diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index f6ec3391c..5fe8b3ae6 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -38,7 +38,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptPropertyGet_CallMode: +.. _enum_VisualScriptPropertyGet_CallMode: enum **CallMode**: @@ -49,7 +49,7 @@ enum **CallMode**: Property Descriptions --------------------- - .. _class_VisualScriptPropertyGet_base_script: +.. _class_VisualScriptPropertyGet_base_script: - :ref:`String` **base_script** @@ -59,7 +59,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ - .. _class_VisualScriptPropertyGet_base_type: +.. _class_VisualScriptPropertyGet_base_type: - :ref:`String` **base_type** @@ -69,7 +69,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ - .. _class_VisualScriptPropertyGet_basic_type: +.. _class_VisualScriptPropertyGet_basic_type: - :ref:`Variant.Type` **basic_type** @@ -79,7 +79,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ - .. _class_VisualScriptPropertyGet_index: +.. _class_VisualScriptPropertyGet_index: - :ref:`String` **index** @@ -89,7 +89,7 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ - .. _class_VisualScriptPropertyGet_node_path: +.. _class_VisualScriptPropertyGet_node_path: - :ref:`NodePath` **node_path** @@ -99,7 +99,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ - .. _class_VisualScriptPropertyGet_property: +.. _class_VisualScriptPropertyGet_property: - :ref:`String` **property** @@ -109,7 +109,7 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ - .. _class_VisualScriptPropertyGet_set_mode: +.. _class_VisualScriptPropertyGet_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 019dfbce8..9b700e0c2 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -40,7 +40,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptPropertySet_CallMode: +.. _enum_VisualScriptPropertySet_CallMode: enum **CallMode**: @@ -49,7 +49,7 @@ enum **CallMode**: - **CALL_MODE_INSTANCE** = **2** - **CALL_MODE_BASIC_TYPE** = **3** - .. _enum_VisualScriptPropertySet_AssignOp: +.. _enum_VisualScriptPropertySet_AssignOp: enum **AssignOp**: @@ -68,7 +68,7 @@ enum **AssignOp**: Property Descriptions --------------------- - .. _class_VisualScriptPropertySet_assign_op: +.. _class_VisualScriptPropertySet_assign_op: - :ref:`AssignOp` **assign_op** @@ -78,7 +78,7 @@ Property Descriptions | *Getter* | get_assign_op() | +----------+----------------------+ - .. _class_VisualScriptPropertySet_base_script: +.. _class_VisualScriptPropertySet_base_script: - :ref:`String` **base_script** @@ -88,7 +88,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ - .. _class_VisualScriptPropertySet_base_type: +.. _class_VisualScriptPropertySet_base_type: - :ref:`String` **base_type** @@ -98,7 +98,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ - .. _class_VisualScriptPropertySet_basic_type: +.. _class_VisualScriptPropertySet_basic_type: - :ref:`Variant.Type` **basic_type** @@ -108,7 +108,7 @@ Property Descriptions | *Getter* | get_basic_type() | +----------+-----------------------+ - .. _class_VisualScriptPropertySet_index: +.. _class_VisualScriptPropertySet_index: - :ref:`String` **index** @@ -118,7 +118,7 @@ Property Descriptions | *Getter* | get_index() | +----------+------------------+ - .. _class_VisualScriptPropertySet_node_path: +.. _class_VisualScriptPropertySet_node_path: - :ref:`NodePath` **node_path** @@ -128,7 +128,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ - .. _class_VisualScriptPropertySet_property: +.. _class_VisualScriptPropertySet_property: - :ref:`String` **property** @@ -138,7 +138,7 @@ Property Descriptions | *Getter* | get_property() | +----------+---------------------+ - .. _class_VisualScriptPropertySet_set_mode: +.. _class_VisualScriptPropertySet_set_mode: - :ref:`CallMode` **set_mode** diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 5d0e9185b..64bd7a91f 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualScriptResourcePath_path: +.. _class_VisualScriptResourcePath_path: - :ref:`String` **path** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index ef56bf92f..a4b4b1b3d 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -43,7 +43,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptReturn_return_enabled: +.. _class_VisualScriptReturn_return_enabled: - :ref:`bool` **return_enabled** @@ -55,7 +55,7 @@ Property Descriptions If ``true`` the ``return`` input port is available. - .. _class_VisualScriptReturn_return_type: +.. _class_VisualScriptReturn_return_type: - :ref:`Variant.Type` **return_type** diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 0011af3a8..3b5e7f689 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -39,7 +39,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptSceneNode_node_path: +.. _class_VisualScriptSceneNode_node_path: - :ref:`NodePath` **node_path** diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index e6f9caf2b..897879717 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -43,7 +43,7 @@ Chooses between two input values based on a Boolean condition. Property Descriptions --------------------- - .. _class_VisualScriptSelect_type: +.. _class_VisualScriptSelect_type: - :ref:`Variant.Type` **type** diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index 964c0870d..d2c3a5946 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -43,7 +43,7 @@ Steps through a series of one or more output Sequence ports. The ``current`` dat Property Descriptions --------------------- - .. _class_VisualScriptSequence_steps: +.. _class_VisualScriptSequence_steps: - :ref:`int` **steps** diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index e2f9aaa0f..cbf04a2d2 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -26,7 +26,7 @@ Methods Method Descriptions ------------------- - .. _class_VisualScriptSubCall__subcall: +.. _class_VisualScriptSubCall__subcall: - :ref:`Variant` **_subcall** **(** :ref:`Variant` arguments **)** virtual diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 35d6659b5..7dd7b4c5d 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualScriptTypeCast_base_script: +.. _class_VisualScriptTypeCast_base_script: - :ref:`String` **base_script** @@ -38,7 +38,7 @@ Property Descriptions | *Getter* | get_base_script() | +----------+------------------------+ - .. _class_VisualScriptTypeCast_base_type: +.. _class_VisualScriptTypeCast_base_type: - :ref:`String` **base_type** diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 57024c9f0..7c7232f7c 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -39,7 +39,7 @@ none Property Descriptions --------------------- - .. _class_VisualScriptVariableGet_var_name: +.. _class_VisualScriptVariableGet_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 106dc571a..dc57b234b 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -41,7 +41,7 @@ Changes a variable's value to the given input. Property Descriptions --------------------- - .. _class_VisualScriptVariableSet_var_name: +.. _class_VisualScriptVariableSet_var_name: - :ref:`String` **var_name** diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 1fd4fc400..b65f54938 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptYield_YieldMode: +.. _enum_VisualScriptYield_YieldMode: enum **YieldMode**: @@ -39,7 +39,7 @@ enum **YieldMode**: Property Descriptions --------------------- - .. _class_VisualScriptYield_mode: +.. _class_VisualScriptYield_mode: - :ref:`YieldMode` **mode** @@ -49,7 +49,7 @@ Property Descriptions | *Getter* | get_yield_mode() | +----------+-----------------------+ - .. _class_VisualScriptYield_wait_time: +.. _class_VisualScriptYield_wait_time: - :ref:`float` **wait_time** diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 7b4bdb019..18728f1c3 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -32,7 +32,7 @@ Properties Enumerations ------------ - .. _enum_VisualScriptYieldSignal_CallMode: +.. _enum_VisualScriptYieldSignal_CallMode: enum **CallMode**: @@ -43,7 +43,7 @@ enum **CallMode**: Property Descriptions --------------------- - .. _class_VisualScriptYieldSignal_base_type: +.. _class_VisualScriptYieldSignal_base_type: - :ref:`String` **base_type** @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | get_base_type() | +----------+----------------------+ - .. _class_VisualScriptYieldSignal_call_mode: +.. _class_VisualScriptYieldSignal_call_mode: - :ref:`CallMode` **call_mode** @@ -63,7 +63,7 @@ Property Descriptions | *Getter* | get_call_mode() | +----------+----------------------+ - .. _class_VisualScriptYieldSignal_node_path: +.. _class_VisualScriptYieldSignal_node_path: - :ref:`NodePath` **node_path** @@ -73,7 +73,7 @@ Property Descriptions | *Getter* | get_base_path() | +----------+----------------------+ - .. _class_VisualScriptYieldSignal_signal: +.. _class_VisualScriptYieldSignal_signal: - :ref:`String` **signal** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 0471e6190..86fab85c5 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -734,18 +734,18 @@ Methods Signals ------- - .. _class_VisualServer_frame_post_draw: +.. _class_VisualServer_frame_post_draw: - **frame_post_draw** **(** **)** - .. _class_VisualServer_frame_pre_draw: +.. _class_VisualServer_frame_pre_draw: - **frame_pre_draw** **(** **)** Enumerations ------------ - .. _enum_VisualServer_ViewportRenderInfo: +.. _enum_VisualServer_ViewportRenderInfo: enum **ViewportRenderInfo**: @@ -757,7 +757,7 @@ enum **ViewportRenderInfo**: - **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** - **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally. - .. _enum_VisualServer_CubeMapSide: +.. _enum_VisualServer_CubeMapSide: enum **CubeMapSide**: @@ -768,7 +768,7 @@ enum **CubeMapSide**: - **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap. - **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap. - .. _enum_VisualServer_TextureType: +.. _enum_VisualServer_TextureType: enum **TextureType**: @@ -777,7 +777,7 @@ enum **TextureType**: - **TEXTURE_TYPE_2D_ARRAY** = **2** - **TEXTURE_TYPE_3D** = **3** - .. _enum_VisualServer_LightType: +.. _enum_VisualServer_LightType: enum **LightType**: @@ -785,7 +785,7 @@ enum **LightType**: - **LIGHT_OMNI** = **1** --- is an omni light. - **LIGHT_SPOT** = **2** --- is an spot light. - .. _enum_VisualServer_ArrayType: +.. _enum_VisualServer_ArrayType: enum **ArrayType**: @@ -800,14 +800,14 @@ enum **ArrayType**: - **ARRAY_INDEX** = **8** --- Array is index array. - **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally. - .. _enum_VisualServer_BlendShapeMode: +.. _enum_VisualServer_BlendShapeMode: enum **BlendShapeMode**: - **BLEND_SHAPE_MODE_NORMALIZED** = **0** - **BLEND_SHAPE_MODE_RELATIVE** = **1** - .. _enum_VisualServer_ShadowCastingSetting: +.. _enum_VisualServer_ShadowCastingSetting: enum **ShadowCastingSetting**: @@ -816,7 +816,7 @@ enum **ShadowCastingSetting**: - **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** - **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** - .. _enum_VisualServer_CanvasOccluderPolygonCullMode: +.. _enum_VisualServer_CanvasOccluderPolygonCullMode: enum **CanvasOccluderPolygonCullMode**: @@ -824,7 +824,7 @@ enum **CanvasOccluderPolygonCullMode**: - **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise. - **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise. - .. _enum_VisualServer_ParticlesDrawOrder: +.. _enum_VisualServer_ParticlesDrawOrder: enum **ParticlesDrawOrder**: @@ -832,7 +832,7 @@ enum **ParticlesDrawOrder**: - **PARTICLES_DRAW_ORDER_LIFETIME** = **1** - **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2** - .. _enum_VisualServer_ViewportMSAA: +.. _enum_VisualServer_ViewportMSAA: enum **ViewportMSAA**: @@ -842,7 +842,7 @@ enum **ViewportMSAA**: - **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X. - **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X. - .. _enum_VisualServer_ViewportUpdateMode: +.. _enum_VisualServer_ViewportUpdateMode: enum **ViewportUpdateMode**: @@ -851,7 +851,7 @@ enum **ViewportUpdateMode**: - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** - **VIEWPORT_UPDATE_ALWAYS** = **3** - .. _enum_VisualServer_MultimeshColorFormat: +.. _enum_VisualServer_MultimeshColorFormat: enum **MultimeshColorFormat**: @@ -859,7 +859,7 @@ enum **MultimeshColorFormat**: - **MULTIMESH_COLOR_8BIT** = **1** - **MULTIMESH_COLOR_FLOAT** = **2** - .. _enum_VisualServer_LightDirectionalShadowMode: +.. _enum_VisualServer_LightDirectionalShadowMode: enum **LightDirectionalShadowMode**: @@ -867,14 +867,14 @@ enum **LightDirectionalShadowMode**: - **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** - **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** - .. _enum_VisualServer_LightOmniShadowMode: +.. _enum_VisualServer_LightOmniShadowMode: enum **LightOmniShadowMode**: - **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** - **LIGHT_OMNI_SHADOW_CUBE** = **1** - .. _enum_VisualServer_EnvironmentSSAOQuality: +.. _enum_VisualServer_EnvironmentSSAOQuality: enum **EnvironmentSSAOQuality**: @@ -882,7 +882,7 @@ enum **EnvironmentSSAOQuality**: - **ENV_SSAO_QUALITY_MEDIUM** = **1** - **ENV_SSAO_QUALITY_HIGH** = **2** - .. _enum_VisualServer_LightParam: +.. _enum_VisualServer_LightParam: enum **LightParam**: @@ -902,7 +902,7 @@ enum **LightParam**: - **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14** - **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally. - .. _enum_VisualServer_ScenarioDebugMode: +.. _enum_VisualServer_ScenarioDebugMode: enum **ScenarioDebugMode**: @@ -911,14 +911,14 @@ enum **ScenarioDebugMode**: - **SCENARIO_DEBUG_OVERDRAW** = **2** - **SCENARIO_DEBUG_SHADELESS** = **3** - .. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: +.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode: enum **LightDirectionalShadowDepthRangeMode**: - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0** - **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** - .. _enum_VisualServer_EnvironmentGlowBlendMode: +.. _enum_VisualServer_EnvironmentGlowBlendMode: enum **EnvironmentGlowBlendMode**: @@ -927,7 +927,7 @@ enum **EnvironmentGlowBlendMode**: - **GLOW_BLEND_MODE_SOFTLIGHT** = **2** - **GLOW_BLEND_MODE_REPLACE** = **3** - .. _enum_VisualServer_InstanceType: +.. _enum_VisualServer_InstanceType: enum **InstanceType**: @@ -943,7 +943,7 @@ enum **InstanceType**: - **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally. - **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). - .. _enum_VisualServer_ShaderMode: +.. _enum_VisualServer_ShaderMode: enum **ShaderMode**: @@ -952,7 +952,7 @@ enum **ShaderMode**: - **SHADER_PARTICLES** = **2** --- Shader is a particle shader. - **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally. - .. _enum_VisualServer_ViewportUsage: +.. _enum_VisualServer_ViewportUsage: enum **ViewportUsage**: @@ -961,7 +961,7 @@ enum **ViewportUsage**: - **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects. - **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects. - .. _enum_VisualServer_EnvironmentDOFBlurQuality: +.. _enum_VisualServer_EnvironmentDOFBlurQuality: enum **EnvironmentDOFBlurQuality**: @@ -969,7 +969,7 @@ enum **EnvironmentDOFBlurQuality**: - **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1** - **ENV_DOF_BLUR_QUALITY_HIGH** = **2** - .. _enum_VisualServer_PrimitiveType: +.. _enum_VisualServer_PrimitiveType: enum **PrimitiveType**: @@ -982,7 +982,7 @@ enum **PrimitiveType**: - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle). - **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally. - .. _enum_VisualServer_InstanceFlags: +.. _enum_VisualServer_InstanceFlags: enum **InstanceFlags**: @@ -990,7 +990,7 @@ enum **InstanceFlags**: - **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1** - **INSTANCE_FLAG_MAX** = **2** - .. _enum_VisualServer_ViewportClearMode: +.. _enum_VisualServer_ViewportClearMode: enum **ViewportClearMode**: @@ -998,14 +998,14 @@ enum **ViewportClearMode**: - **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing. - **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER. - .. _enum_VisualServer_LightOmniShadowDetail: +.. _enum_VisualServer_LightOmniShadowDetail: enum **LightOmniShadowDetail**: - **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0** - **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1** - .. _enum_VisualServer_CanvasLightMode: +.. _enum_VisualServer_CanvasLightMode: enum **CanvasLightMode**: @@ -1014,7 +1014,7 @@ enum **CanvasLightMode**: - **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency. - **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask. - .. _enum_VisualServer_NinePatchAxisMode: +.. _enum_VisualServer_NinePatchAxisMode: enum **NinePatchAxisMode**: @@ -1022,7 +1022,7 @@ enum **NinePatchAxisMode**: - **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed. - **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed. - .. _enum_VisualServer_ViewportDebugDraw: +.. _enum_VisualServer_ViewportDebugDraw: enum **ViewportDebugDraw**: @@ -1031,14 +1031,14 @@ enum **ViewportDebugDraw**: - **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``. - **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe. - .. _enum_VisualServer_MultimeshTransformFormat: +.. _enum_VisualServer_MultimeshTransformFormat: enum **MultimeshTransformFormat**: - **MULTIMESH_TRANSFORM_2D** = **0** - **MULTIMESH_TRANSFORM_3D** = **1** - .. _enum_VisualServer_ArrayFormat: +.. _enum_VisualServer_ArrayFormat: enum **ArrayFormat**: @@ -1064,7 +1064,7 @@ enum **ArrayFormat**: - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit. - **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly. - .. _enum_VisualServer_EnvironmentSSAOBlur: +.. _enum_VisualServer_EnvironmentSSAOBlur: enum **EnvironmentSSAOBlur**: @@ -1073,7 +1073,7 @@ enum **EnvironmentSSAOBlur**: - **ENV_SSAO_BLUR_2x2** = **2** - **ENV_SSAO_BLUR_3x3** = **3** - .. _enum_VisualServer_RenderInfo: +.. _enum_VisualServer_RenderInfo: enum **RenderInfo**: @@ -1088,14 +1088,14 @@ enum **RenderInfo**: - **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used. - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used. - .. _enum_VisualServer_ReflectionProbeUpdateMode: +.. _enum_VisualServer_ReflectionProbeUpdateMode: enum **ReflectionProbeUpdateMode**: - **REFLECTION_PROBE_UPDATE_ONCE** = **0** - **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** - .. _enum_VisualServer_EnvironmentBG: +.. _enum_VisualServer_EnvironmentBG: enum **EnvironmentBG**: @@ -1107,7 +1107,7 @@ enum **EnvironmentBG**: - **ENV_BG_KEEP** = **5** - **ENV_BG_MAX** = **6** - .. _enum_VisualServer_CanvasLightShadowFilter: +.. _enum_VisualServer_CanvasLightShadowFilter: enum **CanvasLightShadowFilter**: @@ -1118,14 +1118,14 @@ enum **CanvasLightShadowFilter**: - **CANVAS_LIGHT_FILTER_PCF9** = **4** - **CANVAS_LIGHT_FILTER_PCF13** = **5** - .. _enum_VisualServer_Features: +.. _enum_VisualServer_Features: enum **Features**: - **FEATURE_SHADERS** = **0** - **FEATURE_MULTITHREADED** = **1** - .. _enum_VisualServer_TextureFlags: +.. _enum_VisualServer_TextureFlags: enum **TextureFlags**: @@ -1140,7 +1140,7 @@ More effective on planes often shown going to the horrizon as those textures (Wa - **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface. - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled. - .. _enum_VisualServer_EnvironmentToneMapper: +.. _enum_VisualServer_EnvironmentToneMapper: enum **EnvironmentToneMapper**: @@ -1160,6 +1160,7 @@ Constants - **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 ----------- @@ -1170,83 +1171,83 @@ The visual server is completely opaque, the internals are entirely implementatio Method Descriptions ------------------- - .. _class_VisualServer_black_bars_set_images: +.. _class_VisualServer_black_bars_set_images: - 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. - .. _class_VisualServer_black_bars_set_margins: +.. _class_VisualServer_black_bars_set_margins: - void **black_bars_set_margins** **(** :ref:`int` left, :ref:`int` top, :ref:`int` right, :ref:`int` bottom **)** Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` was used) are rendered. - .. _class_VisualServer_camera_create: +.. _class_VisualServer_camera_create: - :ref:`RID` **camera_create** **(** **)** - .. _class_VisualServer_camera_set_cull_mask: +.. _class_VisualServer_camera_set_cull_mask: - void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`int` layers **)** - .. _class_VisualServer_camera_set_environment: +.. _class_VisualServer_camera_set_environment: - void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** - .. _class_VisualServer_camera_set_orthogonal: +.. _class_VisualServer_camera_set_orthogonal: - void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** - .. _class_VisualServer_camera_set_perspective: +.. _class_VisualServer_camera_set_perspective: - void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** - .. _class_VisualServer_camera_set_transform: +.. _class_VisualServer_camera_set_transform: - void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform` transform **)** - .. _class_VisualServer_camera_set_use_vertical_aspect: +.. _class_VisualServer_camera_set_use_vertical_aspect: - void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** - .. _class_VisualServer_canvas_create: +.. _class_VisualServer_canvas_create: - :ref:`RID` **canvas_create** **(** **)** Creates a canvas and returns the assigned :ref:`RID`. - .. _class_VisualServer_canvas_item_add_circle: +.. _class_VisualServer_canvas_item_add_circle: - 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. - .. _class_VisualServer_canvas_item_add_clip_ignore: +.. _class_VisualServer_canvas_item_add_clip_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: +.. _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 **)** Adds a line command to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_mesh: +.. _class_VisualServer_canvas_item_add_mesh: - 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. - .. _class_VisualServer_canvas_item_add_multimesh: +.. _class_VisualServer_canvas_item_add_multimesh: - 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. - .. _class_VisualServer_canvas_item_add_nine_patch: +.. _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 **)** @@ -1254,37 +1255,37 @@ Adds a nine patch image to the :ref:`CanvasItem`'s draw comman See :ref:`NinePatchRect` for more explanation. - .. _class_VisualServer_canvas_item_add_particles: +.. _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 **)** Adds a particles system to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_polygon: +.. _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 **)** Adds a polygon to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_polyline: +.. _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 **)** 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: +.. _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 **)** Adds a primitive to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_rect: +.. _class_VisualServer_canvas_item_add_rect: - void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** Adds a rectangle to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_set_transform: +.. _class_VisualServer_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** @@ -1292,1217 +1293,1217 @@ Adds a :ref:`Transform2D` command to the :ref:`CanvasItem` 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. - .. _class_VisualServer_canvas_item_add_texture_rect_region: +.. _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 **)** Adds a texture rect with region setting to the :ref:`CanvasItem`'s draw commands. - .. _class_VisualServer_canvas_item_add_triangle_array: +.. _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 **)** - .. _class_VisualServer_canvas_item_clear: +.. _class_VisualServer_canvas_item_clear: - void **canvas_item_clear** **(** :ref:`RID` item **)** Clears the :ref:`CanvasItem` and removes all commands in it. - .. _class_VisualServer_canvas_item_create: +.. _class_VisualServer_canvas_item_create: - :ref:`RID` **canvas_item_create** **(** **)** Creates a new :ref:`CanvasItem` and returns its :ref:`RID`. - .. _class_VisualServer_canvas_item_set_clip: +.. _class_VisualServer_canvas_item_set_clip: - void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** Sets clipping for the :ref:`CanvasItem`. - .. _class_VisualServer_canvas_item_set_copy_to_backbuffer: +.. _class_VisualServer_canvas_item_set_copy_to_backbuffer: - 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. - .. _class_VisualServer_canvas_item_set_custom_rect: +.. _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 ) **)** Defines a custom drawing rectangle for the :ref:`CanvasItem`. - .. _class_VisualServer_canvas_item_set_distance_field_mode: +.. _class_VisualServer_canvas_item_set_distance_field_mode: - void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** - .. _class_VisualServer_canvas_item_set_draw_behind_parent: +.. _class_VisualServer_canvas_item_set_draw_behind_parent: - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets :ref:`CanvasItem` to be drawn behind its parent. - .. _class_VisualServer_canvas_item_set_draw_index: +.. _class_VisualServer_canvas_item_set_draw_index: - void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** Sets the index for the :ref:`CanvasItem`. - .. _class_VisualServer_canvas_item_set_light_mask: +.. _class_VisualServer_canvas_item_set_light_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. - .. _class_VisualServer_canvas_item_set_material: +.. _class_VisualServer_canvas_item_set_material: - void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** Sets a new material to the :ref:`CanvasItem`. - .. _class_VisualServer_canvas_item_set_modulate: +.. _class_VisualServer_canvas_item_set_modulate: - void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` and its children. - .. _class_VisualServer_canvas_item_set_parent: +.. _class_VisualServer_canvas_item_set_parent: - void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** Sets the parent for the :ref:`CanvasItem`. - .. _class_VisualServer_canvas_item_set_self_modulate: +.. _class_VisualServer_canvas_item_set_self_modulate: - void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** Sets the color that modulates the :ref:`CanvasItem` without children. - .. _class_VisualServer_canvas_item_set_sort_children_by_y: +.. _class_VisualServer_canvas_item_set_sort_children_by_y: - 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. - .. _class_VisualServer_canvas_item_set_transform: +.. _class_VisualServer_canvas_item_set_transform: - void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** Sets the :ref:`CanvasItem`'s :ref:`Transform2D`. - .. _class_VisualServer_canvas_item_set_use_parent_material: +.. _class_VisualServer_canvas_item_set_use_parent_material: - void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if the :ref:`CanvasItem` uses its parent's material. - .. _class_VisualServer_canvas_item_set_visible: +.. _class_VisualServer_canvas_item_set_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: +.. _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 **)** 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: +.. _class_VisualServer_canvas_item_set_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). - .. _class_VisualServer_canvas_light_attach_to_canvas: +.. _class_VisualServer_canvas_light_attach_to_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: +.. _class_VisualServer_canvas_light_create: - :ref:`RID` **canvas_light_create** **(** **)** Creates a canvas light. - .. _class_VisualServer_canvas_light_occluder_attach_to_canvas: +.. _class_VisualServer_canvas_light_occluder_attach_to_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: +.. _class_VisualServer_canvas_light_occluder_create: - :ref:`RID` **canvas_light_occluder_create** **(** **)** Creates a light occluder. - .. _class_VisualServer_canvas_light_occluder_set_enabled: +.. _class_VisualServer_canvas_light_occluder_set_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: +.. _class_VisualServer_canvas_light_occluder_set_light_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 - .. _class_VisualServer_canvas_light_occluder_set_polygon: +.. _class_VisualServer_canvas_light_occluder_set_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: +.. _class_VisualServer_canvas_light_occluder_set_transform: - void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** Sets a light occluder's :ref:`Transform2D`. - .. _class_VisualServer_canvas_light_set_color: +.. _class_VisualServer_canvas_light_set_color: - void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color for a light. - .. _class_VisualServer_canvas_light_set_enabled: +.. _class_VisualServer_canvas_light_set_enabled: - void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables a canvas light. - .. _class_VisualServer_canvas_light_set_energy: +.. _class_VisualServer_canvas_light_set_energy: - void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** Sets a canvas light's energy. - .. _class_VisualServer_canvas_light_set_height: +.. _class_VisualServer_canvas_light_set_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: +.. _class_VisualServer_canvas_light_set_item_cull_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 - .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask: +.. _class_VisualServer_canvas_light_set_item_shadow_cull_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. - .. _class_VisualServer_canvas_light_set_layer_range: +.. _class_VisualServer_canvas_light_set_layer_range: - 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: +.. _class_VisualServer_canvas_light_set_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: +.. _class_VisualServer_canvas_light_set_scale: - void **canvas_light_set_scale** **(** :ref:`RID` light, :ref:`float` scale **)** - .. _class_VisualServer_canvas_light_set_shadow_buffer_size: +.. _class_VisualServer_canvas_light_set_shadow_buffer_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: +.. _class_VisualServer_canvas_light_set_shadow_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: +.. _class_VisualServer_canvas_light_set_shadow_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: +.. _class_VisualServer_canvas_light_set_shadow_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: +.. _class_VisualServer_canvas_light_set_shadow_gradient_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: +.. _class_VisualServer_canvas_light_set_shadow_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: +.. _class_VisualServer_canvas_light_set_texture: - void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** - .. _class_VisualServer_canvas_light_set_texture_offset: +.. _class_VisualServer_canvas_light_set_texture_offset: - void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** - .. _class_VisualServer_canvas_light_set_transform: +.. _class_VisualServer_canvas_light_set_transform: - void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** Sets the canvas light's :ref:`Transform2D`. - .. _class_VisualServer_canvas_light_set_z_range: +.. _class_VisualServer_canvas_light_set_z_range: - void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** - .. _class_VisualServer_canvas_occluder_polygon_create: +.. _class_VisualServer_canvas_occluder_polygon_create: - :ref:`RID` **canvas_occluder_polygon_create** **(** **)** Creates a new light occluder polygon. - .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode: +.. _class_VisualServer_canvas_occluder_polygon_set_cull_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: +.. _class_VisualServer_canvas_occluder_polygon_set_shape: - 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: +.. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines: - 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: +.. _class_VisualServer_canvas_set_item_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`. - .. _class_VisualServer_canvas_set_modulate: +.. _class_VisualServer_canvas_set_modulate: - void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** Modulates all colors in the given canvas. - .. _class_VisualServer_directional_light_create: +.. _class_VisualServer_directional_light_create: - :ref:`RID` **directional_light_create** **(** **)** - .. _class_VisualServer_draw: +.. _class_VisualServer_draw: - void **draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** - .. _class_VisualServer_environment_create: +.. _class_VisualServer_environment_create: - :ref:`RID` **environment_create** **(** **)** - .. _class_VisualServer_environment_set_adjustment: +.. _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 **)** - .. _class_VisualServer_environment_set_ambient_light: +.. _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 **)** - .. _class_VisualServer_environment_set_background: +.. _class_VisualServer_environment_set_background: - void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** - .. _class_VisualServer_environment_set_bg_color: +.. _class_VisualServer_environment_set_bg_color: - void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** - .. _class_VisualServer_environment_set_bg_energy: +.. _class_VisualServer_environment_set_bg_energy: - void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** - .. _class_VisualServer_environment_set_canvas_max_layer: +.. _class_VisualServer_environment_set_canvas_max_layer: - void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** - .. _class_VisualServer_environment_set_dof_blur_far: +.. _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 **)** - .. _class_VisualServer_environment_set_dof_blur_near: +.. _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 **)** - .. _class_VisualServer_environment_set_fog: +.. _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 **)** - .. _class_VisualServer_environment_set_fog_depth: +.. _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 **)** - .. _class_VisualServer_environment_set_fog_height: +.. _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 **)** - .. _class_VisualServer_environment_set_glow: +.. _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 **)** - .. _class_VisualServer_environment_set_sky: +.. _class_VisualServer_environment_set_sky: - void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** - .. _class_VisualServer_environment_set_sky_custom_fov: +.. _class_VisualServer_environment_set_sky_custom_fov: - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** - .. _class_VisualServer_environment_set_ssao: +.. _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 **)** - .. _class_VisualServer_environment_set_ssr: +.. _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 **)** - .. _class_VisualServer_environment_set_tonemap: +.. _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 **)** - .. _class_VisualServer_finish: +.. _class_VisualServer_finish: - void **finish** **(** **)** Removes buffers and clears testcubes. - .. _class_VisualServer_force_draw: +.. _class_VisualServer_force_draw: - void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** - .. _class_VisualServer_force_sync: +.. _class_VisualServer_force_sync: - void **force_sync** **(** **)** Synchronizes threads. - .. _class_VisualServer_free_rid: +.. _class_VisualServer_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the VisualServer. - .. _class_VisualServer_get_render_info: +.. _class_VisualServer_get_render_info: - :ref:`int` **get_render_info** **(** :ref:`RenderInfo` info **)** Returns a certain information, see RENDER_INFO\_\* for options. - .. _class_VisualServer_get_test_cube: +.. _class_VisualServer_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: +.. _class_VisualServer_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: +.. _class_VisualServer_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: +.. _class_VisualServer_gi_probe_create: - :ref:`RID` **gi_probe_create** **(** **)** - .. _class_VisualServer_gi_probe_get_bias: +.. _class_VisualServer_gi_probe_get_bias: - :ref:`float` **gi_probe_get_bias** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_bounds: +.. _class_VisualServer_gi_probe_get_bounds: - :ref:`AABB` **gi_probe_get_bounds** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_cell_size: +.. _class_VisualServer_gi_probe_get_cell_size: - :ref:`float` **gi_probe_get_cell_size** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_dynamic_data: +.. _class_VisualServer_gi_probe_get_dynamic_data: - :ref:`PoolIntArray` **gi_probe_get_dynamic_data** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_dynamic_range: +.. _class_VisualServer_gi_probe_get_dynamic_range: - :ref:`int` **gi_probe_get_dynamic_range** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_energy: +.. _class_VisualServer_gi_probe_get_energy: - :ref:`float` **gi_probe_get_energy** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_normal_bias: +.. _class_VisualServer_gi_probe_get_normal_bias: - :ref:`float` **gi_probe_get_normal_bias** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_propagation: +.. _class_VisualServer_gi_probe_get_propagation: - :ref:`float` **gi_probe_get_propagation** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_get_to_cell_xform: +.. _class_VisualServer_gi_probe_get_to_cell_xform: - :ref:`Transform` **gi_probe_get_to_cell_xform** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_is_compressed: +.. _class_VisualServer_gi_probe_is_compressed: - :ref:`bool` **gi_probe_is_compressed** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_is_interior: +.. _class_VisualServer_gi_probe_is_interior: - :ref:`bool` **gi_probe_is_interior** **(** :ref:`RID` probe **)** const - .. _class_VisualServer_gi_probe_set_bias: +.. _class_VisualServer_gi_probe_set_bias: - void **gi_probe_set_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** - .. _class_VisualServer_gi_probe_set_bounds: +.. _class_VisualServer_gi_probe_set_bounds: - void **gi_probe_set_bounds** **(** :ref:`RID` probe, :ref:`AABB` bounds **)** - .. _class_VisualServer_gi_probe_set_cell_size: +.. _class_VisualServer_gi_probe_set_cell_size: - void **gi_probe_set_cell_size** **(** :ref:`RID` probe, :ref:`float` range **)** - .. _class_VisualServer_gi_probe_set_compress: +.. _class_VisualServer_gi_probe_set_compress: - void **gi_probe_set_compress** **(** :ref:`RID` probe, :ref:`bool` enable **)** - .. _class_VisualServer_gi_probe_set_dynamic_data: +.. _class_VisualServer_gi_probe_set_dynamic_data: - void **gi_probe_set_dynamic_data** **(** :ref:`RID` probe, :ref:`PoolIntArray` data **)** - .. _class_VisualServer_gi_probe_set_dynamic_range: +.. _class_VisualServer_gi_probe_set_dynamic_range: - void **gi_probe_set_dynamic_range** **(** :ref:`RID` probe, :ref:`int` range **)** - .. _class_VisualServer_gi_probe_set_energy: +.. _class_VisualServer_gi_probe_set_energy: - void **gi_probe_set_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** - .. _class_VisualServer_gi_probe_set_interior: +.. _class_VisualServer_gi_probe_set_interior: - void **gi_probe_set_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** - .. _class_VisualServer_gi_probe_set_normal_bias: +.. _class_VisualServer_gi_probe_set_normal_bias: - void **gi_probe_set_normal_bias** **(** :ref:`RID` probe, :ref:`float` bias **)** - .. _class_VisualServer_gi_probe_set_propagation: +.. _class_VisualServer_gi_probe_set_propagation: - void **gi_probe_set_propagation** **(** :ref:`RID` probe, :ref:`float` propagation **)** - .. _class_VisualServer_gi_probe_set_to_cell_xform: +.. _class_VisualServer_gi_probe_set_to_cell_xform: - void **gi_probe_set_to_cell_xform** **(** :ref:`RID` probe, :ref:`Transform` xform **)** - .. _class_VisualServer_has_changed: +.. _class_VisualServer_has_changed: - :ref:`bool` **has_changed** **(** **)** const Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw` is usually called if this happens. - .. _class_VisualServer_has_feature: +.. _class_VisualServer_has_feature: - :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** const - .. _class_VisualServer_has_os_feature: +.. _class_VisualServer_has_os_feature: - :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, - .. _class_VisualServer_immediate_begin: +.. _class_VisualServer_immediate_begin: - void **immediate_begin** **(** :ref:`RID` immediate, :ref:`PrimitiveType` primitive, :ref:`RID` texture **)** - .. _class_VisualServer_immediate_clear: +.. _class_VisualServer_immediate_clear: - void **immediate_clear** **(** :ref:`RID` immediate **)** - .. _class_VisualServer_immediate_color: +.. _class_VisualServer_immediate_color: - void **immediate_color** **(** :ref:`RID` immediate, :ref:`Color` color **)** - .. _class_VisualServer_immediate_create: +.. _class_VisualServer_immediate_create: - :ref:`RID` **immediate_create** **(** **)** - .. _class_VisualServer_immediate_end: +.. _class_VisualServer_immediate_end: - void **immediate_end** **(** :ref:`RID` immediate **)** - .. _class_VisualServer_immediate_get_material: +.. _class_VisualServer_immediate_get_material: - :ref:`RID` **immediate_get_material** **(** :ref:`RID` immediate **)** const - .. _class_VisualServer_immediate_normal: +.. _class_VisualServer_immediate_normal: - void **immediate_normal** **(** :ref:`RID` immediate, :ref:`Vector3` normal **)** - .. _class_VisualServer_immediate_set_material: +.. _class_VisualServer_immediate_set_material: - void **immediate_set_material** **(** :ref:`RID` immediate, :ref:`RID` material **)** - .. _class_VisualServer_immediate_tangent: +.. _class_VisualServer_immediate_tangent: - void **immediate_tangent** **(** :ref:`RID` immediate, :ref:`Plane` tangent **)** - .. _class_VisualServer_immediate_uv: +.. _class_VisualServer_immediate_uv: - void **immediate_uv** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** - .. _class_VisualServer_immediate_uv2: +.. _class_VisualServer_immediate_uv2: - void **immediate_uv2** **(** :ref:`RID` immediate, :ref:`Vector2` tex_uv **)** - .. _class_VisualServer_immediate_vertex: +.. _class_VisualServer_immediate_vertex: - void **immediate_vertex** **(** :ref:`RID` immediate, :ref:`Vector3` vertex **)** - .. _class_VisualServer_immediate_vertex_2d: +.. _class_VisualServer_immediate_vertex_2d: - void **immediate_vertex_2d** **(** :ref:`RID` immediate, :ref:`Vector2` vertex **)** - .. _class_VisualServer_init: +.. _class_VisualServer_init: - void **init** **(** **)** Initializes the visual server. - .. _class_VisualServer_instance_attach_object_instance_id: +.. _class_VisualServer_instance_attach_object_instance_id: - void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** - .. _class_VisualServer_instance_attach_skeleton: +.. _class_VisualServer_instance_attach_skeleton: - void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** - .. _class_VisualServer_instance_create: +.. _class_VisualServer_instance_create: - :ref:`RID` **instance_create** **(** **)** - .. _class_VisualServer_instance_create2: +.. _class_VisualServer_instance_create2: - :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`RID` scenario **)** - .. _class_VisualServer_instance_geometry_set_as_instance_lod: +.. _class_VisualServer_instance_geometry_set_as_instance_lod: - void **instance_geometry_set_as_instance_lod** **(** :ref:`RID` instance, :ref:`RID` as_lod_of_instance **)** - .. _class_VisualServer_instance_geometry_set_cast_shadows_setting: +.. _class_VisualServer_instance_geometry_set_cast_shadows_setting: - void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** - .. _class_VisualServer_instance_geometry_set_draw_range: +.. _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 **)** - .. _class_VisualServer_instance_geometry_set_flag: +.. _class_VisualServer_instance_geometry_set_flag: - void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** - .. _class_VisualServer_instance_geometry_set_material_override: +.. _class_VisualServer_instance_geometry_set_material_override: - void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`RID` material **)** - .. _class_VisualServer_instance_set_base: +.. _class_VisualServer_instance_set_base: - void **instance_set_base** **(** :ref:`RID` instance, :ref:`RID` base **)** - .. _class_VisualServer_instance_set_blend_shape_weight: +.. _class_VisualServer_instance_set_blend_shape_weight: - void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** - .. _class_VisualServer_instance_set_custom_aabb: +.. _class_VisualServer_instance_set_custom_aabb: - void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** - .. _class_VisualServer_instance_set_exterior: +.. _class_VisualServer_instance_set_exterior: - void **instance_set_exterior** **(** :ref:`RID` instance, :ref:`bool` enabled **)** - .. _class_VisualServer_instance_set_extra_visibility_margin: +.. _class_VisualServer_instance_set_extra_visibility_margin: - void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`float` margin **)** - .. _class_VisualServer_instance_set_layer_mask: +.. _class_VisualServer_instance_set_layer_mask: - void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** - .. _class_VisualServer_instance_set_scenario: +.. _class_VisualServer_instance_set_scenario: - void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** - .. _class_VisualServer_instance_set_surface_material: +.. _class_VisualServer_instance_set_surface_material: - void **instance_set_surface_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** - .. _class_VisualServer_instance_set_transform: +.. _class_VisualServer_instance_set_transform: - void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform` transform **)** - .. _class_VisualServer_instance_set_use_lightmap: +.. _class_VisualServer_instance_set_use_lightmap: - void **instance_set_use_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap_instance, :ref:`RID` lightmap **)** - .. _class_VisualServer_instance_set_visible: +.. _class_VisualServer_instance_set_visible: - void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** - .. _class_VisualServer_instances_cull_aabb: +.. _class_VisualServer_instances_cull_aabb: - :ref:`Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** const - .. _class_VisualServer_instances_cull_convex: +.. _class_VisualServer_instances_cull_convex: - :ref:`Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** const - .. _class_VisualServer_instances_cull_ray: +.. _class_VisualServer_instances_cull_ray: - :ref:`Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** const - .. _class_VisualServer_light_directional_set_blend_splits: +.. _class_VisualServer_light_directional_set_blend_splits: - void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`bool` enable **)** - .. _class_VisualServer_light_directional_set_shadow_depth_range_mode: +.. _class_VisualServer_light_directional_set_shadow_depth_range_mode: - void **light_directional_set_shadow_depth_range_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowDepthRangeMode` range_mode **)** - .. _class_VisualServer_light_directional_set_shadow_mode: +.. _class_VisualServer_light_directional_set_shadow_mode: - void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** - .. _class_VisualServer_light_omni_set_shadow_detail: +.. _class_VisualServer_light_omni_set_shadow_detail: - void **light_omni_set_shadow_detail** **(** :ref:`RID` light, :ref:`LightOmniShadowDetail` detail **)** - .. _class_VisualServer_light_omni_set_shadow_mode: +.. _class_VisualServer_light_omni_set_shadow_mode: - void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** - .. _class_VisualServer_light_set_color: +.. _class_VisualServer_light_set_color: - void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** - .. _class_VisualServer_light_set_cull_mask: +.. _class_VisualServer_light_set_cull_mask: - void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** - .. _class_VisualServer_light_set_negative: +.. _class_VisualServer_light_set_negative: - void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** - .. _class_VisualServer_light_set_param: +.. _class_VisualServer_light_set_param: - void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** - .. _class_VisualServer_light_set_projector: +.. _class_VisualServer_light_set_projector: - void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** - .. _class_VisualServer_light_set_reverse_cull_face_mode: +.. _class_VisualServer_light_set_reverse_cull_face_mode: - void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`bool` enabled **)** - .. _class_VisualServer_light_set_shadow: +.. _class_VisualServer_light_set_shadow: - void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** - .. _class_VisualServer_light_set_shadow_color: +.. _class_VisualServer_light_set_shadow_color: - void **light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** - .. _class_VisualServer_lightmap_capture_create: +.. _class_VisualServer_lightmap_capture_create: - :ref:`RID` **lightmap_capture_create** **(** **)** - .. _class_VisualServer_lightmap_capture_get_bounds: +.. _class_VisualServer_lightmap_capture_get_bounds: - :ref:`AABB` **lightmap_capture_get_bounds** **(** :ref:`RID` capture **)** const - .. _class_VisualServer_lightmap_capture_get_energy: +.. _class_VisualServer_lightmap_capture_get_energy: - :ref:`float` **lightmap_capture_get_energy** **(** :ref:`RID` capture **)** const - .. _class_VisualServer_lightmap_capture_get_octree: +.. _class_VisualServer_lightmap_capture_get_octree: - :ref:`PoolByteArray` **lightmap_capture_get_octree** **(** :ref:`RID` capture **)** const - .. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: +.. _class_VisualServer_lightmap_capture_get_octree_cell_subdiv: - :ref:`int` **lightmap_capture_get_octree_cell_subdiv** **(** :ref:`RID` capture **)** const - .. _class_VisualServer_lightmap_capture_get_octree_cell_transform: +.. _class_VisualServer_lightmap_capture_get_octree_cell_transform: - :ref:`Transform` **lightmap_capture_get_octree_cell_transform** **(** :ref:`RID` capture **)** const - .. _class_VisualServer_lightmap_capture_set_bounds: +.. _class_VisualServer_lightmap_capture_set_bounds: - void **lightmap_capture_set_bounds** **(** :ref:`RID` capture, :ref:`AABB` bounds **)** - .. _class_VisualServer_lightmap_capture_set_energy: +.. _class_VisualServer_lightmap_capture_set_energy: - void **lightmap_capture_set_energy** **(** :ref:`RID` capture, :ref:`float` energy **)** - .. _class_VisualServer_lightmap_capture_set_octree: +.. _class_VisualServer_lightmap_capture_set_octree: - void **lightmap_capture_set_octree** **(** :ref:`RID` capture, :ref:`PoolByteArray` octree **)** - .. _class_VisualServer_lightmap_capture_set_octree_cell_subdiv: +.. _class_VisualServer_lightmap_capture_set_octree_cell_subdiv: - void **lightmap_capture_set_octree_cell_subdiv** **(** :ref:`RID` capture, :ref:`int` subdiv **)** - .. _class_VisualServer_lightmap_capture_set_octree_cell_transform: +.. _class_VisualServer_lightmap_capture_set_octree_cell_transform: - void **lightmap_capture_set_octree_cell_transform** **(** :ref:`RID` capture, :ref:`Transform` xform **)** - .. _class_VisualServer_make_sphere_mesh: +.. _class_VisualServer_make_sphere_mesh: - :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: +.. _class_VisualServer_material_create: - :ref:`RID` **material_create** **(** **)** Returns an empty material. - .. _class_VisualServer_material_get_param: +.. _class_VisualServer_material_get_param: - :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_param_default: +.. _class_VisualServer_material_get_param_default: - :ref:`Variant` **material_get_param_default** **(** :ref:`RID` material, :ref:`String` parameter **)** const - .. _class_VisualServer_material_get_shader: +.. _class_VisualServer_material_get_shader: - :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: +.. _class_VisualServer_material_set_line_width: - void **material_set_line_width** **(** :ref:`RID` material, :ref:`float` width **)** Sets a materials line width. - .. _class_VisualServer_material_set_next_pass: +.. _class_VisualServer_material_set_next_pass: - void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** Sets an objects next material. - .. _class_VisualServer_material_set_param: +.. _class_VisualServer_material_set_param: - void **material_set_param** **(** :ref:`RID` material, :ref:`String` parameter, :ref:`Variant` value **)** Sets a materials parameter. - .. _class_VisualServer_material_set_render_priority: +.. _class_VisualServer_material_set_render_priority: - void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** Sets a material's render priority. - .. _class_VisualServer_material_set_shader: +.. _class_VisualServer_material_set_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: +.. _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 **)** Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types. - .. _class_VisualServer_mesh_clear: +.. _class_VisualServer_mesh_clear: - void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. - .. _class_VisualServer_mesh_create: +.. _class_VisualServer_mesh_create: - :ref:`RID` **mesh_create** **(** **)** Creates a new mesh. - .. _class_VisualServer_mesh_get_blend_shape_count: +.. _class_VisualServer_mesh_get_blend_shape_count: - :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: +.. _class_VisualServer_mesh_get_blend_shape_mode: - :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** const Returns a mesh's blend shape mode. - .. _class_VisualServer_mesh_get_custom_aabb: +.. _class_VisualServer_mesh_get_custom_aabb: - :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** const Returns a mesh's custom aabb. - .. _class_VisualServer_mesh_get_surface_count: +.. _class_VisualServer_mesh_get_surface_count: - :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** const Returns a mesh's number of surfaces. - .. _class_VisualServer_mesh_remove_surface: +.. _class_VisualServer_mesh_remove_surface: - void **mesh_remove_surface** **(** :ref:`RID` mesh, :ref:`int` index **)** Removes a mesh's surface. - .. _class_VisualServer_mesh_set_blend_shape_count: +.. _class_VisualServer_mesh_set_blend_shape_count: - 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: +.. _class_VisualServer_mesh_set_blend_shape_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: +.. _class_VisualServer_mesh_set_custom_aabb: - void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** Sets a mesh's custom aabb. - .. _class_VisualServer_mesh_surface_get_aabb: +.. _class_VisualServer_mesh_surface_get_aabb: - :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: +.. _class_VisualServer_mesh_surface_get_array: - :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: +.. _class_VisualServer_mesh_surface_get_array_index_len: - :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: +.. _class_VisualServer_mesh_surface_get_array_len: - :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: +.. _class_VisualServer_mesh_surface_get_arrays: - :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: +.. _class_VisualServer_mesh_surface_get_blend_shape_arrays: - :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: +.. _class_VisualServer_mesh_surface_get_format: - :ref:`int` **mesh_surface_get_format** **(** :ref:`RID` mesh, :ref:`int` surface **)** const Returns the format of a mesh's surface. - .. _class_VisualServer_mesh_surface_get_format_offset: +.. _class_VisualServer_mesh_surface_get_format_offset: - :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len, :ref:`int` array_index **)** const - .. _class_VisualServer_mesh_surface_get_format_stride: +.. _class_VisualServer_mesh_surface_get_format_stride: - :ref:`int` **mesh_surface_get_format_stride** **(** :ref:`int` format, :ref:`int` vertex_len, :ref:`int` index_len **)** const - .. _class_VisualServer_mesh_surface_get_index_array: +.. _class_VisualServer_mesh_surface_get_index_array: - :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: +.. _class_VisualServer_mesh_surface_get_material: - :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: +.. _class_VisualServer_mesh_surface_get_primitive_type: - :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: +.. _class_VisualServer_mesh_surface_get_skeleton_aabb: - :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: +.. _class_VisualServer_mesh_surface_set_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: +.. _class_VisualServer_mesh_surface_update_region: - void **mesh_surface_update_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PoolByteArray` data **)** - .. _class_VisualServer_multimesh_allocate: +.. _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 **)** - .. _class_VisualServer_multimesh_get_aabb: +.. _class_VisualServer_multimesh_get_aabb: - :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** const - .. _class_VisualServer_multimesh_get_instance_count: +.. _class_VisualServer_multimesh_get_instance_count: - :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** const - .. _class_VisualServer_multimesh_get_mesh: +.. _class_VisualServer_multimesh_get_mesh: - :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** const - .. _class_VisualServer_multimesh_get_visible_instances: +.. _class_VisualServer_multimesh_get_visible_instances: - :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** const - .. _class_VisualServer_multimesh_instance_get_color: +.. _class_VisualServer_multimesh_instance_get_color: - :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** const - .. _class_VisualServer_multimesh_instance_get_custom_data: +.. _class_VisualServer_multimesh_instance_get_custom_data: - :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** const - .. _class_VisualServer_multimesh_instance_get_transform: +.. _class_VisualServer_multimesh_instance_get_transform: - :ref:`Transform` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** const - .. _class_VisualServer_multimesh_instance_get_transform_2d: +.. _class_VisualServer_multimesh_instance_get_transform_2d: - :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** const - .. _class_VisualServer_multimesh_instance_set_color: +.. _class_VisualServer_multimesh_instance_set_color: - void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** - .. _class_VisualServer_multimesh_instance_set_custom_data: +.. _class_VisualServer_multimesh_instance_set_custom_data: - void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** - .. _class_VisualServer_multimesh_instance_set_transform: +.. _class_VisualServer_multimesh_instance_set_transform: - void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform` transform **)** - .. _class_VisualServer_multimesh_instance_set_transform_2d: +.. _class_VisualServer_multimesh_instance_set_transform_2d: - void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** - .. _class_VisualServer_multimesh_set_as_bulk_array: +.. _class_VisualServer_multimesh_set_as_bulk_array: - void **multimesh_set_as_bulk_array** **(** :ref:`RID` multimesh, :ref:`PoolRealArray` array **)** - .. _class_VisualServer_multimesh_set_mesh: +.. _class_VisualServer_multimesh_set_mesh: - void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** - .. _class_VisualServer_multimesh_set_visible_instances: +.. _class_VisualServer_multimesh_set_visible_instances: - void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`int` visible **)** - .. _class_VisualServer_omni_light_create: +.. _class_VisualServer_omni_light_create: - :ref:`RID` **omni_light_create** **(** **)** - .. _class_VisualServer_particles_create: +.. _class_VisualServer_particles_create: - :ref:`RID` **particles_create** **(** **)** - .. _class_VisualServer_particles_get_current_aabb: +.. _class_VisualServer_particles_get_current_aabb: - :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** - .. _class_VisualServer_particles_get_emitting: +.. _class_VisualServer_particles_get_emitting: - :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** - .. _class_VisualServer_particles_restart: +.. _class_VisualServer_particles_restart: - void **particles_restart** **(** :ref:`RID` particles **)** - .. _class_VisualServer_particles_set_amount: +.. _class_VisualServer_particles_set_amount: - void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** - .. _class_VisualServer_particles_set_custom_aabb: +.. _class_VisualServer_particles_set_custom_aabb: - void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** - .. _class_VisualServer_particles_set_draw_order: +.. _class_VisualServer_particles_set_draw_order: - void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** - .. _class_VisualServer_particles_set_draw_pass_mesh: +.. _class_VisualServer_particles_set_draw_pass_mesh: - void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** - .. _class_VisualServer_particles_set_draw_passes: +.. _class_VisualServer_particles_set_draw_passes: - void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** - .. _class_VisualServer_particles_set_emission_transform: +.. _class_VisualServer_particles_set_emission_transform: - void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform` transform **)** - .. _class_VisualServer_particles_set_emitting: +.. _class_VisualServer_particles_set_emitting: - void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`bool` emitting **)** - .. _class_VisualServer_particles_set_explosiveness_ratio: +.. _class_VisualServer_particles_set_explosiveness_ratio: - void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** - .. _class_VisualServer_particles_set_fixed_fps: +.. _class_VisualServer_particles_set_fixed_fps: - void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** - .. _class_VisualServer_particles_set_fractional_delta: +.. _class_VisualServer_particles_set_fractional_delta: - void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** - .. _class_VisualServer_particles_set_lifetime: +.. _class_VisualServer_particles_set_lifetime: - void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** - .. _class_VisualServer_particles_set_one_shot: +.. _class_VisualServer_particles_set_one_shot: - void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** - .. _class_VisualServer_particles_set_pre_process_time: +.. _class_VisualServer_particles_set_pre_process_time: - void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`float` time **)** - .. _class_VisualServer_particles_set_process_material: +.. _class_VisualServer_particles_set_process_material: - void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`RID` material **)** - .. _class_VisualServer_particles_set_randomness_ratio: +.. _class_VisualServer_particles_set_randomness_ratio: - void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** - .. _class_VisualServer_particles_set_speed_scale: +.. _class_VisualServer_particles_set_speed_scale: - void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** - .. _class_VisualServer_particles_set_use_local_coordinates: +.. _class_VisualServer_particles_set_use_local_coordinates: - void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** - .. _class_VisualServer_reflection_probe_create: +.. _class_VisualServer_reflection_probe_create: - :ref:`RID` **reflection_probe_create** **(** **)** - .. _class_VisualServer_reflection_probe_set_as_interior: +.. _class_VisualServer_reflection_probe_set_as_interior: - void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** - .. _class_VisualServer_reflection_probe_set_cull_mask: +.. _class_VisualServer_reflection_probe_set_cull_mask: - void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`int` layers **)** - .. _class_VisualServer_reflection_probe_set_enable_box_projection: +.. _class_VisualServer_reflection_probe_set_enable_box_projection: - void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** - .. _class_VisualServer_reflection_probe_set_enable_shadows: +.. _class_VisualServer_reflection_probe_set_enable_shadows: - void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** - .. _class_VisualServer_reflection_probe_set_extents: +.. _class_VisualServer_reflection_probe_set_extents: - void **reflection_probe_set_extents** **(** :ref:`RID` probe, :ref:`Vector3` extents **)** - .. _class_VisualServer_reflection_probe_set_intensity: +.. _class_VisualServer_reflection_probe_set_intensity: - void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** - .. _class_VisualServer_reflection_probe_set_interior_ambient: +.. _class_VisualServer_reflection_probe_set_interior_ambient: - void **reflection_probe_set_interior_ambient** **(** :ref:`RID` probe, :ref:`Color` color **)** - .. _class_VisualServer_reflection_probe_set_interior_ambient_energy: +.. _class_VisualServer_reflection_probe_set_interior_ambient_energy: - void **reflection_probe_set_interior_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** - .. _class_VisualServer_reflection_probe_set_interior_ambient_probe_contribution: +.. _class_VisualServer_reflection_probe_set_interior_ambient_probe_contribution: - void **reflection_probe_set_interior_ambient_probe_contribution** **(** :ref:`RID` probe, :ref:`float` contrib **)** - .. _class_VisualServer_reflection_probe_set_max_distance: +.. _class_VisualServer_reflection_probe_set_max_distance: - void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** - .. _class_VisualServer_reflection_probe_set_origin_offset: +.. _class_VisualServer_reflection_probe_set_origin_offset: - void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** - .. _class_VisualServer_reflection_probe_set_update_mode: +.. _class_VisualServer_reflection_probe_set_update_mode: - void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** - .. _class_VisualServer_request_frame_drawn_callback: +.. _class_VisualServer_request_frame_drawn_callback: - void **request_frame_drawn_callback** **(** :ref:`Object` where, :ref:`String` method, :ref:`Variant` userdata **)** @@ -2510,359 +2511,359 @@ Schedules a callback to the corresponding named 'method' on 'where' after a fram The callback method must use only 1 argument which will be called with 'userdata'. - .. _class_VisualServer_scenario_create: +.. _class_VisualServer_scenario_create: - :ref:`RID` **scenario_create** **(** **)** - .. _class_VisualServer_scenario_set_debug: +.. _class_VisualServer_scenario_set_debug: - void **scenario_set_debug** **(** :ref:`RID` scenario, :ref:`ScenarioDebugMode` debug_mode **)** - .. _class_VisualServer_scenario_set_environment: +.. _class_VisualServer_scenario_set_environment: - void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** - .. _class_VisualServer_scenario_set_fallback_environment: +.. _class_VisualServer_scenario_set_fallback_environment: - void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** - .. _class_VisualServer_scenario_set_reflection_atlas_size: +.. _class_VisualServer_scenario_set_reflection_atlas_size: - void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** - .. _class_VisualServer_set_boot_image: +.. _class_VisualServer_set_boot_image: - 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. - .. _class_VisualServer_set_debug_generate_wireframes: +.. _class_VisualServer_set_debug_generate_wireframes: - void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** - .. _class_VisualServer_set_default_clear_color: +.. _class_VisualServer_set_default_clear_color: - void **set_default_clear_color** **(** :ref:`Color` color **)** - .. _class_VisualServer_shader_create: +.. _class_VisualServer_shader_create: - :ref:`RID` **shader_create** **(** **)** Creates an empty shader. - .. _class_VisualServer_shader_get_code: +.. _class_VisualServer_shader_get_code: - :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** const Returns a shader's code. - .. _class_VisualServer_shader_get_default_texture_param: +.. _class_VisualServer_shader_get_default_texture_param: - :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: +.. _class_VisualServer_shader_get_param_list: - :ref:`Array` **shader_get_param_list** **(** :ref:`RID` shader **)** const Returns the parameters of a shader. - .. _class_VisualServer_shader_set_code: +.. _class_VisualServer_shader_set_code: - void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** Sets a shader's code. - .. _class_VisualServer_shader_set_default_texture_param: +.. _class_VisualServer_shader_set_default_texture_param: - 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: +.. _class_VisualServer_skeleton_allocate: - void **skeleton_allocate** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** - .. _class_VisualServer_skeleton_bone_get_transform: +.. _class_VisualServer_skeleton_bone_get_transform: - :ref:`Transform` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const - .. _class_VisualServer_skeleton_bone_get_transform_2d: +.. _class_VisualServer_skeleton_bone_get_transform_2d: - :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** const - .. _class_VisualServer_skeleton_bone_set_transform: +.. _class_VisualServer_skeleton_bone_set_transform: - void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform` transform **)** - .. _class_VisualServer_skeleton_bone_set_transform_2d: +.. _class_VisualServer_skeleton_bone_set_transform_2d: - void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** - .. _class_VisualServer_skeleton_create: +.. _class_VisualServer_skeleton_create: - :ref:`RID` **skeleton_create** **(** **)** - .. _class_VisualServer_skeleton_get_bone_count: +.. _class_VisualServer_skeleton_get_bone_count: - :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** const - .. _class_VisualServer_sky_create: +.. _class_VisualServer_sky_create: - :ref:`RID` **sky_create** **(** **)** Creates an empty sky. - .. _class_VisualServer_sky_set_texture: +.. _class_VisualServer_sky_set_texture: - 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: +.. _class_VisualServer_spot_light_create: - :ref:`RID` **spot_light_create** **(** **)** - .. _class_VisualServer_sync: +.. _class_VisualServer_sync: - void **sync** **(** **)** - .. _class_VisualServer_texture_allocate: +.. _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 **)** - .. _class_VisualServer_texture_create: +.. _class_VisualServer_texture_create: - :ref:`RID` **texture_create** **(** **)** Creates an empty texture. - .. _class_VisualServer_texture_create_from_image: +.. _class_VisualServer_texture_create_from_image: - :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: +.. _class_VisualServer_texture_debug_usage: - :ref:`Array` **texture_debug_usage** **(** **)** Returns a list of all the textures and their information. - .. _class_VisualServer_texture_get_data: +.. _class_VisualServer_texture_get_data: - :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. - .. _class_VisualServer_texture_get_depth: +.. _class_VisualServer_texture_get_depth: - :ref:`int` **texture_get_depth** **(** :ref:`RID` texture **)** const - .. _class_VisualServer_texture_get_flags: +.. _class_VisualServer_texture_get_flags: - :ref:`int` **texture_get_flags** **(** :ref:`RID` texture **)** const Returns the flags of a texture. - .. _class_VisualServer_texture_get_format: +.. _class_VisualServer_texture_get_format: - :ref:`Format` **texture_get_format** **(** :ref:`RID` texture **)** const Returns the format of the texture's image. - .. _class_VisualServer_texture_get_height: +.. _class_VisualServer_texture_get_height: - :ref:`int` **texture_get_height** **(** :ref:`RID` texture **)** const Returns the texture's height. - .. _class_VisualServer_texture_get_path: +.. _class_VisualServer_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** const Returns the texture's path. - .. _class_VisualServer_texture_get_texid: +.. _class_VisualServer_texture_get_texid: - :ref:`int` **texture_get_texid** **(** :ref:`RID` texture **)** const Returns the opengl id of the texture's image. - .. _class_VisualServer_texture_get_type: +.. _class_VisualServer_texture_get_type: - :ref:`TextureType` **texture_get_type** **(** :ref:`RID` texture **)** const - .. _class_VisualServer_texture_get_width: +.. _class_VisualServer_texture_get_width: - :ref:`int` **texture_get_width** **(** :ref:`RID` texture **)** const Returns the texture's width. - .. _class_VisualServer_texture_set_data: +.. _class_VisualServer_texture_set_data: - 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: +.. _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 **)** - .. _class_VisualServer_texture_set_flags: +.. _class_VisualServer_texture_set_flags: - void **texture_set_flags** **(** :ref:`RID` texture, :ref:`int` flags **)** Sets the texture's flags. See :ref:`TextureFlags` for options - .. _class_VisualServer_texture_set_path: +.. _class_VisualServer_texture_set_path: - void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** Sets the texture's path. - .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: +.. _class_VisualServer_texture_set_shrink_all_x2_on_set_data: - 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. - .. _class_VisualServer_texture_set_size_override: +.. _class_VisualServer_texture_set_size_override: - void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height, :ref:`int` depth **)** - .. _class_VisualServer_textures_keep_original: +.. _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. - .. _class_VisualServer_viewport_attach_camera: +.. _class_VisualServer_viewport_attach_camera: - void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** Sets a viewport's camera. - .. _class_VisualServer_viewport_attach_canvas: +.. _class_VisualServer_viewport_attach_canvas: - void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Sets a viewport's canvas. - .. _class_VisualServer_viewport_attach_to_screen: +.. _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 **)** Attaches a viewport to a screen. - .. _class_VisualServer_viewport_create: +.. _class_VisualServer_viewport_create: - :ref:`RID` **viewport_create** **(** **)** Creates an empty viewport. - .. _class_VisualServer_viewport_detach: +.. _class_VisualServer_viewport_detach: - void **viewport_detach** **(** :ref:`RID` viewport **)** Detaches the viewport from the screen. - .. _class_VisualServer_viewport_get_render_info: +.. _class_VisualServer_viewport_get_render_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: +.. _class_VisualServer_viewport_get_texture: - :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** const Returns the viewport's last rendered frame. - .. _class_VisualServer_viewport_remove_canvas: +.. _class_VisualServer_viewport_remove_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: +.. _class_VisualServer_viewport_set_active: - void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** If ``true`` sets the viewport active, else sets it inactive. - .. _class_VisualServer_viewport_set_canvas_layer: +.. _class_VisualServer_viewport_set_canvas_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: +.. _class_VisualServer_viewport_set_canvas_transform: - 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: +.. _class_VisualServer_viewport_set_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: +.. _class_VisualServer_viewport_set_debug_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: +.. _class_VisualServer_viewport_set_disable_3d: - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true`` a viewport's 3D rendering is disabled. - .. _class_VisualServer_viewport_set_disable_environment: +.. _class_VisualServer_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** If ``true`` rendering of a viewport's environment is disabled. - .. _class_VisualServer_viewport_set_global_canvas_transform: +.. _class_VisualServer_viewport_set_global_canvas_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: +.. _class_VisualServer_viewport_set_hdr: - void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true`` the viewport renders to hdr. - .. _class_VisualServer_viewport_set_hide_canvas: +.. _class_VisualServer_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** If ``true`` the viewport's canvas is not rendered. - .. _class_VisualServer_viewport_set_hide_scenario: +.. _class_VisualServer_viewport_set_hide_scenario: - void **viewport_set_hide_scenario** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** - .. _class_VisualServer_viewport_set_msaa: +.. _class_VisualServer_viewport_set_msaa: - void **viewport_set_msaa** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** Sets the anti-aliasing mode. see :ref:`ViewportMSAA` for options. - .. _class_VisualServer_viewport_set_parent_viewport: +.. _class_VisualServer_viewport_set_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: +.. _class_VisualServer_viewport_set_scenario: - void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** @@ -2870,49 +2871,49 @@ Sets a viewport's scenario. The scenario contains information about the :ref:`ScenarioDebugMode`, environment information, reflection atlas etc. - .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision: +.. _class_VisualServer_viewport_set_shadow_atlas_quadrant_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: +.. _class_VisualServer_viewport_set_shadow_atlas_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: +.. _class_VisualServer_viewport_set_size: - 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: +.. _class_VisualServer_viewport_set_transparent_background: - void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true`` the viewport renders its background as transparent. - .. _class_VisualServer_viewport_set_update_mode: +.. _class_VisualServer_viewport_set_update_mode: - void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. - .. _class_VisualServer_viewport_set_usage: +.. _class_VisualServer_viewport_set_usage: - void **viewport_set_usage** **(** :ref:`RID` viewport, :ref:`ViewportUsage` usage **)** Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` constants for options. - .. _class_VisualServer_viewport_set_use_arvr: +.. _class_VisualServer_viewport_set_use_arvr: - void **viewport_set_use_arvr** **(** :ref:`RID` viewport, :ref:`bool` use_arvr **)** If ``true`` the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. - .. _class_VisualServer_viewport_set_vflip: +.. _class_VisualServer_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 66b8f12e8..bc958e66f 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -57,7 +57,7 @@ Methods Enumerations ------------ - .. _enum_VisualShader_Type: +.. _enum_VisualShader_Type: enum **Type**: @@ -71,10 +71,11 @@ Constants - **NODE_ID_INVALID** = **-1** - **NODE_ID_OUTPUT** = **0** + Property Descriptions --------------------- - .. _class_VisualShader_graph_offset: +.. _class_VisualShader_graph_offset: - :ref:`Vector2` **graph_offset** @@ -87,55 +88,55 @@ Property Descriptions Method Descriptions ------------------- - .. _class_VisualShader_add_node: +.. _class_VisualShader_add_node: - void **add_node** **(** :ref:`Type` type, :ref:`VisualShaderNode` node, :ref:`Vector2` position, :ref:`int` id **)** - .. _class_VisualShader_can_connect_nodes: +.. _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 - .. _class_VisualShader_connect_nodes: +.. _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 **)** - .. _class_VisualShader_disconnect_nodes: +.. _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 **)** - .. _class_VisualShader_get_node: +.. _class_VisualShader_get_node: - :ref:`VisualShaderNode` **get_node** **(** :ref:`Type` type, :ref:`int` id **)** const - .. _class_VisualShader_get_node_connections: +.. _class_VisualShader_get_node_connections: - :ref:`Array` **get_node_connections** **(** :ref:`Type` type **)** const - .. _class_VisualShader_get_node_list: +.. _class_VisualShader_get_node_list: - :ref:`PoolIntArray` **get_node_list** **(** :ref:`Type` type **)** const - .. _class_VisualShader_get_node_position: +.. _class_VisualShader_get_node_position: - :ref:`Vector2` **get_node_position** **(** :ref:`Type` type, :ref:`int` id **)** const - .. _class_VisualShader_get_valid_node_id: +.. _class_VisualShader_get_valid_node_id: - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** const - .. _class_VisualShader_is_node_connection: +.. _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 - .. _class_VisualShader_remove_node: +.. _class_VisualShader_remove_node: - void **remove_node** **(** :ref:`Type` type, :ref:`int` id **)** - .. _class_VisualShader_set_mode: +.. _class_VisualShader_set_mode: - void **set_mode** **(** :ref:`Mode` mode **)** - .. _class_VisualShader_set_node_position: +.. _class_VisualShader_set_node_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 10a08f154..7f0577bf1 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -39,18 +39,18 @@ Methods Signals ------- - .. _class_VisualShaderNode_editor_refresh_request: +.. _class_VisualShaderNode_editor_refresh_request: - **editor_refresh_request** **(** **)** Property Descriptions --------------------- - .. _class_VisualShaderNode_default_input_values: +.. _class_VisualShaderNode_default_input_values: - :ref:`Array` **default_input_values** - .. _class_VisualShaderNode_output_port_for_preview: +.. _class_VisualShaderNode_output_port_for_preview: - :ref:`int` **output_port_for_preview** @@ -63,11 +63,11 @@ Property Descriptions Method Descriptions ------------------- - .. _class_VisualShaderNode_get_input_port_default_value: +.. _class_VisualShaderNode_get_input_port_default_value: - :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** const - .. _class_VisualShaderNode_set_input_port_default_value: +.. _class_VisualShaderNode_set_input_port_default_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 1960514d9..b53c02d1d 100644 --- a/classes/class_visualshadernodecolorconstant.rst +++ b/classes/class_visualshadernodecolorconstant.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualShaderNodeColorConstant_constant: +.. _class_VisualShaderNodeColorConstant_constant: - :ref:`Color` **constant** diff --git a/classes/class_visualshadernodecolorop.rst b/classes/class_visualshadernodecolorop.rst index d209eb167..9a9d9a545 100644 --- a/classes/class_visualshadernodecolorop.rst +++ b/classes/class_visualshadernodecolorop.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeColorOp_Operator: +.. _enum_VisualShaderNodeColorOp_Operator: enum **Operator**: @@ -43,7 +43,7 @@ enum **Operator**: Property Descriptions --------------------- - .. _class_VisualShaderNodeColorOp_operator: +.. _class_VisualShaderNodeColorOp_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodecubemap.rst b/classes/class_visualshadernodecubemap.rst index 3d7293116..2a1a0032d 100644 --- a/classes/class_visualshadernodecubemap.rst +++ b/classes/class_visualshadernodecubemap.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeCubeMap_TextureType: +.. _enum_VisualShaderNodeCubeMap_TextureType: enum **TextureType**: @@ -39,7 +39,7 @@ enum **TextureType**: Property Descriptions --------------------- - .. _class_VisualShaderNodeCubeMap_cube_map: +.. _class_VisualShaderNodeCubeMap_cube_map: - :ref:`CubeMap` **cube_map** @@ -49,7 +49,7 @@ Property Descriptions | *Getter* | get_cube_map() | +----------+---------------------+ - .. _class_VisualShaderNodeCubeMap_texture_type: +.. _class_VisualShaderNodeCubeMap_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodeinput.rst b/classes/class_visualshadernodeinput.rst index 1259b8883..2fb7c39e3 100644 --- a/classes/class_visualshadernodeinput.rst +++ b/classes/class_visualshadernodeinput.rst @@ -26,14 +26,14 @@ Properties Signals ------- - .. _class_VisualShaderNodeInput_input_type_changed: +.. _class_VisualShaderNodeInput_input_type_changed: - **input_type_changed** **(** **)** Property Descriptions --------------------- - .. _class_VisualShaderNodeInput_input_name: +.. _class_VisualShaderNodeInput_input_name: - :ref:`String` **input_name** diff --git a/classes/class_visualshadernodescalarconstant.rst b/classes/class_visualshadernodescalarconstant.rst index a26db5837..8e9d76abe 100644 --- a/classes/class_visualshadernodescalarconstant.rst +++ b/classes/class_visualshadernodescalarconstant.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualShaderNodeScalarConstant_constant: +.. _class_VisualShaderNodeScalarConstant_constant: - :ref:`float` **constant** diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index 74e1a50e6..b241cd34a 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeScalarFunc_Function: +.. _enum_VisualShaderNodeScalarFunc_Function: enum **Function**: @@ -54,7 +54,7 @@ enum **Function**: Property Descriptions --------------------- - .. _class_VisualShaderNodeScalarFunc_function: +.. _class_VisualShaderNodeScalarFunc_function: - :ref:`Function` **function** diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index 9b6f0ecc4..136da6028 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeScalarOp_Operator: +.. _enum_VisualShaderNodeScalarOp_Operator: enum **Operator**: @@ -43,7 +43,7 @@ enum **Operator**: Property Descriptions --------------------- - .. _class_VisualShaderNodeScalarOp_operator: +.. _class_VisualShaderNodeScalarOp_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodetexture.rst b/classes/class_visualshadernodetexture.rst index fa9036719..fc7d4b2d3 100644 --- a/classes/class_visualshadernodetexture.rst +++ b/classes/class_visualshadernodetexture.rst @@ -30,7 +30,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeTexture_Source: +.. _enum_VisualShaderNodeTexture_Source: enum **Source**: @@ -39,7 +39,7 @@ enum **Source**: - **SOURCE_2D_TEXTURE** = **2** - **SOURCE_2D_NORMAL** = **3** - .. _enum_VisualShaderNodeTexture_TextureType: +.. _enum_VisualShaderNodeTexture_TextureType: enum **TextureType**: @@ -50,7 +50,7 @@ enum **TextureType**: Property Descriptions --------------------- - .. _class_VisualShaderNodeTexture_source: +.. _class_VisualShaderNodeTexture_source: - :ref:`Source` **source** @@ -60,7 +60,7 @@ Property Descriptions | *Getter* | get_source() | +----------+-------------------+ - .. _class_VisualShaderNodeTexture_texture: +.. _class_VisualShaderNodeTexture_texture: - :ref:`Texture` **texture** @@ -70,7 +70,7 @@ Property Descriptions | *Getter* | get_texture() | +----------+--------------------+ - .. _class_VisualShaderNodeTexture_texture_type: +.. _class_VisualShaderNodeTexture_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst index ffc4e4152..a1861718e 100644 --- a/classes/class_visualshadernodetextureuniform.rst +++ b/classes/class_visualshadernodetextureuniform.rst @@ -28,7 +28,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeTextureUniform_TextureType: +.. _enum_VisualShaderNodeTextureUniform_TextureType: enum **TextureType**: @@ -37,7 +37,7 @@ enum **TextureType**: - **TYPE_NORMALMAP** = **2** - **TYPE_ANISO** = **3** - .. _enum_VisualShaderNodeTextureUniform_ColorDefault: +.. _enum_VisualShaderNodeTextureUniform_ColorDefault: enum **ColorDefault**: @@ -47,7 +47,7 @@ enum **ColorDefault**: Property Descriptions --------------------- - .. _class_VisualShaderNodeTextureUniform_color_default: +.. _class_VisualShaderNodeTextureUniform_color_default: - :ref:`ColorDefault` **color_default** @@ -57,7 +57,7 @@ Property Descriptions | *Getter* | get_color_default() | +----------+--------------------------+ - .. _class_VisualShaderNodeTextureUniform_texture_type: +.. _class_VisualShaderNodeTextureUniform_texture_type: - :ref:`TextureType` **texture_type** diff --git a/classes/class_visualshadernodetransformconstant.rst b/classes/class_visualshadernodetransformconstant.rst index e1a818747..fab7ab702 100644 --- a/classes/class_visualshadernodetransformconstant.rst +++ b/classes/class_visualshadernodetransformconstant.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualShaderNodeTransformConstant_constant: +.. _class_VisualShaderNodeTransformConstant_constant: - :ref:`Transform` **constant** diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 2cb33d6af..ea3c67471 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeTransformMult_Operator: +.. _enum_VisualShaderNodeTransformMult_Operator: enum **Operator**: @@ -36,7 +36,7 @@ enum **Operator**: Property Descriptions --------------------- - .. _class_VisualShaderNodeTransformMult_operator: +.. _class_VisualShaderNodeTransformMult_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodetransformvecmult.rst b/classes/class_visualshadernodetransformvecmult.rst index 8fa7d9e61..f02efe98e 100644 --- a/classes/class_visualshadernodetransformvecmult.rst +++ b/classes/class_visualshadernodetransformvecmult.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeTransformVecMult_Operator: +.. _enum_VisualShaderNodeTransformVecMult_Operator: enum **Operator**: @@ -38,7 +38,7 @@ enum **Operator**: Property Descriptions --------------------- - .. _class_VisualShaderNodeTransformVecMult_operator: +.. _class_VisualShaderNodeTransformVecMult_operator: - :ref:`Operator` **operator** diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index d6594fc88..50200da9b 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -28,7 +28,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualShaderNodeUniform_uniform_name: +.. _class_VisualShaderNodeUniform_uniform_name: - :ref:`String` **uniform_name** diff --git a/classes/class_visualshadernodevec3constant.rst b/classes/class_visualshadernodevec3constant.rst index 7a2ac555c..ba1717f47 100644 --- a/classes/class_visualshadernodevec3constant.rst +++ b/classes/class_visualshadernodevec3constant.rst @@ -26,7 +26,7 @@ Properties Property Descriptions --------------------- - .. _class_VisualShaderNodeVec3Constant_constant: +.. _class_VisualShaderNodeVec3Constant_constant: - :ref:`Vector3` **constant** diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index 60bafd846..3cb402938 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeVectorFunc_Function: +.. _enum_VisualShaderNodeVectorFunc_Function: enum **Function**: @@ -40,7 +40,7 @@ enum **Function**: Property Descriptions --------------------- - .. _class_VisualShaderNodeVectorFunc_function: +.. _class_VisualShaderNodeVectorFunc_function: - :ref:`Function` **function** diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index 28cc5f24f..ab7da8ad9 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -26,7 +26,7 @@ Properties Enumerations ------------ - .. _enum_VisualShaderNodeVectorOp_Operator: +.. _enum_VisualShaderNodeVectorOp_Operator: enum **Operator**: @@ -43,7 +43,7 @@ enum **Operator**: Property Descriptions --------------------- - .. _class_VisualShaderNodeVectorOp_operator: +.. _class_VisualShaderNodeVectorOp_operator: - :ref:`Operator` **operator** diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 7003b2d06..5460ea159 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -31,7 +31,7 @@ A weakref can hold a :ref:`Reference`, without contributing to Method Descriptions ------------------- - .. _class_WeakRef_get_ref: +.. _class_WeakRef_get_ref: - :ref:`Variant` **get_ref** **(** **)** const diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 34e8e9c5c..031a0e271 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -35,25 +35,25 @@ Methods Signals ------- - .. _class_WebSocketClient_connection_closed: +.. _class_WebSocketClient_connection_closed: - **connection_closed** **(** **)** Emitted when the connection to the server is closed. - .. _class_WebSocketClient_connection_error: +.. _class_WebSocketClient_connection_error: - **connection_error** **(** **)** Emitted when the connection to the server fails. - .. _class_WebSocketClient_connection_established: +.. _class_WebSocketClient_connection_established: - **connection_established** **(** :ref:`String` protocol **)** Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server. - .. _class_WebSocketClient_data_received: +.. _class_WebSocketClient_data_received: - **data_received** **(** **)** @@ -73,7 +73,7 @@ You will received appropriate signals when connecting, disconnecting, or when ne Property Descriptions --------------------- - .. _class_WebSocketClient_verify_ssl: +.. _class_WebSocketClient_verify_ssl: - :ref:`bool` **verify_ssl** @@ -88,7 +88,7 @@ Enable or disable SSL certificate verification. Note: You must specify the certi Method Descriptions ------------------- - .. _class_WebSocketClient_connect_to_url: +.. _class_WebSocketClient_connect_to_url: - :ref:`Error` **connect_to_url** **(** :ref:`String` url, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** @@ -96,7 +96,7 @@ Connect to the given URL requesting one of the given ``protocols`` as sub-protoc If ``true`` is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connections 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: +.. _class_WebSocketClient_disconnect_from_host: - void **disconnect_from_host** **(** **)** diff --git a/classes/class_websocketmultiplayerpeer.rst b/classes/class_websocketmultiplayerpeer.rst index 208f910c3..11c112375 100644 --- a/classes/class_websocketmultiplayerpeer.rst +++ b/classes/class_websocketmultiplayerpeer.rst @@ -28,7 +28,7 @@ Methods Signals ------- - .. _class_WebSocketMultiplayerPeer_peer_packet: +.. _class_WebSocketMultiplayerPeer_peer_packet: - **peer_packet** **(** :ref:`int` peer_source **)** @@ -42,7 +42,7 @@ Base class for WebSocket server and client, allowing them to be used as network Method Descriptions ------------------- - .. _class_WebSocketMultiplayerPeer_get_peer: +.. _class_WebSocketMultiplayerPeer_get_peer: - :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** const diff --git a/classes/class_websocketpeer.rst b/classes/class_websocketpeer.rst index b610cb9d3..9ada97446 100644 --- a/classes/class_websocketpeer.rst +++ b/classes/class_websocketpeer.rst @@ -38,7 +38,7 @@ Methods Enumerations ------------ - .. _enum_WebSocketPeer_WriteMode: +.. _enum_WebSocketPeer_WriteMode: enum **WriteMode**: @@ -55,43 +55,43 @@ You can choose to write to the socket in binary or text mode, and you can recogn Method Descriptions ------------------- - .. _class_WebSocketPeer_close: +.. _class_WebSocketPeer_close: - void **close** **(** **)** Close this WebSocket connection, actively disconnecting the peer. - .. _class_WebSocketPeer_get_connected_host: +.. _class_WebSocketPeer_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Returns the IP Address of the connected peer. (Not available in HTML5 export) - .. _class_WebSocketPeer_get_connected_port: +.. _class_WebSocketPeer_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Returns the remote port of the connected peer. (Not available in HTML5 export) - .. _class_WebSocketPeer_get_write_mode: +.. _class_WebSocketPeer_get_write_mode: - :ref:`WriteMode` **get_write_mode** **(** **)** const Get the current selected write mode. See :ref:`WriteMode`. - .. _class_WebSocketPeer_is_connected_to_host: +.. _class_WebSocketPeer_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const Returns ``true`` if this peer is currently connected. - .. _class_WebSocketPeer_set_write_mode: +.. _class_WebSocketPeer_set_write_mode: - void **set_write_mode** **(** :ref:`WriteMode` mode **)** Sets the socket to use the given :ref:`WriteMode`. - .. _class_WebSocketPeer_was_string_packet: +.. _class_WebSocketPeer_was_string_packet: - :ref:`bool` **was_string_packet** **(** **)** const diff --git a/classes/class_websocketserver.rst b/classes/class_websocketserver.rst index 85da3b5aa..9c5a46474 100644 --- a/classes/class_websocketserver.rst +++ b/classes/class_websocketserver.rst @@ -38,19 +38,19 @@ Methods Signals ------- - .. _class_WebSocketServer_client_connected: +.. _class_WebSocketServer_client_connected: - **client_connected** **(** :ref:`int` id, :ref:`String` protocol **)** Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client. - .. _class_WebSocketServer_client_disconnected: +.. _class_WebSocketServer_client_disconnected: - **client_disconnected** **(** :ref:`int` id **)** Emitted when a client disconnects. - .. _class_WebSocketServer_data_received: +.. _class_WebSocketServer_data_received: - **data_received** **(** :ref:`int` id **)** @@ -68,37 +68,37 @@ Note: This class will not work in HTML5 exports due to browser restrictions. Method Descriptions ------------------- - .. _class_WebSocketServer_disconnect_peer: +.. _class_WebSocketServer_disconnect_peer: - void **disconnect_peer** **(** :ref:`int` id **)** Disconnects the given peer. - .. _class_WebSocketServer_get_peer_address: +.. _class_WebSocketServer_get_peer_address: - :ref:`String` **get_peer_address** **(** :ref:`int` id **)** const Returns the IP address of the given peer. - .. _class_WebSocketServer_get_peer_port: +.. _class_WebSocketServer_get_peer_port: - :ref:`int` **get_peer_port** **(** :ref:`int` id **)** const Returns the remote port of the given peer. - .. _class_WebSocketServer_has_peer: +.. _class_WebSocketServer_has_peer: - :ref:`bool` **has_peer** **(** :ref:`int` id **)** const Returns ``true`` if a peer with the given ID is connected. - .. _class_WebSocketServer_is_listening: +.. _class_WebSocketServer_is_listening: - :ref:`bool` **is_listening** **(** **)** const Returns ``true`` if the server is actively listening on a port. - .. _class_WebSocketServer_listen: +.. _class_WebSocketServer_listen: - :ref:`Error` **listen** **(** :ref:`int` port, :ref:`PoolStringArray` protocols=PoolStringArray( ), :ref:`bool` gd_mp_api=false **)** @@ -108,7 +108,7 @@ You can specify the desired subprotocols via the "protocols" array. If the list 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: +.. _class_WebSocketServer_stop: - void **stop** **(** **)** diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index d8db75763..f789bd940 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -65,7 +65,7 @@ Windowdialog is the base class for all window-based dialogs. It's a by-default t Property Descriptions --------------------- - .. _class_WindowDialog_resizable: +.. _class_WindowDialog_resizable: - :ref:`bool` **resizable** @@ -77,7 +77,7 @@ Property Descriptions If ``true`` the user can resize the window. Default value: ``false``. - .. _class_WindowDialog_window_title: +.. _class_WindowDialog_window_title: - :ref:`String` **window_title** @@ -92,7 +92,7 @@ The text displayed in the window's title bar. Method Descriptions ------------------- - .. _class_WindowDialog_get_close_button: +.. _class_WindowDialog_get_close_button: - :ref:`TextureButton` **get_close_button** **(** **)** diff --git a/classes/class_world.rst b/classes/class_world.rst index 3766495dd..5ad4bf8c7 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -40,10 +40,11 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` + Property Descriptions --------------------- - .. _class_World_direct_space_state: +.. _class_World_direct_space_state: - :ref:`PhysicsDirectSpaceState` **direct_space_state** @@ -53,7 +54,7 @@ Property Descriptions The World's physics direct space state, used for making various queries. Might be used only during ``_physics_process``. - .. _class_World_environment: +.. _class_World_environment: - :ref:`Environment` **environment** @@ -65,7 +66,7 @@ The World's physics direct space state, used for making various queries. Might b The World's :ref:`Environment`. - .. _class_World_fallback_environment: +.. _class_World_fallback_environment: - :ref:`Environment` **fallback_environment** @@ -77,7 +78,7 @@ The World's :ref:`Environment`. The World's fallback_environment will be used if the World's :ref:`Environment` fails or is missing. - .. _class_World_scenario: +.. _class_World_scenario: - :ref:`RID` **scenario** @@ -87,7 +88,7 @@ The World's fallback_environment will be used if the World's :ref:`Environment` **space** diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 49d7136fb..707235d6f 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -36,10 +36,11 @@ Tutorials --------- - :doc:`../tutorials/physics/ray-casting` + Property Descriptions --------------------- - .. _class_World2D_canvas: +.. _class_World2D_canvas: - :ref:`RID` **canvas** @@ -49,7 +50,7 @@ Property Descriptions The :ref:`RID` of this world's canvas resource. Used by the :ref:`VisualServer` for 2D drawing. - .. _class_World2D_direct_space_state: +.. _class_World2D_direct_space_state: - :ref:`Physics2DDirectSpaceState` **direct_space_state** @@ -59,7 +60,7 @@ The :ref:`RID` of this world's canvas resource. Used by the :ref:`Vis The state of this world's physics space. This allows arbitrary querying for collision. - .. _class_World2D_space: +.. _class_World2D_space: - :ref:`RID` **space** diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 0004abb58..55c9ea837 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -36,10 +36,11 @@ Tutorials --------- - :doc:`../tutorials/3d/environment_and_post_processing` + Property Descriptions --------------------- - .. _class_WorldEnvironment_environment: +.. _class_WorldEnvironment_environment: - :ref:`Environment` **environment** diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index cf47e40b7..a70ce5903 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -58,7 +58,7 @@ Methods Enumerations ------------ - .. _enum_XMLParser_NodeType: +.. _enum_XMLParser_NodeType: enum **NodeType**: @@ -78,103 +78,103 @@ This class can serve as base to make custom XML parsers. Since XML is a very fle Method Descriptions ------------------- - .. _class_XMLParser_get_attribute_count: +.. _class_XMLParser_get_attribute_count: - :ref:`int` **get_attribute_count** **(** **)** const Get the amount of attributes in the current element. - .. _class_XMLParser_get_attribute_name: +.. _class_XMLParser_get_attribute_name: - :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: +.. _class_XMLParser_get_attribute_value: - :ref:`String` **get_attribute_value** **(** :ref:`int` idx **)** const Get the value of the attribute specified by the index in ``idx`` argument. - .. _class_XMLParser_get_current_line: +.. _class_XMLParser_get_current_line: - :ref:`int` **get_current_line** **(** **)** const Get the current line in the parsed file (currently not implemented). - .. _class_XMLParser_get_named_attribute_value: +.. _class_XMLParser_get_named_attribute_value: - :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: +.. _class_XMLParser_get_named_attribute_value_safe: - :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. - .. _class_XMLParser_get_node_data: +.. _class_XMLParser_get_node_data: - :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: +.. _class_XMLParser_get_node_name: - :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`` - .. _class_XMLParser_get_node_offset: +.. _class_XMLParser_get_node_offset: - :ref:`int` **get_node_offset** **(** **)** const Get the byte offset of the current node since the beginning of the file or buffer. - .. _class_XMLParser_get_node_type: +.. _class_XMLParser_get_node_type: - :ref:`NodeType` **get_node_type** **(** **)** Get the type of the current node. Compare with ``NODE_*`` constants. - .. _class_XMLParser_has_attribute: +.. _class_XMLParser_has_attribute: - :ref:`bool` **has_attribute** **(** :ref:`String` name **)** const Check whether or not the current element has a certain attribute. - .. _class_XMLParser_is_empty: +.. _class_XMLParser_is_empty: - :ref:`bool` **is_empty** **(** **)** const Check whether the current element is empty (this only works for completely empty tags, e.g. ). - .. _class_XMLParser_open: +.. _class_XMLParser_open: - :ref:`Error` **open** **(** :ref:`String` file **)** Open a XML file for parsing. This returns an error code. - .. _class_XMLParser_open_buffer: +.. _class_XMLParser_open_buffer: - :ref:`Error` **open_buffer** **(** :ref:`PoolByteArray` buffer **)** Open a XML raw buffer for parsing. This returns an error code. - .. _class_XMLParser_read: +.. _class_XMLParser_read: - :ref:`Error` **read** **(** **)** Read the next node of the file. This returns an error code. - .. _class_XMLParser_seek: +.. _class_XMLParser_seek: - :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. - .. _class_XMLParser_skip_section: +.. _class_XMLParser_skip_section: - void **skip_section** **(** **)** diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index f3211aa68..a9b2251b7 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -31,7 +31,7 @@ Sort all child nodes based on their Y positions. The child node must inherit fro Property Descriptions --------------------- - .. _class_YSort_sort_enabled: +.. _class_YSort_sort_enabled: - :ref:`bool` **sort_enabled**