diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 0f2f81535..7020a05f7 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the @GDScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_@GDScript: @@ -77,9 +78,9 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`inverse_lerp` **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`is_inf` **(** :ref:`float` s **)** | +| :ref:`bool` | :ref:`is_inf` **(** :ref:`float` s **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`is_nan` **(** :ref:`float` s **)** | +| :ref:`bool` | :ref:`is_nan` **(** :ref:`float` s **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -191,117 +192,228 @@ Member Function Description - :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** -Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. +Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. + +``r8`` red channel + +``g8`` green channel + +``b8`` blue channel + +``a8`` alpha channel + +:: + + red = Color8(255, 0, 0) .. _class_@GDScript_ColorN: - :ref:`Color` **ColorN** **(** :ref:`String` name, :ref:`float` alpha **)** +Returns color ``name`` with ``alpha`` ranging from 0 to 1. Note: ``name`` is defined in color_names.inc. + +:: + + red = ColorN('red') + .. _class_@GDScript_abs: - :ref:`float` **abs** **(** :ref:`float` s **)** -Returns the absolute value of parameter s (i.e. unsigned value, works for integer and float). +Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for integer and float). + +:: + + # a is 1 + a = abs(-1) .. _class_@GDScript_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** -Returns the principal value of the arc cosine of s, expressed in radians. In trigonometrics, arc cosine is the inverse operation of cosine. +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: - :ref:`float` **asin** **(** :ref:`float` s **)** -Returns the principal value of the arc sine of s, expressed in radians. In trigonometrics, arc sine is the inverse operation of sine. +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: - void **assert** **(** :ref:`bool` condition **)** -Assert that the condition is true. If the condition is false, generates an error. +Assert that the ``condition`` is true. If the ``condition`` is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true. + +:: + + # Speed should always be between 0 and 20 + speed = -10 + assert(speed < 20) # Is true and program continues + assert(speed >= 0) # Is false and program stops + assert(speed >= 0 && speed < 20) # Or combined .. _class_@GDScript_atan: - :ref:`float` **atan** **(** :ref:`float` s **)** -Returns the principal value of the arc tangent of s, expressed in radians. In trigonometrics, arc tangent is the inverse operation of tangent. Notice that because of the sign ambiguity, the function cannot determine with certainty in which quadrant the angle falls only by its tangent value. See :ref:`atan2` for an alternative that takes a fractional argument instead. +Returns the arc tangent of ``s`` in radians. Use it to get the angle from an angle's tangent in trigonometry: ``atan(tan(angle)) == angle``. + +The method cannot know in which quadrant the angle should fall. See :ref:`atan2` if you always want an exact angle. + +:: + + a = atan(0.5) # a is 0.463648 .. _class_@GDScript_atan2: - :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** -Returns the principal value of the arc tangent of y/x, expressed in radians. To compute the value, the function takes into account the sign of both arguments in order to determine the quadrant. +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. + +:: + + a = atan(0,-1) # a is 3.141593 .. _class_@GDScript_bytes2var: - :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** -Decode a byte array back to a value. +Decodes a byte array back to a value. .. _class_@GDScript_ceil: - :ref:`float` **ceil** **(** :ref:`float` s **)** -Rounds s upward, returning the smallest integral value that is not less than s. +Rounds ``s`` upward, returning the smallest integral value that is not less than ``s``. + +:: + + i = ceil(1.45) # i is 2 + i = ceil(1.001) # i is 2 .. _class_@GDScript_char: - :ref:`String` **char** **(** :ref:`int` ascii **)** +Returns a character as a String of the given ASCII code. + +:: + + # a is 'A' + a = char(65) + # a is 'a' + a = char(65+32) + .. _class_@GDScript_clamp: - :ref:`float` **clamp** **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** -Clamps a value between a minimum and maximum value. +Clamps ``val`` and returns a value not less than ``min`` and not more than ``max``. + +:: + + speed = 1000 + # a is 20 + a = clamp(speed, 1, 20) + + speed = -10 + # a is 1 + a = clamp(speed, 1, 20) .. _class_@GDScript_convert: - :ref:`Object` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** -Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope`. +Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@Global Scope`. + +:: + + a = Vector2(1, 0) + # prints 1 + print(a.length()) + a = convert(a, TYPE_STRING) + # prints 6 + # (1, 0) is 6 characters + print(a.length()) .. _class_@GDScript_cos: - :ref:`float` **cos** **(** :ref:`float` s **)** -Returns the cosine of an angle of s radians. +Returns the cosine of angle ``s`` in radians. + +:: + + # prints 1 and -1 + print(cos(PI\*2)) + print(cos(PI)) .. _class_@GDScript_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** -Returns the hyperbolic cosine of s. +Returns the hyperbolic cosine of ``s`` in radians. + +:: + + # prints 1.543081 + print(cosh(1)) .. _class_@GDScript_db2linear: - :ref:`float` **db2linear** **(** :ref:`float` db **)** -Convert from decibels to linear energy (audio). +Converts from decibels to linear energy (audio). .. _class_@GDScript_decimals: - :ref:`float` **decimals** **(** :ref:`float` step **)** -Return the amount of decimals in the floating point value. +Returns the position of the first non-zero digit, after the decimal point. + +:: + + # n is 2 + n = decimals(0.035) .. _class_@GDScript_dectime: - :ref:`float` **dectime** **(** :ref:`float` value, :ref:`float` amount, :ref:`float` step **)** -Decreases time by a specified amount. +Returns the result of ``value`` decreased by ``step`` \* ``amount``. + +:: + + # a = 59 + a = dectime(60, 10, 0.1)) .. _class_@GDScript_deg2rad: - :ref:`float` **deg2rad** **(** :ref:`float` deg **)** -Convert from degrees to radians. +Returns degrees converted to radians. + +:: + + # r is 3.141593 + r = deg2rad(180) .. _class_@GDScript_dict2inst: - :ref:`Object` **dict2inst** **(** :ref:`Dictionary` dict **)** -Convert a previously converted instances to dictionary back into an instance. Useful for deserializing. +Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. .. _class_@GDScript_ease: @@ -313,117 +425,226 @@ Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-i - :ref:`float` **exp** **(** :ref:`float` s **)** -Returns the base-e exponential function of s, which is e raised to the power s: e^s. +Raises the Euler's constant **e** to the power of ``s`` and returns it. **e** has an approximate value of 2.71828. + +:: + + a = exp(2) # approximately 7.39 .. _class_@GDScript_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** -Rounds s downward, returning the largest integral value that is not greater than s. +Rounds ``s`` to the closest smaller integer and returns it. + +:: + + # a is 2 + a = floor(2.99) + # a is -3 + a = floor(-2.99) .. _class_@GDScript_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** -Returns the floating-point remainder of x/y (rounded towards zero): +Returns the floating-point remainder of ``x/y``. :: - fmod = x - tquot \* y - -Where tquot is the truncated (i.e., rounded towards zero) result of: x/y. + # remainder is 1.5 + var remainder = fmod(7, 5.5) .. _class_@GDScript_fposmod: - :ref:`float` **fposmod** **(** :ref:`float` x, :ref:`float` y **)** -Module (remainder of x/y) that wraps equally in positive and negative. +Returns the floating-point remainder of ``x/y`` that wraps equally in positive and negative. + +:: + + var i = -10; + while i < 0: + prints(i, fposmod(i, 10)) + i += 1 + +Produces: + +:: + + -10 10 + -9 1 + -8 2 + -7 3 + -6 4 + -5 5 + -4 6 + -3 7 + -2 8 + -1 9 .. _class_@GDScript_funcref: - :ref:`Object` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** -Return a reference to the specified function. +Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef` in a variable and call it later. + +:: + + func foo(): + return("bar") + + a = funcref(self, "foo") + print(a.call_func()) # prints bar .. _class_@GDScript_hash: - :ref:`int` **hash** **(** :ref:`Variant` var **)** -Hash the variable passed and return an integer. +Returns the integer hash of the variable passed. + +:: + + print(hash("a")) # prints 177670 .. _class_@GDScript_inst2dict: - :ref:`Dictionary` **inst2dict** **(** :ref:`Object` inst **)** -Convert a script class instance to a dictionary (useful for serializing). +Returns the passed instance converted to a dictionary (useful for serializing). + +:: + + var foo = "bar" + func _ready(): + var d = inst2dict(self) + print(d.keys()) + print(d.values()) + +Prints out: + +:: + + [@subpath, @path, foo] + [, res://test.gd, bar] .. _class_@GDScript_instance_from_id: - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** -Get an object by its ID. +Returns the Object that corresponds to ``instance_id``. All Objects have a unique instance ID. + +:: + + var foo = "bar" + func _ready(): + var id = get_instance_id() + var inst = instance_from_id(id) + print(inst.foo) # prints bar .. _class_@GDScript_inverse_lerp: - :ref:`float` **inverse_lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` value **)** +Returns a normalized value considering the given range. + +:: + + inverse_lerp(3, 5, 4) # returns 0.5 + .. _class_@GDScript_is_inf: -- :ref:`float` **is_inf** **(** :ref:`float` s **)** +- :ref:`bool` **is_inf** **(** :ref:`float` s **)** -Returns whether s is an infinity value (either positive infinity or negative infinity). +Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity). .. _class_@GDScript_is_nan: -- :ref:`float` **is_nan** **(** :ref:`float` s **)** +- :ref:`bool` **is_nan** **(** :ref:`float` s **)** -Returns whether s is a NaN (Not-A-Number) value. +Returns True/False whether ``s`` is a NaN (Not-A-Number) value. .. _class_@GDScript_len: - :ref:`int` **len** **(** :ref:`Variant` var **)** +Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length. + +:: + + a = [1, 2, 3, 4] + len(a) # returns 4 + .. _class_@GDScript_lerp: - :ref:`float` **lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** -Linear interpolates between two values by a normalized value. +Linearly interpolates between two values by a normalized value. + +:: + + lerp(1, 3, 0.5) # returns 2 .. _class_@GDScript_linear2db: - :ref:`float` **linear2db** **(** :ref:`float` nrg **)** -Convert from linear energy to decibels (audio). +Converts from linear energy to decibels (audio). .. _class_@GDScript_load: - :ref:`Object` **load** **(** :ref:`String` path **)** -Load a resource from the filesystem, pass a valid path as argument. +Loads a resource from the filesystem located at 'path'. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + +:: + + # load a scene called main located in the root of the project directory + var main = load("res://main.tscn") .. _class_@GDScript_log: - :ref:`float` **log** **(** :ref:`float` s **)** -Natural logarithm. +Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm. + +:: + + log(10) # returns 2.302585 .. _class_@GDScript_max: - :ref:`float` **max** **(** :ref:`float` a, :ref:`float` b **)** -Return the maximum of two values. +Returns the maximum of two values. + +:: + + max(1,2) # returns 2 + max(-3.99, -4) # returns -3.99 .. _class_@GDScript_min: - :ref:`float` **min** **(** :ref:`float` a, :ref:`float` b **)** -Return the minimum of two values. +Returns the minimum of two values. + +:: + + min(1,2) # returns 1 + min(-3.99, -4) # returns -4 .. _class_@GDScript_nearest_po2: - :ref:`int` **nearest_po2** **(** :ref:`int` val **)** -Return the nearest larger power of 2 for an integer. +Returns the nearest larger power of 2 for integer ``val``. + +:: + + nearest_po2(3) # returns 4 + nearest_po2(4) # returns 4 + nearest_po2(5) # returns 8 .. _class_@GDScript_parse_json: @@ -431,207 +652,401 @@ Return the nearest larger power of 2 for an integer. Parse JSON text to a Variant (use :ref:`typeof` to check if it is what you expect). -Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert every numerical values to :ref:`float` types. +Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to :ref:`float` types. + +:: + + p = parse_json('["a", "b", "c"]') + if typeof(p) == TYPE_ARRAY: + print(p[0]) # prints a + else: + print("unexpected results") .. _class_@GDScript_pow: - :ref:`float` **pow** **(** :ref:`float` x, :ref:`float` y **)** -Power function, x elevate to y. +Returns the result of ``x`` raised to the power of ``y``. + +:: + + pow(2,5) # returns 32 .. _class_@GDScript_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** -Preload a resource from the filesystem. The resource is loaded during script parsing. +Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path". + +:: + + # load a scene called main located in the root of the project directory + var main = preload("res://main.tscn") .. _class_@GDScript_print: - void **print** **(** **)** vararg -Print one or more arguments to strings in the best way possible to a console line. +Converts one or more arguments to strings in the best way possible and prints them to the console. + +:: + + a = [1,2,3] + print("a","b",a) # prints ab[1, 2, 3] .. _class_@GDScript_print_stack: - void **print_stack** **(** **)** -Print a stack track at code location, only works when running with debugger turned on. +Prints a stack track at code location, only works when running with debugger turned on. + +Output in the console would look something like this: + +:: + + Frame 0 - res://test.gd:16 in function '_process' .. _class_@GDScript_printerr: - void **printerr** **(** **)** vararg -Print one or more arguments to strings in the best way possible to standard error line. +Prints one or more arguments to strings in the best way possible to standard error line. + +:: + + printerr("prints to stderr") .. _class_@GDScript_printraw: - void **printraw** **(** **)** vararg -Print one or more arguments to strings in the best way possible to console. No newline is added at the end. +Prints one or more arguments to strings in the best way possible to console. No newline is added at the end. + +:: + + printraw("A") + printraw("B") + # prints AB .. _class_@GDScript_prints: - void **prints** **(** **)** vararg -Print one or more arguments to the console with a space between each argument. +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: - void **printt** **(** **)** vararg -Print one or more arguments to the console with a tab between each argument. +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: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** -Convert from radians to degrees. +Converts from radians to degrees. + +:: + + rad2deg(0.523599) # returns 30 .. _class_@GDScript_rand_range: - :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** -Random range, any floating point value between 'from' and 'to'. +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: - :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. +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: - :ref:`float` **randf** **(** **)** -Return a random floating point value between 0 and 1. +Returns a random floating point value between 0 and 1. + +:: + + randf() # returns 0.375671 .. _class_@GDScript_randi: - :ref:`int` **randi** **(** **)** -Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use remainder. For example, to get a random integer between 0 and 19 inclusive, you can use randi() % 20. +Returns a random 32 bit integer. Use remainder to obtain a random value between 0 and N (where N is smaller than 2^32 -1). + +:: + + randi() % 20 # returns random number between 0 and 19 + randi() % 100 # returns random number between 0 and 99 + randi() % 100 + 1 # returns random number between 1 and 100 .. _class_@GDScript_randomize: - void **randomize** **(** **)** -Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. +Randomizes the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. + +:: + + func _ready(): + randomize() .. _class_@GDScript_range: - :ref:`Array` **range** **(** **)** vararg -Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). +Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). + +:: + + for i in range(4): + print(i) + for i in range(2, 5): + print(i) + for i in range(0, 6, 2): + print(i) + +Output: + +:: + + 0 + 1 + 2 + 3 + + 2 + 3 + 4 + + 0 + 2 + 4 .. _class_@GDScript_range_lerp: - :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** +Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. + +:: + + range_lerp(75, 0, 100, -1, 1) # returns 0.5 + .. _class_@GDScript_round: - :ref:`float` **round** **(** :ref:`float` s **)** -Returns the integral value that is nearest to s, with halfway cases rounded away from zero. +Returns the integral value that is nearest to ``s``, with halfway cases rounded away from zero. + +:: + + round(2.6) # returns 3 .. _class_@GDScript_seed: - void **seed** **(** :ref:`int` seed **)** -Set seed for the random number generator. +Sets seed for the random number generator. + +:: + + my_seed = "Godot Rocks" + seed(my_seed.hash()) .. _class_@GDScript_sign: - :ref:`float` **sign** **(** :ref:`float` s **)** -Return sign (-1 or +1). +Returns sign of ``s`` -1 or 1. + +:: + + sign(-6) # returns -1 + sign(6) # returns 1 .. _class_@GDScript_sin: - :ref:`float` **sin** **(** :ref:`float` s **)** -Returns the sine of an angle of s radians. +Returns the sine of angle ``s`` in radians. + +:: + + sin(0.523599) # returns 0.5 .. _class_@GDScript_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** -Returns the hyperbolic sine of s. +Returns the hyperbolic sine of ``s``. + +:: + + a = log(2.0) # returns 0.693147 + sinh(a) # returns 0.75 .. _class_@GDScript_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** -Returns the square root of s. +Returns the square root of ``s``. + +:: + + sqrt(9) # returns 3 .. _class_@GDScript_stepify: - :ref:`float` **stepify** **(** :ref:`float` s, :ref:`float` step **)** -Snap float value to a given step. +Snaps float value ``s`` to a given ``step``. .. _class_@GDScript_str: - :ref:`String` **str** **(** **)** vararg -Convert one or more arguments to string in the best way possible. +Converts one or more arguments to string in the best way possible. + +:: + + var a = [10, 20, 30] + var b = str(a); + len(a) # returns 3 + len(b) # returns 12 .. _class_@GDScript_str2var: - :ref:`Variant` **str2var** **(** :ref:`String` string **)** -Convert a formatted string that was returned by :ref:`var2str` to the original value. +Converts a formatted string that was returned by :ref:`var2str` to the original value. + +:: + + a = '{ "a": 1, "b": 2 }' + b = str2var(a) + print(b['a']) # prints 1 .. _class_@GDScript_tan: - :ref:`float` **tan** **(** :ref:`float` s **)** -Returns the tangent of an angle of s radians. +Returns the tangent of angle ``s`` in radians. + +:: + + tan( deg2rad(45) ) # returns 1 .. _class_@GDScript_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** -Returns the hyperbolic tangent of s. +Returns the hyperbolic tangent of ``s``. + +:: + + a = log(2.0) # returns 0.693147 + tanh(a) # returns 0.6 .. _class_@GDScript_to_json: - :ref:`String` **to_json** **(** :ref:`Variant` var **)** -Convert a Variant to json text. +Converts a Variant ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network. + +:: + + a = { 'a': 1, 'b': 2 } + b = to_json(a) + print(b) # {"a":1, "b":2} .. _class_@GDScript_type_exists: - :ref:`bool` **type_exists** **(** :ref:`String` type **)** +Returns whether the given class exists in :ref:`ClassDB`. + +:: + + type_exists("Sprite") # returns true + type_exists("Variant") # returns false + .. _class_@GDScript_typeof: - :ref:`int` **typeof** **(** :ref:`Variant` what **)** -Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. +Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. + +:: + + p = parse_json('["a", "b", "c"]') + if typeof(p) == TYPE_ARRAY: + print(p[0]) # prints a + else: + print("unexpected results") .. _class_@GDScript_validate_json: - :ref:`String` **validate_json** **(** :ref:`String` json **)** -This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML. +Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns error message if not valid. + +:: + + j = to_json([1, 2, 3]) + v = validate_json(j) + if not v: + print("valid") + else: + prints("invalid", v) .. _class_@GDScript_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** -Encode a variable value to a byte array. +Encodes a variable value to a byte array. .. _class_@GDScript_var2str: - :ref:`String` **var2str** **(** :ref:`Variant` var **)** -Convert a value to a formatted string that can later be parsed using :ref:`str2var`. +Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var`. + +:: + + a = { 'a': 1, 'b': 2 } + print(var2str(a)) + +prints + +:: + + { + "a": 1, + "b": 2 + } .. _class_@GDScript_weakref: - :ref:`Object` **weakref** **(** :ref:`Object` obj **)** -Return a weak reference to an object. +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. @@ -639,7 +1054,7 @@ A weak reference to an object is not enough to keep the object alive: when the o - :ref:`GDFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** -Stop the function execution and return the current state. Call :ref:`GDFunctionState.resume` on the state to resume execution. This invalidates the state. +Stops the function execution and returns the current state. Call :ref:`GDFunctionState.resume` on the state to resume execution. This invalidates the state. Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted. diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 34b4cd378..cfdaf173c 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the @Global Scope.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_@Global Scope: @@ -16,7 +17,7 @@ Global scope constants and variables. Member Variables ---------------- -- :ref:`ARVRServer` **ARVRServer** +- :ref:`ARVRServer` **ARVRServer** - [ARVRServer] singleton - :ref:`AudioServer` **AudioServer** - [AudioServer] singleton - :ref:`ClassDB` **ClassDB** - [ClassDB] singleton - :ref:`Engine` **Engine** - [Engine] singleton @@ -24,6 +25,7 @@ Member Variables - :ref:`IP` **IP** - [IP] singleton - :ref:`Input` **Input** - [Input] singleton - :ref:`InputMap` **InputMap** - [InputMap] singleton +- :ref:`JSON` **JSON** - :ref:`Reference` **Marshalls** - [Marshalls] singleton - :ref:`OS` **OS** - [OS] singleton - :ref:`Performance` **Performance** - [Performance] singleton @@ -394,7 +396,7 @@ Numeric Constants - **ERR_ALREADY_IN_USE** = **22** - **ERR_LOCKED** = **23** - **ERR_TIMEOUT** = **24** -- **ERR_CANT_AQUIRE_RESOURCE** = **28** +- **ERR_CANT_ACQUIRE_RESOURCE** = **28** - **ERR_INVALID_DATA** = **30** - **ERR_INVALID_PARAMETER** = **31** - **ERR_ALREADY_EXISTS** = **32** @@ -476,13 +478,13 @@ Numeric Constants - **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object`. - **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary`. - **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array`. -- **TYPE_RAW_ARRAY** = **20** -- **TYPE_INT_ARRAY** = **21** -- **TYPE_REAL_ARRAY** = **22** -- **TYPE_STRING_ARRAY** = **23** -- **TYPE_VECTOR2_ARRAY** = **24** -- **TYPE_VECTOR3_ARRAY** = **25** -- **TYPE_COLOR_ARRAY** = **26** +- **TYPE_RAW_ARRAY** = **20** --- Variable is of type :ref:`PoolByteArray`. +- **TYPE_INT_ARRAY** = **21** --- Variable is of type :ref:`PoolIntArray`. +- **TYPE_REAL_ARRAY** = **22** --- Variable is of type :ref:`PoolRealArray`. +- **TYPE_STRING_ARRAY** = **23** --- Variable is of type :ref:`PoolStringArray`. +- **TYPE_VECTOR2_ARRAY** = **24** --- Variable is of type :ref:`PoolVector2Array`. +- **TYPE_VECTOR3_ARRAY** = **25** --- Variable is of type :ref:`PoolVector3Array`. +- **TYPE_COLOR_ARRAY** = **26** --- Variable is of type :ref:`PoolColorArray`. - **TYPE_MAX** = **27** Description diff --git a/classes/class_@nativescript.rst b/classes/class_@nativescript.rst index fbc5cfc28..f48ca52aa 100644 --- a/classes/class_@nativescript.rst +++ b/classes/class_@nativescript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the @NativeScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_@NativeScript: diff --git a/classes/class_@visualscript.rst b/classes/class_@visualscript.rst index f16093002..1cf21f26b 100644 --- a/classes/class_@visualscript.rst +++ b/classes/class_@visualscript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the @VisualScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_@VisualScript: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 1867378fb..e262abff0 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AcceptDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AcceptDialog: @@ -44,10 +45,10 @@ Signals ------- - **confirmed** **(** **)** -Emitted when accepted. +Emitted when the dialog is accepted. - **custom_action** **(** :ref:`String` action **)** -Emitted with a custom button is added. +Emitted when a custom button is pressed. See :ref:`add_button`. Member Variables @@ -68,15 +69,15 @@ Member Function Description - :ref:`Button` **add_button** **(** :ref:`String` text, :ref:`bool` right=false, :ref:`String` action="" **)** -Add custom button to the dialog and return the created button. +Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the custom_action signal when pressed. -The button titled with *text* and the *action* will be passed to custom_action signal when it is pressed. +If ``true``, *right* will place the button to the right of any sibling buttons. Default value: ``false``. .. _class_AcceptDialog_add_cancel: - :ref:`Button` **add_cancel** **(** :ref:`String` name **)** -Add custom cancel button to the dialog and return the created button. +Adds a button with label *name* and a cancel action to the dialog and returns the created button. .. _class_AcceptDialog_get_hide_on_ok: @@ -106,7 +107,7 @@ Return the built-in label text. - void **register_text_enter** **(** :ref:`Node` line_edit **)** -Register a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. +Registers a :ref:`LineEdit` in the dialog. When the enter key is pressed, the dialog will be accepted. .. _class_AcceptDialog_set_hide_on_ok: diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 0a53021fc..6e2190eb9 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AnimatedSprite.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AnimatedSprite: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index bb555c357..be0460397 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AnimatedSprite3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AnimatedSprite3D: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index 92f02176c..3bbc5f0d2 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Animation.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Animation: @@ -18,87 +19,87 @@ Contains data used to animate everything in the engine. Member Functions ---------------- -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_length` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_track_count` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_loop` **(** **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_track` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_remove_key_at_pos` **(** :ref:`int` idx, :ref:`float` pos **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` loc, :ref:`Quat` rot, :ref:`Vector3` scale **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`int` mode **)** | -+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_track` **(** :ref:`int` type, :ref:`int` at_position=-1 **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_track` **(** :ref:`NodePath` path **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_length` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_track_count` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_loop` **(** **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`method_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`method_track_get_name` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`method_track_get_params` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_track` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_length` **(** :ref:`float` time_sec **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_loop` **(** :ref:`bool` enabled **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_step` **(** :ref:`float` size_sec **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_find_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`bool` exact=false **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_get_interpolation_loop_wrap` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_interpolation_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_key_count` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_time` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`track_get_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`track_get_key_value` **(** :ref:`int` idx, :ref:`int` key_idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`track_get_path` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`track_get_type` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Variant` key, :ref:`float` transition=1 **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`track_is_imported` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_down` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_move_up` **(** :ref:`int` idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key` **(** :ref:`int` idx, :ref:`int` key_idx **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_remove_key_at_position` **(** :ref:`int` idx, :ref:`float` position **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_imported` **(** :ref:`int` idx, :ref:`bool` imported **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_loop_wrap` **(** :ref:`int` idx, :ref:`bool` interpolation **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_interpolation_type` **(** :ref:`int` idx, :ref:`int` interpolation **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_transition` **(** :ref:`int` idx, :ref:`int` key_idx, :ref:`float` transition **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_key_value` **(** :ref:`int` idx, :ref:`int` key, :ref:`Variant` value **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`track_set_path` **(** :ref:`int` idx, :ref:`NodePath` path **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`transform_track_insert_key` **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`transform_track_interpolate` **(** :ref:`int` idx, :ref:`float` time_sec **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`value_track_get_key_indices` **(** :ref:`int` idx, :ref:`float` time_sec, :ref:`float` delta **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`value_track_get_update_mode` **(** :ref:`int` idx **)** const | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`value_track_set_update_mode` **(** :ref:`int` idx, :ref:`int` mode **)** | ++------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -109,9 +110,9 @@ Numeric Constants - **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value). - **INTERPOLATION_LINEAR** = **1** --- Linear interpolation. - **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation. -- **UPDATE_CONTINUOUS** = **0** -- **UPDATE_DISCRETE** = **1** -- **UPDATE_TRIGGER** = **2** +- **UPDATE_CONTINUOUS** = **0** --- Update between keyframes. +- **UPDATE_DISCRETE** = **1** --- Update at the keyframes and hold the value. +- **UPDATE_TRIGGER** = **2** --- Update at the keyframes. Description ----------- @@ -125,7 +126,7 @@ Member Function Description .. _class_Animation_add_track: -- :ref:`int` **add_track** **(** :ref:`int` type, :ref:`int` at_pos=-1 **)** +- :ref:`int` **add_track** **(** :ref:`int` 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. @@ -289,9 +290,9 @@ Move a track up. Remove a key by index in a given track. -.. _class_Animation_track_remove_key_at_pos: +.. _class_Animation_track_remove_key_at_position: -- void **track_remove_key_at_pos** **(** :ref:`int` idx, :ref:`float` pos **)** +- void **track_remove_key_at_position** **(** :ref:`int` idx, :ref:`float` position **)** Remove a key by position (seconds) in a given track. @@ -331,7 +332,7 @@ Set the path of a track. Paths must be valid scene-tree paths to a node, and mus .. _class_Animation_transform_track_insert_key: -- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` loc, :ref:`Quat` rot, :ref:`Vector3` scale **)** +- :ref:`int` **transform_track_insert_key** **(** :ref:`int` idx, :ref:`float` time, :ref:`Vector3` location, :ref:`Quat` rotation, :ref:`Vector3` scale **)** Insert a transform key for a transform track. @@ -351,8 +352,12 @@ Return all the key indices of a value track, given a position and delta time. - :ref:`int` **value_track_get_update_mode** **(** :ref:`int` idx **)** const +Return the update mode of a value track. + .. _class_Animation_value_track_set_update_mode: - void **value_track_set_update_mode** **(** :ref:`int` idx, :ref:`int` mode **)** +Set the update mode (UPDATE\_\*) of a value track. + diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 7505d0263..79e0f90ca 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AnimationPlayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AnimationPlayer: @@ -47,11 +48,11 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_current_animation_length` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_current_animation_pos` **(** **)** const | +| :ref:`float` | :ref:`get_current_animation_position` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_default_blend_time` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** const | +| :ref:`float` | :ref:`get_position` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_root` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,7 +74,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rename_animation` **(** :ref:`String` name, :ref:`String` newname **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** | +| void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`bool` active **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,10 +147,14 @@ Used to skip ahead or skip back in an animation. Delta is the time in seconds to - :ref:`String` **animation_get_next** **(** :ref:`String` anim_from **)** const +Return the name of the next animation in the queue. + .. _class_AnimationPlayer_animation_set_next: - void **animation_set_next** **(** :ref:`String` anim_from, :ref:`String` anim_to **)** +Set the name of an animation that will be played after. + .. _class_AnimationPlayer_clear_caches: - void **clear_caches** **(** **)** @@ -210,9 +215,9 @@ Return the name of the animation being played. Get the length (in seconds) of the currently being played animation. -.. _class_AnimationPlayer_get_current_animation_pos: +.. _class_AnimationPlayer_get_current_animation_position: -- :ref:`float` **get_current_animation_pos** **(** **)** const +- :ref:`float` **get_current_animation_position** **(** **)** const Get the position (in seconds) of the currently being played animation. @@ -222,9 +227,9 @@ Get the position (in seconds) of the currently being played animation. Return the default blend time between animations. -.. _class_AnimationPlayer_get_pos: +.. _class_AnimationPlayer_get_position: -- :ref:`float` **get_pos** **(** **)** const +- :ref:`float` **get_position** **(** **)** const Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). @@ -290,7 +295,7 @@ Rename an existing animation. .. _class_AnimationPlayer_seek: -- void **seek** **(** :ref:`float` pos_sec, :ref:`bool` update=false **)** +- void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false **)** Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 21c813380..1e7f8ac15 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AnimationTreePlayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AnimationTreePlayer: @@ -73,13 +74,13 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`node_get_input_source` **(** :ref:`String` id, :ref:`int` idx **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`node_get_pos` **(** :ref:`String` id **)** const | +| :ref:`Vector2` | :ref:`node_get_position` **(** :ref:`String` id **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`node_get_type` **(** :ref:`String` id **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`node_rename` **(** :ref:`String` node, :ref:`String` new_name **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`node_set_pos` **(** :ref:`String` id, :ref:`Vector2` screen_pos **)** | +| void | :ref:`node_set_position` **(** :ref:`String` id, :ref:`Vector2` screen_position **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`oneshot_node_get_autorestart_delay` **(** :ref:`String` id **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -127,7 +128,7 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`timescale_node_set_scale` **(** :ref:`String` id, :ref:`float` scale **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` pos_sec **)** | +| void | :ref:`timeseek_node_seek` **(** :ref:`String` id, :ref:`float` seconds **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`transition_node_delete_input` **(** :ref:`String` id, :ref:`int` input_idx **)** | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -156,16 +157,18 @@ Member Variables Numeric Constants ----------------- -- **NODE_OUTPUT** = **0** -- **NODE_ANIMATION** = **1** -- **NODE_ONESHOT** = **2** -- **NODE_MIX** = **3** -- **NODE_BLEND2** = **4** -- **NODE_BLEND3** = **5** -- **NODE_BLEND4** = **6** -- **NODE_TIMESCALE** = **7** -- **NODE_TIMESEEK** = **8** -- **NODE_TRANSITION** = **9** +- **NODE_OUTPUT** = **0** --- Output node. +- **NODE_ANIMATION** = **1** --- Animation node. +- **NODE_ONESHOT** = **2** --- OneShot node. +- **NODE_MIX** = **3** --- Mix node. +- **NODE_BLEND2** = **4** --- Blend2 node. +- **NODE_BLEND3** = **5** --- Blend3 node. +- **NODE_BLEND4** = **6** --- Blend4 node. +- **NODE_TIMESCALE** = **7** --- TimeScale node. +- **NODE_TIMESEEK** = **8** --- TimeSeek node. +- **NODE_TRANSITION** = **9** --- Transition node. +- **ANIMATION_PROCESS_FIXED** = **0** +- **ANIMATION_PROCESS_IDLE** = **1** Description ----------- @@ -189,6 +192,8 @@ Add a node of a given type in the graph with given id. - :ref:`Animation` **animation_node_get_animation** **(** :ref:`String` id **)** const +Returns an animation given its name. + .. _class_AnimationTreePlayer_animation_node_get_master_animation: - :ref:`String` **animation_node_get_master_animation** **(** :ref:`String` id **)** const @@ -211,14 +216,20 @@ Set the animation for an animation node. - :ref:`bool` **are_nodes_connected** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** const +Returns whether node ``id`` and ``dst_id`` are connected at the specified slot. + .. _class_AnimationTreePlayer_blend2_node_get_amount: - :ref:`float` **blend2_node_get_amount** **(** :ref:`String` id **)** const +Returns the blend amount of a Blend2 node given its name. + .. _class_AnimationTreePlayer_blend2_node_set_amount: - void **blend2_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +Sets the blend amount of a Blend2 node given its name and value. + .. _class_AnimationTreePlayer_blend2_node_set_filter_path: - void **blend2_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** @@ -227,30 +238,44 @@ Set the animation for an animation node. - :ref:`float` **blend3_node_get_amount** **(** :ref:`String` id **)** const +Returns the blend amount of a Blend3 node given its name. + .. _class_AnimationTreePlayer_blend3_node_set_amount: - void **blend3_node_set_amount** **(** :ref:`String` id, :ref:`float` blend **)** +Sets the blend amount of a Blend3 node given its name and value. + .. _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: - void **blend4_node_set_amount** **(** :ref:`String` id, :ref:`Vector2` blend **)** +Sets the blend amount of a Blend4 node given its name and value. + .. _class_AnimationTreePlayer_connect_nodes: - :ref:`int` **connect_nodes** **(** :ref:`String` id, :ref:`String` dst_id, :ref:`int` dst_input_idx **)** +Connects node ``id`` to ``dst_id`` at the specified input slot. + .. _class_AnimationTreePlayer_disconnect_nodes: - void **disconnect_nodes** **(** :ref:`String` id, :ref:`int` dst_input_idx **)** +Disconnects nodes connected to ``id`` at the specified input slot. + .. _class_AnimationTreePlayer_get_animation_process_mode: - :ref:`int` **get_animation_process_mode** **(** **)** const +Returns playback process mode of this AnimationTreePlayer. + .. _class_AnimationTreePlayer_get_base_path: - :ref:`NodePath` **get_base_path** **(** **)** const @@ -263,18 +288,26 @@ Set the animation for an animation node. - :ref:`PoolStringArray` **get_node_list** **(** **)** +Returns a PoolStringArray containing the name of all nodes. + .. _class_AnimationTreePlayer_is_active: - :ref:`bool` **is_active** **(** **)** const +Returns whether this AnimationTreePlayer is active. + .. _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: - void **mix_node_set_amount** **(** :ref:`String` id, :ref:`float` ratio **)** +Sets mix amount of a Mix node given its name and value. + .. _class_AnimationTreePlayer_node_exists: - :ref:`bool` **node_exists** **(** :ref:`String` node **)** const @@ -293,9 +326,11 @@ Return the input count for a given node. Different types of nodes have different Return the input source for a given node input. -.. _class_AnimationTreePlayer_node_get_pos: +.. _class_AnimationTreePlayer_node_get_position: -- :ref:`Vector2` **node_get_pos** **(** :ref:`String` id **)** const +- :ref:`Vector2` **node_get_position** **(** :ref:`String` id **)** const + +Returns position of a node in the graph given its name. .. _class_AnimationTreePlayer_node_get_type: @@ -309,54 +344,78 @@ Get the node type, will return from NODE\_\* enum. Rename a node in the graph. -.. _class_AnimationTreePlayer_node_set_pos: +.. _class_AnimationTreePlayer_node_set_position: -- void **node_set_pos** **(** :ref:`String` id, :ref:`Vector2` screen_pos **)** +- void **node_set_position** **(** :ref:`String` id, :ref:`Vector2` screen_position **)** + +Sets position of a node in the graph given its name and position. .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay: - :ref:`float` **oneshot_node_get_autorestart_delay** **(** :ref:`String` id **)** const +Returns autostart delay of a OneShot node given its name. + .. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay: - :ref:`float` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String` id **)** const +Returns autostart random delay of a OneShot node given its name. + .. _class_AnimationTreePlayer_oneshot_node_get_fadein_time: - :ref:`float` **oneshot_node_get_fadein_time** **(** :ref:`String` id **)** const +Returns fade in time of a OneShot node given its name. + .. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time: - :ref:`float` **oneshot_node_get_fadeout_time** **(** :ref:`String` id **)** const +Returns fade out time of a OneShot node given its name. + .. _class_AnimationTreePlayer_oneshot_node_has_autorestart: - :ref:`bool` **oneshot_node_has_autorestart** **(** :ref:`String` id **)** const +Returns whether a OneShot node will auto restart given its name. + .. _class_AnimationTreePlayer_oneshot_node_is_active: - :ref:`bool` **oneshot_node_is_active** **(** :ref:`String` id **)** const +Returns whether a OneShot node is active given its name. + .. _class_AnimationTreePlayer_oneshot_node_set_autorestart: - void **oneshot_node_set_autorestart** **(** :ref:`String` id, :ref:`bool` enable **)** +Sets autorestart property of a OneShot node given its name and value. + .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay: - void **oneshot_node_set_autorestart_delay** **(** :ref:`String` id, :ref:`float` delay_sec **)** +Sets autorestart delay of a OneShot node given its name and value in seconds. + .. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay: - void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String` id, :ref:`float` rand_sec **)** +Sets autorestart random delay of a OneShot node given its name and value in seconds. + .. _class_AnimationTreePlayer_oneshot_node_set_fadein_time: - void **oneshot_node_set_fadein_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +Sets fade in time of a OneShot node given its name and value in seconds. + .. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time: - void **oneshot_node_set_fadeout_time** **(** :ref:`String` id, :ref:`float` time_sec **)** +Sets fade out time of a OneShot node given its name and value in seconds. + .. _class_AnimationTreePlayer_oneshot_node_set_filter_path: - void **oneshot_node_set_filter_path** **(** :ref:`String` id, :ref:`NodePath` path, :ref:`bool` enable **)** @@ -365,10 +424,14 @@ Rename a node in the graph. - void **oneshot_node_start** **(** :ref:`String` id **)** +Starts a OneShot node given its name. + .. _class_AnimationTreePlayer_oneshot_node_stop: - void **oneshot_node_stop** **(** :ref:`String` id **)** +Stops a OneShot node given its name. + .. _class_AnimationTreePlayer_recompute_caches: - void **recompute_caches** **(** **)** @@ -381,18 +444,26 @@ Rename a node in the graph. - void **reset** **(** **)** +Resets this AnimationTreePlayer. + .. _class_AnimationTreePlayer_set_active: - void **set_active** **(** :ref:`bool` enabled **)** +Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. + .. _class_AnimationTreePlayer_set_animation_process_mode: - void **set_animation_process_mode** **(** :ref:`int` mode **)** +Sets process mode (ANIMATION_PROCESS\_\*) of this AnimationTreePlayer. + .. _class_AnimationTreePlayer_set_base_path: - void **set_base_path** **(** :ref:`NodePath` path **)** +Sets base path of this AnimationTreePlayer. + .. _class_AnimationTreePlayer_set_master_player: - void **set_master_player** **(** :ref:`NodePath` nodepath **)** @@ -401,13 +472,19 @@ Rename a node in the graph. - :ref:`float` **timescale_node_get_scale** **(** :ref:`String` id **)** const +Returns time scale value of a TimeScale node given its name. + .. _class_AnimationTreePlayer_timescale_node_set_scale: - void **timescale_node_set_scale** **(** :ref:`String` id, :ref:`float` scale **)** +Sets time scale value of a TimeScale node given its name and value. + .. _class_AnimationTreePlayer_timeseek_node_seek: -- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` pos_sec **)** +- void **timeseek_node_seek** **(** :ref:`String` id, :ref:`float` seconds **)** + +Sets time seek value of a TimeSeek node given its name and value. .. _class_AnimationTreePlayer_transition_node_delete_input: diff --git a/classes/class_area.rst b/classes/class_area.rst index 7cec9827d..650a8604d 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Area.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Area: @@ -158,6 +159,15 @@ Member Variables - :ref:`float` **reverb_bus_uniformity** - :ref:`int` **space_override** +Numeric Constants +----------------- + +- **SPACE_OVERRIDE_DISABLED** = **0** +- **SPACE_OVERRIDE_COMBINE** = **1** +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** +- **SPACE_OVERRIDE_REPLACE** = **3** +- **SPACE_OVERRIDE_REPLACE_COMBINE** = **4** + Description ----------- diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 9386cba9d..49242fc34 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Area2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Area2D: @@ -13,7 +14,7 @@ Area2D Brief Description ----------------- -General purpose area detection and influence for 2D physics. +2D area that detects nodes that enter or exit it. Can override 2D physics properties within range. Member Functions ---------------- @@ -21,7 +22,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angular_damp` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | +| :ref:`String` | :ref:`get_audio_bus_name` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +62,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | +| void | :ref:`set_audio_bus_name` **(** :ref:`String` name **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,7 +90,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_priority` **(** :ref:`float` priority **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | +| void | :ref:`set_space_override_mode` **(** :ref:`int` space_override_mode **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -123,25 +124,37 @@ This signal triggers only once when a body exits this area. The first parameter Member Variables ---------------- -- :ref:`float` **angular_damp** -- :ref:`String` **audio_bus_name** -- :ref:`bool` **audio_bus_override** -- :ref:`int` **collision_layer** -- :ref:`int` **collision_mask** -- :ref:`float` **gravity** -- :ref:`float` **gravity_distance_scale** -- :ref:`bool` **gravity_point** -- :ref:`Vector2` **gravity_vec** -- :ref:`float` **linear_damp** -- :ref:`bool` **monitorable** -- :ref:`bool` **monitoring** -- :ref:`float` **priority** -- :ref:`int` **space_override** +- :ref:`float` **angular_damp** - The rate at which objects stop spinning in this area. Represents the amount of speed lost per second. If 1.0, physics bodies in the area stop rotating immediately. If 0.0, they never slow down. Does not incorporate external forces. The physics-update's rate affects 'angular_damp'. +- :ref:`String` **audio_bus_name** - The name of the Area2D's audio bus. +- :ref:`bool` **audio_bus_override** - If [code]true[/code], overrides the default audio bus with the Area2D's. Defaults to [code]false[/code]. +- :ref:`int` **collision_layer** - The physics layer this Area2D is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + 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. +- :ref:`int` **collision_mask** - The physics layers this Area2D scans to determine collision detections. +- :ref:`float` **gravity** - The gravity intensity within the Area2D (ranges -1024 to 1024). This is useful to alter the force of gravity without altering its direction. + This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). +- :ref:`float` **gravity_distance_scale** - The falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. +- :ref:`bool` **gravity_point** - If [code]true[/code], calculates gravity from a particular point during a space override (see [method set_space_override_mode]). If a point, [Vector2] position is set with [method set_gravity_vector]. Defaults to [code]false[/code]. +- :ref:`Vector2` **gravity_vec** - The gravitational direction/strength as a vector (not normalized). If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. +- :ref:`float` **linear_damp** - The rate at which objects stop spinning in this area. Represents the amount of speed lost per second. If 1.0, physics bodies in the area stop rotating immediately. If 0.0, they never slow down. Does not incorporate external forces. The physics-update's rate affects 'angular_damp'. +- :ref:`bool` **monitorable** - If [code]true[/code], other monitoring areas can detect this Area2D (is it undetectable at the moment?). Defaults to [code]true[/code]. +- :ref:`bool` **monitoring** - If [code]true[/code], this detects bodies/areas entering/exiting it (can it detect others at the moment?). Defaults to [code]true[/code]. +- :ref:`float` **priority** - The processing order for this priority. Ranges from 0 to 128. Defaults to 0. Higher priorities are processed first. +- :ref:`int` **space_override** - How to override gravity and damping calculations within this Area2D, if at all. Consult the SPACE_OVERRIDE_* constants for available options. + +Numeric Constants +----------------- + +- **SPACE_OVERRIDE_DISABLED** = **0** --- This area does not affect gravity/damp. These are areas that exist only to detect collisions and objects entering or exiting them. +- **SPACE_OVERRIDE_COMBINE** = **1** --- This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. +- **SPACE_OVERRIDE_COMBINE_REPLACE** = **2** --- This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. +- **SPACE_OVERRIDE_REPLACE** = **3** --- This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. +- **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. Description ----------- -General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. +2D area that detects nodes that enter or exit it. Change the 'space_override' property SPACE_OVERRIDE\_\* to override physics parameters for nodes like Rigidbody2D. E.g. gravity, damping... See :ref:`CollisionObject2D` for usage. Member Function Description --------------------------- @@ -152,9 +165,9 @@ Member Function Description Return the angular damp rate. -.. _class_Area2D_get_audio_bus: +.. _class_Area2D_get_audio_bus_name: -- :ref:`String` **get_audio_bus** **(** **)** const +- :ref:`String` **get_audio_bus_name** **(** **)** const .. _class_Area2D_get_collision_layer: @@ -166,19 +179,19 @@ Return the physics layer this area is in. - :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the layer mask. +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: - :ref:`int` **get_collision_mask** **(** **)** const -Return the physics layers this area can scan for collisions. +Return the physics layers this area will scan to determine collisions. .. _class_Area2D_get_collision_mask_bit: - :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const -Return an individual bit on the collision mask. +Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. .. _class_Area2D_get_gravity: @@ -208,13 +221,13 @@ Return the linear damp rate. - :ref:`Array` **get_overlapping_areas** **(** **)** const -Return a list of the areas that are totally or partially inside this area. +Returns a list of the :ref:`Area2D`s that intersect with this area. .. _class_Area2D_get_overlapping_bodies: - :ref:`Array` **get_overlapping_bodies** **(** **)** const -Return a list of the bodies (:ref:`PhysicsBody2D`) that are totally or partially inside this area. +Return a list of the :ref:`PhysicsBody2D`s that intersect with this area. .. _class_Area2D_get_priority: @@ -270,9 +283,9 @@ Set the rate at which objects stop spinning in this area, if there are not any o In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. -.. _class_Area2D_set_audio_bus: +.. _class_Area2D_set_audio_bus_name: -- void **set_audio_bus** **(** :ref:`String` name **)** +- void **set_audio_bus_name** **(** :ref:`String` name **)** .. _class_Area2D_set_audio_bus_override: @@ -364,7 +377,7 @@ Areas with the same priority value get evaluated in an unpredictable order, and .. _class_Area2D_set_space_override_mode: -- void **set_space_override_mode** **(** :ref:`int` enable **)** +- void **set_space_override_mode** **(** :ref:`int` space_override_mode **)** Set the space override mode. This mode controls how an area affects gravity and damp. diff --git a/classes/class_array.rst b/classes/class_array.rst index 1a73a44bf..3b6301851 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Array: @@ -39,6 +40,8 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`count` **(** var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`duplicate` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`empty` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase` **(** var value **)** | @@ -53,7 +56,7 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`insert` **(** :ref:`int` pos, var value **)** | +| void | :ref:`insert` **(** :ref:`int` position, var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -65,9 +68,9 @@ Member Functions +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_front` **(** var value **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` pos **)** | +| void | :ref:`remove` **(** :ref:`int` position **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` pos **)** | +| void | :ref:`resize` **(** :ref:`int` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** var what, :ref:`int` from=-1 **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -152,6 +155,10 @@ Clear the array (resize to 0). Return the amount of times an element is in the array. +.. _class_Array_duplicate: + +- :ref:`Array` **duplicate** **(** **)** + .. _class_Array_empty: - :ref:`bool` **empty** **(** **)** @@ -203,7 +210,7 @@ Return a hashed integer value representing the array contents. .. _class_Array_insert: -- void **insert** **(** :ref:`int` pos, var value **)** +- void **insert** **(** :ref:`int` position, var 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()). @@ -239,13 +246,13 @@ Add an element at the beginning of the array. .. _class_Array_remove: -- void **remove** **(** :ref:`int` pos **)** +- void **remove** **(** :ref:`int` position **)** Remove an element from the array by index. .. _class_Array_resize: -- void **resize** **(** :ref:`int` pos **)** +- 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. diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 7d2a3a013..e35580642 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ArrayMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ArrayMesh: @@ -47,6 +48,10 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_arrays` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`surface_get_blend_shape_arrays` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | @@ -156,6 +161,14 @@ Return the length in indices of the index array in the requested surface (see :r Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). +.. _class_ArrayMesh_surface_get_arrays: + +- :ref:`Array` **surface_get_arrays** **(** :ref:`int` surf_idx **)** const + +.. _class_ArrayMesh_surface_get_blend_shape_arrays: + +- :ref:`Array` **surface_get_blend_shape_arrays** **(** :ref:`int` surf_idx **)** const + .. _class_ArrayMesh_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index 5d6f81c2b..4ee752956 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRAnchor.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRAnchor: @@ -13,7 +14,7 @@ ARVRAnchor Brief Description ----------------- - +Anchor point in AR Space Member Functions ---------------- @@ -35,6 +36,15 @@ Member Variables - :ref:`int` **anchor_id** +Description +----------- + +The ARVR Anchor point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them. + +This node is mapped to one of the anchors through its unique id. When you receive a signal that a new anchor is available you should add this node to your scene for that anchor. You can predefine nodes and set the id and the nodes will simply remain on 0,0,0 until a plane is recognised. + +Keep in mind that as long as plane detection is enable the size, placing and orientation of an anchor will be updates as the detection logic learns more about the real world out there especially if only part of the surface is in view. + Member Function Description --------------------------- @@ -42,20 +52,30 @@ Member Function Description - :ref:`int` **get_anchor_id** **(** **)** const +Returns the anchor id for this anchor. + .. _class_ARVRAnchor_get_anchor_name: - :ref:`String` **get_anchor_name** **(** **)** const +Returns the name given to this anchor. + .. _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_size: - :ref:`Vector3` **get_size** **(** **)** const +Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. + .. _class_ARVRAnchor_set_anchor_id: - void **set_anchor_id** **(** :ref:`int` anchor_id **)** +Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them. + diff --git a/classes/class_arvrcamera.rst b/classes/class_arvrcamera.rst index 68dd9a730..728b18314 100644 --- a/classes/class_arvrcamera.rst +++ b/classes/class_arvrcamera.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRCamera.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRCamera: @@ -13,5 +14,12 @@ ARVRCamera Brief Description ----------------- +A camera node with a few overrules for AR/VR applied such as location tracking. +Description +----------- + +This is a helper spatial node for our camera, note that if stereoscopic rendering is applicable (VR-HMD) most of the camera properties are ignored as the HMD information overrides them. The only properties that can be trusted are the near and far planes. + +The position and orientation of this node is automatically updated by the ARVR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that in contrast to the ARVR Controller the render thread has access to the most up to date tracking data of the HMD and the location of the ARVRCamera can lag a few milliseconds behind what is used for rendering as a result. diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index c2c5cde21..1d151cc0d 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRController.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRController: @@ -13,7 +14,7 @@ ARVRController Brief Description ----------------- - +A spatial node representing a spatially tracked controller. Member Functions ---------------- @@ -23,6 +24,8 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_controller_name` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hand` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_active` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_joystick_axis` **(** :ref:`int` axis **)** const | @@ -38,13 +41,26 @@ Signals ------- - **button_pressed** **(** :ref:`int` button **)** +When a button on this controller is pressed, this signal is given. + - **button_release** **(** :ref:`int` button **)** +When a button on this controller is released, this signal is given. + Member Variables ---------------- - :ref:`int` **controller_id** +Description +----------- + +This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy pass throughs to the state of buttons and such on the controllers. + +Controllers are linked by their id. You can create controller nodes before the controllers are available. Say your game always uses two controllers (one for each hand) you can predefine the controllers with id 1 and 2 and they will become active as soon as the controllers are identified. If you expect additional controllers to be used you should react to the signals and add ARVRController nodes to your scene. + +The position of the controller node is automatically updated by the ARVR Server. This makes this node ideal to add child nodes to visualise the controller. + Member Function Description --------------------------- @@ -52,28 +68,46 @@ Member Function Description - :ref:`int` **get_controller_id** **(** **)** const +Returns the controller id currently assigned to this node. + .. _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: + +- :ref:`int` **get_hand** **(** **)** const + .. _class_ARVRController_get_is_active: - :ref:`bool` **get_is_active** **(** **)** const +Returns true if the controller bound to this node is currently active and being tracked. + .. _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: - :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: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const +Is the given button currently pressed? + .. _class_ARVRController_set_controller_id: - void **set_controller_id** **(** :ref:`int` controller_id **)** +Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off. + diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 8f23bff70..24b03c6b8 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRInterface.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRInterface: @@ -15,7 +16,7 @@ ARVRInterface Brief Description ----------------- - +Base class for ARVR interface implementation. Member Functions ---------------- @@ -50,9 +51,16 @@ Member Variables Numeric Constants ----------------- -- **EYE_MONO** = **0** -- **EYE_LEFT** = **1** -- **EYE_RIGHT** = **2** +- **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. +- **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. + +Description +----------- + +This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDNative modules (note that for GDNative the subclass ARVRScriptInterface should be used). Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform. + +Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through ARVRServer. Member Function Description --------------------------- @@ -61,40 +69,68 @@ Member Function Description - :ref:`String` **get_name** **(** **)** const +Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). + .. _class_ARVRInterface_get_recommended_render_targetsize: - :ref:`Vector2` **get_recommended_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_hmd_is_present: - :ref:`bool` **hmd_is_present** **(** **)** +Returns true if an HMD is available for this interface. + .. _class_ARVRInterface_initialize: - :ref:`bool` **initialize** **(** **)** +Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. + +After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence. + +Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR. + +If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different. + +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_initialized: - :ref:`bool` **is_initialized** **(** **)** +Returns true if this interface is active. + .. _class_ARVRInterface_is_installed: - :ref:`bool` **is_installed** **(** **)** +Returns true if this interface has been installed. Say your game is designed to work with OpenVR so you are using the OpenVR interface but the user hasn't installed SteamVR, this would return false. + .. _class_ARVRInterface_is_primary: - :ref:`bool` **is_primary** **(** **)** +Returns true if this interface is currently the primary interface (the interface responsible for showing the output). + .. _class_ARVRInterface_set_is_primary: - void **set_is_primary** **(** :ref:`bool` enable **)** +Set this interface to the primary interface (unset the old one). + .. _class_ARVRInterface_supports_hmd: - :ref:`bool` **supports_hmd** **(** **)** +Returns true if this interface supports HMDs and by extension uses stereo scopic rendering. + .. _class_ARVRInterface_uninitialize: - void **uninitialize** **(** **)** +Turns the interface off. + diff --git a/classes/class_arvrorigin.rst b/classes/class_arvrorigin.rst index a3d6a5290..b651cb2a7 100644 --- a/classes/class_arvrorigin.rst +++ b/classes/class_arvrorigin.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVROrigin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVROrigin: @@ -13,7 +14,7 @@ ARVROrigin Brief Description ----------------- - +Our origin point in AR/VR. Member Functions ---------------- @@ -29,6 +30,17 @@ Member Variables - :ref:`float` **world_scale** +Description +----------- + +This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world. + +There should be only one of these nodes in your scene and you must have one. All the ARVRCamera, ARVRController and ARVRAnchor nodes should be direct children of this node for spatial tracking to work correctly. + +It is the position of this node that you update when you're character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point. + +So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc. + Member Function Description --------------------------- @@ -36,8 +48,16 @@ Member Function Description - :ref:`float` **get_world_scale** **(** **)** const +Get the world scale applied to our positioning. + .. _class_ARVROrigin_set_world_scale: - void **set_world_scale** **(** :ref:`float` world_scale **)** +Changes the world scaling factor. + +Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game. + +Note that this method is a passthrough to the ARVRServer itself. + diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 372067911..9ba9b5f52 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRPositionalTracker.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRPositionalTracker: @@ -13,11 +14,13 @@ ARVRPositionalTracker Brief Description ----------------- - +A tracked object Member Functions ---------------- ++------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hand` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joy_id` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ @@ -36,39 +39,75 @@ Member Functions | :ref:`int` | :ref:`get_type` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +Numeric Constants +----------------- + +- **TRACKER_HAND_UNKNOWN** = **0** +- **TRACKER_LEFT_HAND** = **1** +- **TRACKER_RIGHT_HAND** = **2** + +Description +----------- + +An instance of this object represents a device that is tracked such as a controller or anchor point. HMDs aren't represented here as they are fully handled internally. + +As controllers are turned on and the AR/VR interface detects them instances of this object are automatically added to this list of active tracking objects accessible through the ARVRServer + +The ARVRController and ARVRAnchor both consume objects of this type and should be the objects you use in game. The positional trackers are just the under the hood objects that make this all work and are mostly exposed so GDNative based interfaces can interact with them. + Member Function Description --------------------------- +.. _class_ARVRPositionalTracker_get_hand: + +- :ref:`int` **get_hand** **(** **)** const + .. _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: - :ref:`String` **get_name** **(** **)** const +If available this returns the name of the controller or anchor point. + .. _class_ARVRPositionalTracker_get_orientation: - :ref:`Basis` **get_orientation** **(** **)** const +Returns the orientation matrix of the controller. + .. _class_ARVRPositionalTracker_get_position: - :ref:`Vector3` **get_position** **(** **)** const +Returns the position of the controller adjusted by world scale. + .. _class_ARVRPositionalTracker_get_tracks_orientation: - :ref:`bool` **get_tracks_orientation** **(** **)** const +Returns true if the orientation of this device is being tracked. + .. _class_ARVRPositionalTracker_get_tracks_position: - :ref:`bool` **get_tracks_position** **(** **)** const +Returns true if the position of this device is being tracked. + .. _class_ARVRPositionalTracker_get_transform: - :ref:`Transform` **get_transform** **(** :ref:`bool` adjust_by_reference_frame **)** const +Returns the transform combining the orientation and position of this device. + .. _class_ARVRPositionalTracker_get_type: - :ref:`int` **get_type** **(** **)** const +Type of tracker. + diff --git a/classes/class_arvrscriptinterface.rst b/classes/class_arvrscriptinterface.rst index 5bb8ffac8..635bf08df 100644 --- a/classes/class_arvrscriptinterface.rst +++ b/classes/class_arvrscriptinterface.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRScriptInterface.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRScriptInterface: @@ -13,7 +14,7 @@ ARVRScriptInterface Brief Description ----------------- - +Base class for GDNative based ARVR interfaces. Member Functions ---------------- @@ -44,6 +45,11 @@ Member Functions | void | :ref:`uninitialize` **(** **)** virtual | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +This class is used as a base class/interface class for implementing GDNative based ARVR interfaces and as a result exposes more of the internals of the ARVR server. + Member Function Description --------------------------- @@ -51,48 +57,72 @@ Member Function Description - void **_get_projection_for_eye** **(** **)** virtual +Should return the projection 4x4 matrix for the requested eye. + .. _class_ARVRScriptInterface_commit_for_eye: - void **commit_for_eye** **(** :ref:`int` eye, :ref:`RID` render_target **)** virtual +Outputs a finished render buffer to the AR/VR device for the given eye. + .. _class_ARVRScriptInterface_get_recommended_render_targetsize: - :ref:`Vector2` **get_recommended_render_targetsize** **(** **)** virtual +Returns the size at which we should render our scene to get optimal quality on the output device. + .. _class_ARVRScriptInterface_get_transform_for_eye: - :ref:`Transform` **get_transform_for_eye** **(** :ref:`int` eye, :ref:`Transform` cam_transform **)** virtual +Get the location and orientation transform used when rendering a specific eye. + .. _class_ARVRScriptInterface_hmd_is_present: - :ref:`bool` **hmd_is_present** **(** **)** virtual +Return true is an HMD is available. + .. _class_ARVRScriptInterface_initialize: - :ref:`bool` **initialize** **(** **)** virtual +Initialize this interface. + .. _class_ARVRScriptInterface_is_initialized: - :ref:`bool` **is_initialized** **(** **)** virtual +Returns true if this interface has been initialized and is active. + .. _class_ARVRScriptInterface_is_installed: - :ref:`bool` **is_installed** **(** **)** virtual +Returns true if the required middleware is installed. + .. _class_ARVRScriptInterface_is_stereo: - :ref:`bool` **is_stereo** **(** **)** virtual +Returns true if we require stereoscopic rendering for this interface. + .. _class_ARVRScriptInterface_process: - void **process** **(** **)** virtual +Gets called before rendering each frame so tracking data gets updated in time. + .. _class_ARVRScriptInterface_supports_hmd: - :ref:`bool` **supports_hmd** **(** **)** virtual +Returns true if this interface supports HMDs. + .. _class_ARVRScriptInterface_uninitialize: - void **uninitialize** **(** **)** virtual +Turn this interface off. + diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 2f2f7d63a..c3995fa86 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ARVRServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ARVRServer: @@ -13,7 +14,7 @@ ARVRServer Brief Description ----------------- - +This is our AR/VR Server. Member Functions ---------------- @@ -48,9 +49,17 @@ Signals ------- - **interface_added** **(** :ref:`String` name **)** +Signal send when a new interface has been added. + - **interface_removed** **(** :ref:`String` name **)** -- **tracker_added** **(** :ref:`String` name, :ref:`int` type **)** -- **tracker_removed** **(** :ref:`String` name **)** +Signal send when an interface is removed. + +- **tracker_added** **(** :ref:`String` 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. + +- **tracker_removed** **(** :ref:`String` name, :ref:`int` type, :ref:`int` id **)** +Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). + Member Variables ---------------- @@ -60,12 +69,17 @@ Member Variables Numeric Constants ----------------- -- **TRACKER_CONTROLLER** = **1** -- **TRACKER_BASESTATION** = **2** -- **TRACKER_ANCHOR** = **4** -- **TRACKER_UNKNOWN** = **128** -- **TRACKER_ANY_KNOWN** = **127** -- **TRACKER_ANY** = **255** +- **TRACKER_CONTROLLER** = **1** --- Our tracker tracks the location of a controller. +- **TRACKER_BASESTATION** = **2** --- Our tracker tracks the location of a base station. +- **TRACKER_ANCHOR** = **4** --- Our tracker tracks the location and size of an AR anchor. +- **TRACKER_UNKNOWN** = **128** --- Used internally if we haven't set the tracker type yet. +- **TRACKER_ANY_KNOWN** = **127** --- Used internally to filter trackers of any known type. +- **TRACKER_ANY** = **255** --- Used interally to select all trackers. + +Description +----------- + +The AR/VR Server is the heart of our AR/VR solution and handles all the processing. Member Function Description --------------------------- @@ -74,48 +88,82 @@ Member Function Description - void **add_interface** **(** :ref:`ARVRInterface` arg0 **)** +Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server. + .. _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_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: - :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 throught 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_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: - :ref:`ARVRPositionalTracker` **get_tracker** **(** :ref:`int` idx **)** const +Get the positional tracker at the given ID. + .. _class_ARVRServer_get_tracker_count: - :ref:`int` **get_tracker_count** **(** **)** const +Get the number of trackers currently registered. + .. _class_ARVRServer_get_world_scale: - :ref:`float` **get_world_scale** **(** **)** const +Returns our world scale (see ARVROrigin for more information). + .. _class_ARVRServer_remove_interface: - void **remove_interface** **(** :ref:`ARVRInterface` arg0 **)** +Removes a registered interface, again exposed mostly for GDNative based interfaces. + .. _class_ARVRServer_request_reference_frame: - void **request_reference_frame** **(** :ref:`bool` ignore_tilt, :ref:`bool` keep_height **)** +This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently. + +For platforms that do not offer spatial tracking our origin point (0,0,0) is the location of our HMD but you have little control over the direction the player is facing in the real world. + +For platforms that do offer spatial tracking our origin point depends very much on the system. For OpenVR our origin point is usually the center of the tracking space, on the ground. For other platforms its often the location of the tracking camera. + +This method allows you to create a reference frame, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world. + +For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game. + +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_set_primary_interface: - void **set_primary_interface** **(** :ref:`ARVRInterface` arg0 **)** +Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. + .. _class_ARVRServer_set_world_scale: - void **set_world_scale** **(** :ref:`float` arg0 **)** +Changing the world scale, see the ARVROrigin documentation for more information. + diff --git a/classes/class_astar.rst b/classes/class_astar.rst index c2d549b9a..b5a032b20 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AStar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AStar: @@ -18,39 +19,41 @@ AStar class representation that uses vectors as edges. Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1.0 **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_position **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_position_in_segment` **(** :ref:`Vector3` to_position **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` id **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_points` **(** **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -66,90 +69,148 @@ Member Function Description - void **_compute_cost** **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual +Called when computing the cost between two connected points. + .. _class_AStar__estimate_cost: - void **_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: -- void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1.0 **)** +- void **add_point** **(** :ref:`int` id, :ref:`Vector3` position, :ref:`float` weight_scale=1.0 **)** -Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger. +Adds a new point at the given position with the given identifier. The algorithm prefers points with lower ``weight_scale`` to form a path. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 1 or larger. + +:: + + var as = AStar.new() + + as.add_point(1, Vector3(1,0,0), 4) # Adds the point (1,0,0) with weight_scale=4 and id=1 .. _class_AStar_are_points_connected: - :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const -Returns if there is a connection/segment between points ``id`` and ``from_id`` +Returns whether there is a connection/segment between the given points. .. _class_AStar_clear: - void **clear** **(** **)** -Clear all the points and segments from AStar instance. +Clears all the points and segments. .. _class_AStar_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** -Create a segment between points ``id`` and ``to_id``. +Creates a segment between the given points. + +:: + + var as = AStar.new() + + as.add_point(1, Vector3(1,1,0)) + as.add_point(2, Vector3(0,5,0)) + + 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: - void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** -Deletes a segment between points ``id`` and ``to_id``. +Deletes the segment between the given points. .. _class_AStar_get_available_point_id: - :ref:`int` **get_available_point_id** **(** **)** const +Returns an id with no point associated to it. + .. _class_AStar_get_closest_point: -- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_pos **)** const +- :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_position **)** const -Returns the id of closest point of given point. -1 is returned if there are no points on AStar. +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_pos_in_segment: +.. _class_AStar_get_closest_position_in_segment: -- :ref:`Vector3` **get_closest_pos_in_segment** **(** :ref:`Vector3` to_pos **)** const +- :ref:`Vector3` **get_closest_position_in_segment** **(** :ref:`Vector3` to_position **)** const -Returns the position of closest point that has segments. +Returns the closest position to ``to_position`` that resides inside a segment between two connected points. + +:: + + var as = AStar.new() + + as.add_point(1, Vector3(0,0,0)) + as.add_point(2, Vector3(0,5,0)) + + as.connect_points(1, 2) + + var res = as.get_closest_position_in_segment(Vector3(3,3,0)) # returns (0, 3, 0) + +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: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** -Returns an array with the point ids of path found by AStar between two given points. +Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. + +:: + + var as = AStar.new() + + as.add_point(1, Vector3(0,0,0)) + as.add_point(2, Vector3(0,1,0), 1) # default weight is 1 + as.add_point(3, Vector3(1,1,0)) + as.add_point(4, Vector3(2,0,0)) + + as.connect_points(1, 2, false) + as.connect_points(2, 3, false) + as.connect_points(4, 3, false) + as.connect_points(1, 4, false) + as.connect_points(5, 4, false) + + var res = as.get_id_path(1, 3) # returns [1, 2, 3] + +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_path: - :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** -Returns an array with the points of path found by AStar between two given points. +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_pos: +.. _class_AStar_get_point_position: -- :ref:`Vector3` **get_point_pos** **(** :ref:`int` id **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` id **)** const -Returns the position of point with given id. +Returns the position of the point associated with the given id. .. _class_AStar_get_point_weight_scale: - :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const -Returns the weight scale of point with given id. +Returns the weight scale of the point associated with the given id. + +.. _class_AStar_get_points: + +- :ref:`Array` **get_points** **(** **)** .. _class_AStar_has_point: - :ref:`bool` **has_point** **(** :ref:`int` id **)** const -Returns if the point with given id exists on AStar; +Returns whether a point associated with the given id exists. .. _class_AStar_remove_point: - void **remove_point** **(** :ref:`int` id **)** -Removes the point with given id. +Removes the point associated with the given id from the points pool. diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index 695eb493f..42257e584 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AtlasTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AtlasTexture: @@ -13,7 +14,7 @@ AtlasTexture Brief Description ----------------- - +Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. Member Functions ---------------- @@ -35,9 +36,16 @@ Member Functions Member Variables ---------------- -- :ref:`Texture` **atlas** -- :ref:`Rect2` **margin** -- :ref:`Rect2` **region** +- :ref:`Texture` **atlas** - The texture that contains the atlas. Can be any [Texture] subtype. +- :ref:`Rect2` **margin** - The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. +- :ref:`Rect2` **region** - The AtlasTexture's used region. + +Description +----------- + +:ref:`Texture` resource aimed at managing big textures files that pack multiple smaller textures. Consists of a :ref:`Texture`, a margin that defines the border width, + +and a region that defines the actual area of the AtlasTexture. Member Function Description --------------------------- diff --git a/classes/class_audiobuslayout.rst b/classes/class_audiobuslayout.rst index 97bdf56a4..ac13c60d4 100644 --- a/classes/class_audiobuslayout.rst +++ b/classes/class_audiobuslayout.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioBusLayout.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioBusLayout: diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 263bc3c9f..9cb61ff84 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffect: @@ -8,12 +9,17 @@ AudioEffect **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectPanner`, :ref:`AudioEffectReverb`, :ref:`AudioEffectEQ`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` **Category:** Core Brief Description ----------------- +Audio Effect For Audio. +Description +----------- + +Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on. diff --git a/classes/class_audioeffectamplify.rst b/classes/class_audioeffectamplify.rst index f819e0b0d..76dd79845 100644 --- a/classes/class_audioeffectamplify.rst +++ b/classes/class_audioeffectamplify.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectAmplify.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectAmplify: @@ -13,7 +14,7 @@ AudioEffectAmplify Brief Description ----------------- - +Amplifies the volume of an audio source. Member Functions ---------------- @@ -27,7 +28,12 @@ Member Functions Member Variables ---------------- -- :ref:`float` **volume_db** +- :ref:`float` **volume_db** - The effect's volume limit. + +Description +----------- + +Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus. Member Function Description --------------------------- @@ -36,8 +42,12 @@ Member Function Description - :ref:`float` **get_volume_db** **(** **)** const +Returns the set maximum volume. + .. _class_AudioEffectAmplify_set_volume_db: - void **set_volume_db** **(** :ref:`float` volume **)** +Sets the maximum volume. + diff --git a/classes/class_audioeffectbandlimitfilter.rst b/classes/class_audioeffectbandlimitfilter.rst index 209e9ea75..1d9b6018d 100644 --- a/classes/class_audioeffectbandlimitfilter.rst +++ b/classes/class_audioeffectbandlimitfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectBandLimitFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectBandLimitFilter: diff --git a/classes/class_audioeffectbandpassfilter.rst b/classes/class_audioeffectbandpassfilter.rst index fee17856f..114a73001 100644 --- a/classes/class_audioeffectbandpassfilter.rst +++ b/classes/class_audioeffectbandpassfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectBandPassFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectBandPassFilter: diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index acc6874c5..3f567177b 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectChorus.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectChorus: @@ -13,7 +14,7 @@ AudioEffectChorus Brief Description ----------------- - +Adds a chorus audio effect. Member Functions ---------------- @@ -59,33 +60,38 @@ Member Functions Member Variables ---------------- -- :ref:`float` **dry** -- :ref:`float` **voice/1/cutoff_hz** -- :ref:`float` **voice/1/delay_ms** -- :ref:`float` **voice/1/depth_ms** -- :ref:`float` **voice/1/level_db** -- :ref:`float` **voice/1/pan** -- :ref:`float` **voice/1/rate_hz** -- :ref:`float` **voice/2/cutoff_hz** -- :ref:`float` **voice/2/delay_ms** -- :ref:`float` **voice/2/depth_ms** -- :ref:`float` **voice/2/level_db** -- :ref:`float` **voice/2/pan** -- :ref:`float` **voice/2/rate_hz** -- :ref:`float` **voice/3/cutoff_hz** -- :ref:`float` **voice/3/delay_ms** -- :ref:`float` **voice/3/depth_ms** -- :ref:`float` **voice/3/level_db** -- :ref:`float` **voice/3/pan** -- :ref:`float` **voice/3/rate_hz** -- :ref:`float` **voice/4/cutoff_hz** -- :ref:`float` **voice/4/delay_ms** -- :ref:`float` **voice/4/depth_ms** -- :ref:`float` **voice/4/level_db** -- :ref:`float` **voice/4/pan** -- :ref:`float` **voice/4/rate_hz** -- :ref:`int` **voice_count** -- :ref:`float` **wet** +- :ref:`float` **dry** - The effect's raw signal. +- :ref:`float` **voice/1/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/1/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/1/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/1/level_db** - The voice's volume. +- :ref:`float` **voice/1/pan** - The voice's pan level. +- :ref:`float` **voice/1/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/2/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/2/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/2/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/2/level_db** - The voice's volume. +- :ref:`float` **voice/2/pan** - The voice's pan level. +- :ref:`float` **voice/2/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/3/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/3/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/3/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/3/level_db** - The voice's volume. +- :ref:`float` **voice/3/pan** - The voice's pan level. +- :ref:`float` **voice/3/rate_hz** - The voice's filter rate. +- :ref:`float` **voice/4/cutoff_hz** - The voice's cutoff frequency. +- :ref:`float` **voice/4/delay_ms** - The voice's signal delay. +- :ref:`float` **voice/4/depth_ms** - The voice filter's depth. +- :ref:`float` **voice/4/level_db** - The voice's volume. +- :ref:`float` **voice/4/pan** - The voice's pan level. +- :ref:`float` **voice/4/rate_hz** - The voice's filter rate. +- :ref:`int` **voice_count** - The amount of voices in the effect. +- :ref:`float` **wet** - The effect's processed signal. + +Description +----------- + +Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. Member Function Description --------------------------- @@ -94,72 +100,108 @@ Member Function Description - :ref:`float` **get_dry** **(** **)** const +Returns the set dry ratio. + .. _class_AudioEffectChorus_get_voice_count: - :ref:`int` **get_voice_count** **(** **)** const +Returns the set voice count. + .. _class_AudioEffectChorus_get_voice_cutoff_hz: - :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** const +Returns the voice's set cutoff frequency. + .. _class_AudioEffectChorus_get_voice_delay_ms: - :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** const +Returns the voice's set delay. + .. _class_AudioEffectChorus_get_voice_depth_ms: - :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** const +Returns the voice's set filter depth. + .. _class_AudioEffectChorus_get_voice_level_db: - :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** const +Returns the voice's set maximum volume. + .. _class_AudioEffectChorus_get_voice_pan: - :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** const +Returns the voice's set pan. + .. _class_AudioEffectChorus_get_voice_rate_hz: - :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** const +Returns the voice filter's set rate in cycles. + .. _class_AudioEffectChorus_get_wet: - :ref:`float` **get_wet** **(** **)** const +Returns the set applied wetness of the effect. + .. _class_AudioEffectChorus_set_dry: - void **set_dry** **(** :ref:`float` amount **)** +Returns the set applied dryness of the effect. + .. _class_AudioEffectChorus_set_voice_count: - void **set_voice_count** **(** :ref:`int` voices **)** +Set the number of voices in the effect's filter. + .. _class_AudioEffectChorus_set_voice_cutoff_hz: - void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** +Set the cutoff frequency of the voice. The maximum frequency the voice may affect. + .. _class_AudioEffectChorus_set_voice_delay_ms: - void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** +Set the delay of the voice's signal. + .. _class_AudioEffectChorus_set_voice_depth_ms: - void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** +Set the filter depth of the voice's signal. + .. _class_AudioEffectChorus_set_voice_level_db: - void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** +Set the volume level of the voice. + .. _class_AudioEffectChorus_set_voice_pan: - void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** +Set the pan level of the voice. + .. _class_AudioEffectChorus_set_voice_rate_hz: - void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** +Set the voice filter's rate. + .. _class_AudioEffectChorus_set_wet: - void **set_wet** **(** :ref:`float` amount **)** +Set the amount of effect. + diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 33ad4bd46..89f841305 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectCompressor.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectCompressor: diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index 6f334818c..df8cd71bb 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectDelay.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectDelay: diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index ff790af49..44be866b7 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectDistortion.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectDistortion: @@ -49,6 +50,15 @@ Member Variables - :ref:`float` **post_gain** - :ref:`float` **pre_gain** +Numeric Constants +----------------- + +- **MODE_CLIP** = **0** +- **MODE_ATAN** = **1** +- **MODE_LOFI** = **2** +- **MODE_OVERDRIVE** = **3** +- **MODE_WAVESHAPE** = **4** + Member Function Description --------------------------- diff --git a/classes/class_audioeffecteq.rst b/classes/class_audioeffecteq.rst index 82df0ea95..22fe6f33c 100644 --- a/classes/class_audioeffecteq.rst +++ b/classes/class_audioeffecteq.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectEQ.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectEQ: diff --git a/classes/class_audioeffecteq10.rst b/classes/class_audioeffecteq10.rst index a843ad586..1f8e6c35d 100644 --- a/classes/class_audioeffecteq10.rst +++ b/classes/class_audioeffecteq10.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectEQ10.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectEQ10: diff --git a/classes/class_audioeffecteq21.rst b/classes/class_audioeffecteq21.rst index b42cad674..ef5800b96 100644 --- a/classes/class_audioeffecteq21.rst +++ b/classes/class_audioeffecteq21.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectEQ21.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectEQ21: diff --git a/classes/class_audioeffecteq6.rst b/classes/class_audioeffecteq6.rst index 21095cb2f..407a787e8 100644 --- a/classes/class_audioeffecteq6.rst +++ b/classes/class_audioeffecteq6.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectEQ6.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectEQ6: diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 32b84ee37..4da3fd238 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectFilter: @@ -46,6 +47,14 @@ Member Variables - :ref:`float` **gain** - :ref:`float` **resonance** +Numeric Constants +----------------- + +- **FILTER_6DB** = **0** +- **FILTER_12DB** = **1** +- **FILTER_18DB** = **2** +- **FILTER_24DB** = **3** + Member Function Description --------------------------- diff --git a/classes/class_audioeffecthighpassfilter.rst b/classes/class_audioeffecthighpassfilter.rst index eb9fe9f94..ef103de5b 100644 --- a/classes/class_audioeffecthighpassfilter.rst +++ b/classes/class_audioeffecthighpassfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectHighPassFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectHighPassFilter: diff --git a/classes/class_audioeffecthighshelffilter.rst b/classes/class_audioeffecthighshelffilter.rst index e3d0f7b66..413cb782c 100644 --- a/classes/class_audioeffecthighshelffilter.rst +++ b/classes/class_audioeffecthighshelffilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectHighShelfFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectHighShelfFilter: diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index 4a9ea19f3..8cdbe69f4 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectLimiter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectLimiter: diff --git a/classes/class_audioeffectlowpassfilter.rst b/classes/class_audioeffectlowpassfilter.rst index d4649aef3..b3ca30f63 100644 --- a/classes/class_audioeffectlowpassfilter.rst +++ b/classes/class_audioeffectlowpassfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectLowPassFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectLowPassFilter: diff --git a/classes/class_audioeffectlowshelffilter.rst b/classes/class_audioeffectlowshelffilter.rst index 384575034..e772f2b3e 100644 --- a/classes/class_audioeffectlowshelffilter.rst +++ b/classes/class_audioeffectlowshelffilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectLowShelfFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectLowShelfFilter: diff --git a/classes/class_audioeffectnotchfilter.rst b/classes/class_audioeffectnotchfilter.rst index 01bfffbf0..6ce00a044 100644 --- a/classes/class_audioeffectnotchfilter.rst +++ b/classes/class_audioeffectnotchfilter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectNotchFilter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectNotchFilter: diff --git a/classes/class_audioeffectpanner.rst b/classes/class_audioeffectpanner.rst index a8009205e..cbb5ebac5 100644 --- a/classes/class_audioeffectpanner.rst +++ b/classes/class_audioeffectpanner.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectPanner: diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 063e80813..977fb846e 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectPhaser.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectPhaser: diff --git a/classes/class_audioeffectpitchshift.rst b/classes/class_audioeffectpitchshift.rst index 45c083b43..cb9c5263a 100644 --- a/classes/class_audioeffectpitchshift.rst +++ b/classes/class_audioeffectpitchshift.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectPitchShift.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectPitchShift: diff --git a/classes/class_audioeffectreverb.rst b/classes/class_audioeffectreverb.rst index d4f3f9d28..7a80cc328 100644 --- a/classes/class_audioeffectreverb.rst +++ b/classes/class_audioeffectreverb.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectReverb.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectReverb: diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 82b3b2d50..ffdb1054f 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioEffectStereoEnhance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioEffectStereoEnhance: diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 0e6c010c2..e90af081c 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioServer: @@ -18,79 +19,86 @@ Server interface for low level audio access. Member Functions ---------------- -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus` **(** :ref:`int` at_pos=-1 **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=-1 **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_count` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_speaker_mode` **(** **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus` **(** :ref:`int` index **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_count` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_speaker_mode` **(** **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus` **(** :ref:`int` index **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **bus_layout_changed** **(** **)** +Numeric Constants +----------------- + +- **SPEAKER_MODE_STEREO** = **0** +- **SPEAKER_SURROUND_51** = **2** +- **SPEAKER_SURROUND_71** = **3** + Description ----------- @@ -101,11 +109,11 @@ Member Function Description .. _class_AudioServer_add_bus: -- void **add_bus** **(** :ref:`int` at_pos=-1 **)** +- void **add_bus** **(** :ref:`int` at_position=-1 **)** .. _class_AudioServer_add_bus_effect: -- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_pos=-1 **)** +- void **add_bus_effect** **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** .. _class_AudioServer_generate_bus_layout: diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index a4513f3d3..70ac31caf 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStream.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStream: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index 328116cfe..3b40249c2 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamOGGVorbis.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamOGGVorbis: @@ -35,9 +36,9 @@ Member Functions Member Variables ---------------- -- :ref:`PoolByteArray` **data** -- :ref:`bool` **loop** -- :ref:`float` **loop_offset** +- :ref:`PoolByteArray` **data** - Raw audio data. +- :ref:`bool` **loop** - If [code]true[/code], audio will loop continuously. Default value: [code]false[/code]. +- :ref:`float` **loop_offset** - If loop is [code]true[/code], loop starts from this position, in seconds. Description ----------- diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index ba2ccece3..5fbd82889 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamPlayback.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamPlayback: diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index c93f3a0b8..1704ad0f6 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamPlayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamPlayer: @@ -13,7 +14,7 @@ AudioStreamPlayer Brief Description ----------------- - +Plays back audio. Member Functions ---------------- @@ -23,7 +24,7 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mix_target` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | +| :ref:`float` | :ref:`get_position` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -33,9 +34,9 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | +| void | :ref:`seek` **(** :ref:`float` to_position **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -54,16 +55,30 @@ Signals ------- - **finished** **(** **)** +Emitted when the audio stops playing. + Member Variables ---------------- -- :ref:`bool` **autoplay** -- :ref:`String` **bus** +- :ref:`bool` **autoplay** - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. +- :ref:`String` **bus** - Bus on which this audio is playing. - :ref:`int` **mix_target** -- :ref:`bool` **playing** -- :ref:`AudioStream` **stream** -- :ref:`float` **volume_db** +- :ref:`bool` **playing** - If [code]true[/code], audio is playing. +- :ref:`AudioStream` **stream** - The [AudioStream] object to be played. +- :ref:`float` **volume_db** - Volume of sound, in dB. + +Numeric Constants +----------------- + +- **MIX_TARGET_STEREO** = **0** +- **MIX_TARGET_SURROUND** = **1** +- **MIX_TARGET_CENTER** = **2** + +Description +----------- + +Plays background audio. Member Function Description --------------------------- @@ -76,9 +91,9 @@ Member Function Description - :ref:`int` **get_mix_target** **(** **)** const -.. _class_AudioStreamPlayer_get_pos: +.. _class_AudioStreamPlayer_get_position: -- :ref:`float` **get_pos** **(** **)** +- :ref:`float` **get_position** **(** **)** .. _class_AudioStreamPlayer_get_stream: @@ -98,11 +113,15 @@ Member Function Description .. _class_AudioStreamPlayer_play: -- void **play** **(** :ref:`float` from_pos=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** + +Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer_seek: -- void **seek** **(** :ref:`float` to_pos **)** +- void **seek** **(** :ref:`float` to_position **)** + +Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer_set_autoplay: @@ -128,4 +147,6 @@ Member Function Description - void **stop** **(** **)** +Stops the audio. + diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 7cbbdf818..d5313eebb 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamPlayer2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamPlayer2D: @@ -13,7 +14,7 @@ AudioStreamPlayer2D Brief Description ----------------- - +Plays audio in 2D. Member Functions ---------------- @@ -27,8 +28,6 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_max_distance` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_volume_db` **(** **)** const | @@ -37,9 +36,9 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | +| void | :ref:`seek` **(** :ref:`float` to_position **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------+ @@ -62,18 +61,25 @@ Signals ------- - **finished** **(** **)** +Emitted when the audio stops playing. + Member Variables ---------------- -- :ref:`int` **area_mask** -- :ref:`float` **attenuation** -- :ref:`bool` **autoplay** -- :ref:`String` **bus** -- :ref:`float` **max_distance** -- :ref:`bool` **playing** -- :ref:`AudioStream` **stream** -- :ref:`float` **volume_db** +- :ref:`int` **area_mask** - Areas in which this sound plays. +- :ref:`float` **attenuation** - Dampens audio over distance with this as an exponent. +- :ref:`bool` **autoplay** - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. +- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`float` **max_distance** - Maximum distance from which audio is still hearable. +- :ref:`bool` **playing** - If [code]true[/code], audio is playing. +- :ref:`AudioStream` **stream** - The [AudioStream] object to be played. +- :ref:`float` **volume_db** - Base volume without dampening. + +Description +----------- + +Plays audio that dampens with distance from screen center. Member Function Description --------------------------- @@ -94,10 +100,6 @@ Member Function Description - :ref:`float` **get_max_distance** **(** **)** const -.. _class_AudioStreamPlayer2D_get_pos: - -- :ref:`float` **get_pos** **(** **)** - .. _class_AudioStreamPlayer2D_get_stream: - :ref:`AudioStream` **get_stream** **(** **)** const @@ -116,11 +118,15 @@ Member Function Description .. _class_AudioStreamPlayer2D_play: -- void **play** **(** :ref:`float` from_pos=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** + +Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer2D_seek: -- void **seek** **(** :ref:`float` to_pos **)** +- void **seek** **(** :ref:`float` to_position **)** + +Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer2D_set_area_mask: @@ -154,4 +160,6 @@ Member Function Description - void **stop** **(** **)** +Stops the audio. + diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 310c8d319..7e4b5cae5 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamPlayer3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamPlayer3D: @@ -13,7 +14,7 @@ AudioStreamPlayer3D Brief Description ----------------- - +Plays 3D sound in 3D space Member Functions ---------------- @@ -41,7 +42,7 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | +| :ref:`float` | :ref:`get_position` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStream` | :ref:`get_stream` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,9 +56,9 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** const | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0.0 **)** | +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | +| void | :ref:`seek` **(** :ref:`float` to_position **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -98,39 +99,46 @@ Signals ------- - **finished** **(** **)** +Fires when the audio stops playing. + Member Variables ---------------- -- :ref:`int` **area_mask** -- :ref:`float` **attenuation_filter_cutoff_hz** -- :ref:`float` **attenuation_filter_db** -- :ref:`int` **attenuation_model** -- :ref:`bool` **autoplay** -- :ref:`String` **bus** -- :ref:`int` **doppler_tracking** -- :ref:`float` **emission_angle_degrees** -- :ref:`bool` **emission_angle_enabled** -- :ref:`float` **emission_angle_filter_attenuation_db** -- :ref:`float` **max_db** -- :ref:`float` **max_distance** -- :ref:`int` **out_of_range_mode** -- :ref:`bool` **playing** -- :ref:`AudioStream` **stream** -- :ref:`float` **unit_db** -- :ref:`float` **unit_size** +- :ref:`int` **area_mask** - Areas in which this sound plays. +- :ref:`float` **attenuation_filter_cutoff_hz** - Dampens audio above this frequency, in Hz. +- :ref:`float` **attenuation_filter_db** - Amount how much the filter affects the loudness, in dB. +- :ref:`int` **attenuation_model** - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. +- :ref:`bool` **autoplay** - If [code]true[/code], audio plays audio plays when added to scene tree. Default value: [code]false[/code]. +- :ref:`String` **bus** - Bus on which this audio is playing. +- :ref:`int` **doppler_tracking** - Decides in which step the Doppler effect should be calculated. +- :ref:`float` **emission_angle_degrees** - The angle in which the audio reaches cameras undampened. +- :ref:`bool` **emission_angle_enabled** - If [code]true[/code], the audio should be dampened according to the direction of the sound. +- :ref:`float` **emission_angle_filter_attenuation_db** - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. +- :ref:`float` **max_db** - Sets the absolute maximum of the soundlevel, in dB. +- :ref:`float` **max_distance** - Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 0. +- :ref:`int` **out_of_range_mode** - Decides if audio should pause when source is outside of 'max_distance' range. +- :ref:`bool` **playing** - If [code]true[/code], audio is playing. +- :ref:`AudioStream` **stream** - The [AudioStream] object to be played. +- :ref:`float` **unit_db** - Base sound level unaffected by dampening, in dB. +- :ref:`float` **unit_size** - Factor for the attenuation effect. Numeric Constants ----------------- -- **ATTENUATION_INVERSE_DISTANCE** = **0** -- **ATTENUATION_INVERSE_SQUARE_DISTANCE** = **1** -- **ATTENUATION_LOGARITHMIC** = **2** -- **OUT_OF_RANGE_MIX** = **0** -- **OUT_OF_RANGE_PAUSE** = **1** -- **DOPPLER_TRACKING_DISABLED** = **0** -- **DOPPLER_TRACKING_IDLE_STEP** = **1** -- **DOPPLER_TRACKING_FIXED_STEP** = **2** +- **ATTENUATION_INVERSE_DISTANCE** = **0** --- Linear dampening of loudness according to distance. +- **ATTENUATION_INVERSE_SQUARE_DISTANCE** = **1** --- Squared dampening of loudness according to distance. +- **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. +- **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. +- **DOPPLER_TRACKING_DISABLED** = **0** --- Disables doppler tracking. +- **DOPPLER_TRACKING_IDLE_STEP** = **1** --- Executes doppler trackin in idle step. +- **DOPPLER_TRACKING_FIXED_STEP** = **2** --- Executes doppler tracking in fixed step. + +Description +----------- + +Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. Member Function Description --------------------------- @@ -179,9 +187,9 @@ Member Function Description - :ref:`int` **get_out_of_range_mode** **(** **)** const -.. _class_AudioStreamPlayer3D_get_pos: +.. _class_AudioStreamPlayer3D_get_position: -- :ref:`float` **get_pos** **(** **)** +- :ref:`float` **get_position** **(** **)** .. _class_AudioStreamPlayer3D_get_stream: @@ -209,11 +217,15 @@ Member Function Description .. _class_AudioStreamPlayer3D_play: -- void **play** **(** :ref:`float` from_pos=0.0 **)** +- void **play** **(** :ref:`float` from_position=0.0 **)** + +Plays the audio from the given position 'from_position', in seconds. .. _class_AudioStreamPlayer3D_seek: -- void **seek** **(** :ref:`float` to_pos **)** +- void **seek** **(** :ref:`float` to_position **)** + +Sets the position from which audio will be played, in seconds. .. _class_AudioStreamPlayer3D_set_area_mask: @@ -283,4 +295,6 @@ Member Function Description - void **stop** **(** **)** +Stops the audio. + diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst index 50cbc7a98..87da5c169 100644 --- a/classes/class_audiostreamrandompitch.rst +++ b/classes/class_audiostreamrandompitch.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamRandomPitch: @@ -13,7 +14,7 @@ AudioStreamRandomPitch Brief Description ----------------- - +Plays audio with random pitch tweaking. Member Functions ---------------- @@ -31,8 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`AudioStream` **audio_stream** -- :ref:`float` **random_pitch** +- :ref:`AudioStream` **audio_stream** - The current [AudioStream]. +- :ref:`float` **random_pitch** - The intensity of random pitch variation. + +Description +----------- + +Randomly varies pitch on each start. Member Function Description --------------------------- diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 9aa43311e..1cd68586c 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the AudioStreamSample.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_AudioStreamSample: @@ -13,7 +14,7 @@ AudioStreamSample Brief Description ----------------- - +Plays audio. Member Functions ---------------- @@ -51,13 +52,28 @@ Member Functions Member Variables ---------------- -- :ref:`PoolByteArray` **data** -- :ref:`int` **format** -- :ref:`int` **loop_begin** -- :ref:`int` **loop_end** -- :ref:`int` **loop_mode** -- :ref:`int` **mix_rate** -- :ref:`bool` **stereo** +- :ref:`PoolByteArray` **data** - Raw audio data. +- :ref:`int` **format** - Audio format. See FORMAT_* constants for values. +- :ref:`int` **loop_begin** - Loop start in bytes. +- :ref:`int` **loop_end** - Loop end in bytes. +- :ref:`int` **loop_mode** - Loop mode. See LOOP_* constants for values. +- :ref:`int` **mix_rate** - The sample rate for mixing this audio. +- :ref:`bool` **stereo** - If [code]true[/code], audio is stereo. Default value: [code]false[/code]. + +Numeric Constants +----------------- + +- **FORMAT_8_BITS** = **0** --- Audio codec 8 bit. +- **FORMAT_16_BITS** = **1** --- Audio codec 16 bit. +- **FORMAT_IMA_ADPCM** = **2** --- Audio codec IMA ADPCM. +- **LOOP_DISABLED** = **0** --- Audio does not loop. +- **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. + +Description +----------- + +Plays audio, can loop. Member Function Description --------------------------- diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 5d1347322..003aa6bc9 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BackBufferCopy.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BackBufferCopy: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index b4979ea62..d645ff2a3 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BaseButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BaseButton: diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 28ac9ff47..05151fb3c 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Basis.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Basis: diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 545cb51db..5aedb27e8 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BitMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BitMap: @@ -13,7 +14,7 @@ BitMap Brief Description ----------------- - +Boolean matrix. Member Functions ---------------- @@ -23,13 +24,13 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image_alpha` **(** :ref:`Image` image **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` pos **)** const | +| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_size` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit` **(** :ref:`Vector2` pos, :ref:`bool` bit **)** | +| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -39,6 +40,11 @@ Member Variables - :ref:`Dictionary` **data** +Description +----------- + +A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates. + Member Function Description --------------------------- @@ -46,28 +52,42 @@ Member Function Description - void **create** **(** :ref:`Vector2` size **)** +Creates a bitmap with the specified size, filled with false. + .. _class_BitMap_create_from_image_alpha: - void **create_from_image_alpha** **(** :ref:`Image` image **)** +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 0, and true in other case. + .. _class_BitMap_get_bit: -- :ref:`bool` **get_bit** **(** :ref:`Vector2` pos **)** const +- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const + +Returns bitmap's value at the specified position. .. _class_BitMap_get_size: - :ref:`Vector2` **get_size** **(** **)** const +Returns bitmap's dimensions. + .. _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_set_bit: -- void **set_bit** **(** :ref:`Vector2` pos, :ref:`bool` bit **)** +- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** + +Sets the bitmap's element at the specified position, to the specified value. .. _class_BitMap_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** +Sets a rectangular portion of the bitmap to the specified value. + diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index ab97a9abb..e2f7675a6 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BitmapFont.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BitmapFont: diff --git a/classes/class_boneattachment.rst b/classes/class_boneattachment.rst index 1682cb18d..609ece128 100644 --- a/classes/class_boneattachment.rst +++ b/classes/class_boneattachment.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BoneAttachment.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BoneAttachment: @@ -36,8 +37,12 @@ Member Function Description - :ref:`String` **get_bone_name** **(** **)** const +Returns the name of the bone node attached to. + .. _class_BoneAttachment_set_bone_name: - void **set_bone_name** **(** :ref:`String` bone_name **)** +Changes the name of the bone node + diff --git a/classes/class_bool.rst b/classes/class_bool.rst index e57afd7ed..988ccd20b 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the bool.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_bool: diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index dadb71e8c..f43fef730 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BoxContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BoxContainer: @@ -15,7 +16,7 @@ BoxContainer Brief Description ----------------- -Base class for Box containers. +Base class for box containers. Member Functions ---------------- @@ -31,19 +32,19 @@ Member Functions Member Variables ---------------- -- :ref:`int` **alignment** +- :ref:`int` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). Numeric Constants ----------------- -- **ALIGN_BEGIN** = **0** --- Align children with beginning of the container. -- **ALIGN_CENTER** = **1** --- Align children with center of the container. -- **ALIGN_END** = **2** --- Align children with end of the container. +- **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container. +- **ALIGN_CENTER** = **1** --- Aligns children with the center of the container. +- **ALIGN_END** = **2** --- Aligns children with the end of the container. Description ----------- -Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes. +Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes. Member Function Description --------------------------- @@ -52,9 +53,7 @@ Member Function Description - void **add_spacer** **(** :ref:`bool` begin **)** -Add a control to the box as a spacer. - -If *begin* is true the spacer control will be inserted in front of other children. +Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children. .. _class_BoxContainer_get_alignment: diff --git a/classes/class_boxshape.rst b/classes/class_boxshape.rst index 922dcbdee..361f32c60 100644 --- a/classes/class_boxshape.rst +++ b/classes/class_boxshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the BoxShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_BoxShape: @@ -27,12 +28,12 @@ Member Functions Member Variables ---------------- -- :ref:`Vector3` **extents** +- :ref:`Vector3` **extents** - The shape's half extents. Description ----------- -Box shape resource, which can be set into a :ref:`PhysicsBody` or area. +3D box shape that can be a child of a :ref:`PhysicsBody` or :ref:`Area`. Member Function Description --------------------------- diff --git a/classes/class_button.rst b/classes/class_button.rst index 480ebbef0..fefc8a2f8 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Button.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Button: @@ -45,17 +46,17 @@ Member Functions Member Variables ---------------- -- :ref:`int` **align** -- :ref:`bool` **clip_text** -- :ref:`bool` **flat** -- :ref:`Texture` **icon** -- :ref:`String` **text** +- :ref:`int` **align** - Text alignment policy for the button's text, use one of the ALIGN_* constants. +- :ref:`bool` **clip_text** - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. +- :ref:`bool` **flat** - Flat buttons don't display decoration. +- :ref:`Texture` **icon** - Button's icon, if text is present the icon will be placed before the text. +- :ref:`String` **text** - The button's text that will be displayed inside the button's area. Numeric Constants ----------------- - **ALIGN_LEFT** = **0** --- Align the text to the left. -- **ALIGN_CENTER** = **1** --- Center the text. +- **ALIGN_CENTER** = **1** --- Align the text to the center. - **ALIGN_RIGHT** = **2** --- Align the text to the right. Description @@ -70,60 +71,40 @@ Member Function Description - :ref:`Texture` **get_button_icon** **(** **)** const -Return the button icon. - .. _class_Button_get_clip_text: - :ref:`bool` **get_clip_text** **(** **)** const -Return the state of the *clip_text* property (see :ref:`set_clip_text`) - .. _class_Button_get_text: - :ref:`String` **get_text** **(** **)** const -Return the button text. - .. _class_Button_get_text_align: - :ref:`int` **get_text_align** **(** **)** const -Return the text alignment policy. - .. _class_Button_is_flat: - :ref:`bool` **is_flat** **(** **)** const -Return the state of the *flat* property (see :ref:`set_flat`). - .. _class_Button_set_button_icon: - void **set_button_icon** **(** :ref:`Texture` texture **)** -Set the icon that will be displayed next to the text inside the button area. - .. _class_Button_set_clip_text: - void **set_clip_text** **(** :ref:`bool` enabled **)** -Set the *clip_text* property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. - .. _class_Button_set_flat: - void **set_flat** **(** :ref:`bool` enabled **)** -Set the *flat* property of a Button. Flat buttons don't display decoration unless hovered or pressed. - .. _class_Button_set_text: - void **set_text** **(** :ref:`String` text **)** -Set the button text, which will be displayed inside the button area. - .. _class_Button_set_text_align: - void **set_text_align** **(** :ref:`int` align **)** -Set the text alignment policy, using one of the ALIGN\_\* constants. - diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index e1c4bb1e0..e6fded9ca 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ButtonGroup.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ButtonGroup: diff --git a/classes/class_camera.rst b/classes/class_camera.rst index ab43189dc..c83aa0f7f 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Camera.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Camera: diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 42bd2b7b3..6632543cd 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Camera2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Camera2D: @@ -27,7 +28,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_anchor_mode` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -165,9 +166,9 @@ Force the camera to update scroll immediately. - :ref:`int` **get_anchor_mode** **(** **)** const -.. _class_Camera2D_get_camera_pos: +.. _class_Camera2D_get_camera_position: -- :ref:`Vector2` **get_camera_pos** **(** **)** const +- :ref:`Vector2` **get_camera_position** **(** **)** const Return the camera position. diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 7dad17a3b..2575c3200 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CanvasItem.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CanvasItem: @@ -23,9 +24,9 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_draw` **(** **)** virtual | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | +| void | :ref:`draw_circle` **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,15 +42,15 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,7 +82,7 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_light_mask` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_local_mouse_position` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_material` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -113,7 +114,7 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | +| :ref:`Vector2` | :ref:`make_canvas_position_local` **(** :ref:`Vector2` screen_point **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -208,13 +209,13 @@ Called (if exists) to draw the canvas item. .. _class_CanvasItem_draw_char: -- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** +- :ref:`float` **draw_char** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. .. _class_CanvasItem_draw_circle: -- void **draw_circle** **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +- void **draw_circle** **(** :ref:`Vector2` position, :ref:`float` radius, :ref:`Color` color **)** Draw a colored circle. @@ -258,7 +259,7 @@ Draw a colored rectangle. .. _class_CanvasItem_draw_set_transform: -- void **draw_set_transform** **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** +- void **draw_set_transform** **(** :ref:`Vector2` position, :ref:`float` rotation, :ref:`Vector2` scale **)** Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. @@ -268,7 +269,7 @@ Set a custom transform for drawing. Anything drawn afterwards will be transforme .. _class_CanvasItem_draw_string: -- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** +- void **draw_string** **(** :ref:`Font` font, :ref:`Vector2` position, :ref:`String` text, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** Draw a string using a custom font. @@ -280,7 +281,7 @@ Draw a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture` normal_map=null **)** Draw a texture at a given position. @@ -372,9 +373,9 @@ Return a rect containing the editable boundaries of the item. Get this item's light mask number. -.. _class_CanvasItem_get_local_mouse_pos: +.. _class_CanvasItem_get_local_mouse_position: -- :ref:`Vector2` **get_local_mouse_pos** **(** **)** const +- :ref:`Vector2` **get_local_mouse_position** **(** **)** const Get the mouse position relative to this item's position. @@ -462,9 +463,9 @@ Return true if this CanvasItem is visible. It may be invisible because itself or - :ref:`bool` **is_visible_in_tree** **(** **)** const -.. _class_CanvasItem_make_canvas_pos_local: +.. _class_CanvasItem_make_canvas_position_local: -- :ref:`Vector2` **make_canvas_pos_local** **(** :ref:`Vector2` screen_point **)** const +- :ref:`Vector2` **make_canvas_position_local** **(** :ref:`Vector2` screen_point **)** const .. _class_CanvasItem_make_input_local: diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst index 27fce1016..a3415f7f3 100644 --- a/classes/class_canvasitemmaterial.rst +++ b/classes/class_canvasitemmaterial.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CanvasItemMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CanvasItemMaterial: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index ce483ecee..6c526a201 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CanvasLayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CanvasLayer: @@ -15,7 +16,7 @@ CanvasLayer Brief Description ----------------- -Canvas Item layer. +Canvas drawing layer. Member Functions ---------------- @@ -55,15 +56,15 @@ Member Functions Member Variables ---------------- -- :ref:`int` **layer** -- :ref:`Vector2` **offset** -- :ref:`float` **rotation** -- :ref:`Vector2` **scale** +- :ref:`int` **layer** - Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. +- :ref:`Vector2` **offset** - The layer's base offset. +- :ref:`float` **rotation** - The layer's rotation in degrees. +- :ref:`Vector2` **scale** - The layer's scale. Description ----------- -Canvas Item layer. :ref:`CanvasItem` nodes that are direct or indirect children of a :ref:`CanvasLayer` will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a :ref:`CanvasLayer` with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). +Canvas drawing layer. :ref:`CanvasItem` nodes that are direct or indirect children of a :ref:`CanvasLayer` will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a :ref:`CanvasLayer` with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). Member Function Description --------------------------- diff --git a/classes/class_canvasmodulate.rst b/classes/class_canvasmodulate.rst index ba6ad115c..322a0c119 100644 --- a/classes/class_canvasmodulate.rst +++ b/classes/class_canvasmodulate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CanvasModulate.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CanvasModulate: diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst index 43c7985d4..e2a321588 100644 --- a/classes/class_capsulemesh.rst +++ b/classes/class_capsulemesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CapsuleMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CapsuleMesh: @@ -13,7 +14,7 @@ CapsuleMesh Brief Description ----------------- - +Class representing a capsule-shaped :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -39,10 +40,15 @@ Member Functions Member Variables ---------------- -- :ref:`float` **mid_height** -- :ref:`int` **radial_segments** -- :ref:`float` **radius** -- :ref:`int` **rings** +- :ref:`float` **mid_height** - Height of the capsule mesh from the center point. Defaults to 1.0. +- :ref:`int` **radial_segments** - Number of radial segments on the capsule mesh. Defaults to 64. +- :ref:`float` **radius** - Radius of the capsule mesh. Defaults to 1.0. +- :ref:`int` **rings** - Number of rings along the height of the capsule. Defaults to 8. + +Description +----------- + +Class representing a capsule-shaped :ref:`PrimitiveMesh`. Member Function Description --------------------------- diff --git a/classes/class_capsuleshape.rst b/classes/class_capsuleshape.rst index 399c6ae8c..ec3768f63 100644 --- a/classes/class_capsuleshape.rst +++ b/classes/class_capsuleshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CapsuleShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CapsuleShape: @@ -13,7 +14,7 @@ CapsuleShape Brief Description ----------------- -Capsule shape resource. +Capsule shape for collisions. Member Functions ---------------- @@ -31,13 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`float` **height** -- :ref:`float` **radius** +- :ref:`float` **height** - The capsule's height. +- :ref:`float` **radius** - The capsule's radius. Description ----------- -Capsule shape resource, which can be set into a :ref:`PhysicsBody` or area. +Capsule shape for collisions. Member Function Description --------------------------- diff --git a/classes/class_capsuleshape2d.rst b/classes/class_capsuleshape2d.rst index fd67bd16d..9b028d8c4 100644 --- a/classes/class_capsuleshape2d.rst +++ b/classes/class_capsuleshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CapsuleShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CapsuleShape2D: @@ -13,7 +14,7 @@ CapsuleShape2D Brief Description ----------------- -Capsule 2D shape resource for physics. +Capsule shape for 2D collisions. Member Functions ---------------- @@ -31,13 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`float` **height** -- :ref:`float` **radius** +- :ref:`float` **height** - The capsule's height. +- :ref:`float` **radius** - The capsules's radius. Description ----------- -Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters. +Capsule shape for 2D collisions. Member Function Description --------------------------- diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 21f472c6c..88909f849 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CenterContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CenterContainer: diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 89c41378b..eff86ec1c 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CheckBox.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CheckBox: diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index f031933a8..2213daecf 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CheckButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CheckButton: diff --git a/classes/class_circleshape2d.rst b/classes/class_circleshape2d.rst index f4e142ac0..69870c0c7 100644 --- a/classes/class_circleshape2d.rst +++ b/classes/class_circleshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CircleShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CircleShape2D: @@ -13,7 +14,7 @@ CircleShape2D Brief Description ----------------- -Circular Shape for 2D Physics. +Circular shape for 2D collisions. Member Functions ---------------- @@ -27,12 +28,12 @@ Member Functions Member Variables ---------------- -- :ref:`float` **radius** +- :ref:`float` **radius** - The circle's radius. Description ----------- -Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. +Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. Member Function Description --------------------------- diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index d93bd8676..81052f584 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ClassDB.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ClassDB: @@ -13,7 +14,7 @@ ClassDB Brief Description ----------------- - +Class information repository. Member Functions ---------------- @@ -60,6 +61,11 @@ Member Functions | :ref:`bool` | :ref:`is_parent_class` **(** :ref:`String` class, :ref:`String` inherits **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +Provides access to metadata stored for every available class. + Member Function Description --------------------------- @@ -67,10 +73,14 @@ Member Function Description - :ref:`bool` **can_instance** **(** :ref:`String` class **)** const +Returns true if you can instance objects from the specified 'class', false in other case. + .. _class_ClassDB_class_exists: - :ref:`bool` **class_exists** **(** :ref:`String` class **)** const +Returns whether the specified 'class' is available or not. + .. _class_ClassDB_class_get_category: - :ref:`String` **class_get_category** **(** :ref:`String` class **)** const @@ -79,68 +89,102 @@ Member Function Description - :ref:`int` **class_get_integer_constant** **(** :ref:`String` class, :ref:`String` name **)** const +Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. + .. _class_ClassDB_class_get_integer_constant_list: - :ref:`PoolStringArray` **class_get_integer_constant_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +Returns an array with the names all the integer constants of 'class' or its ancestry. + .. _class_ClassDB_class_get_method_list: - :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + .. _class_ClassDB_class_get_property: - :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const +Returns the value of 'property' of 'class' or its ancestry. + .. _class_ClassDB_class_get_property_list: - :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. + .. _class_ClassDB_class_get_signal: - :ref:`Dictionary` **class_get_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + .. _class_ClassDB_class_get_signal_list: - :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +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 class_get_signal. + .. _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: - :ref:`bool` **class_has_method** **(** :ref:`String` class, :ref:`String` method, :ref:`bool` no_inheritance=false **)** const +Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. + .. _class_ClassDB_class_has_signal: - :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +Return whether 'class' or its ancestry has a signal called 'signal' or not. + .. _class_ClassDB_class_set_property: - :ref:`int` **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const +Sets 'property' value of 'class' to 'value'. + .. _class_ClassDB_get_class_list: - :ref:`PoolStringArray` **get_class_list** **(** **)** const +Returns the names of all the classes available. + .. _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: - :ref:`String` **get_parent_class** **(** :ref:`String` class **)** const +Returns the parent class of 'class'. + .. _class_ClassDB_instance: - :ref:`Variant` **instance** **(** :ref:`String` class **)** const +Creates an instance of 'class'. + .. _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: - :ref:`bool` **is_parent_class** **(** :ref:`String` class, :ref:`String` inherits **)** const +Returns whether 'inherits' is an ancestor of 'class' or not. + diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 03b55a423..b2cc5cca4 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionObject.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionObject: @@ -20,54 +21,54 @@ Brief Description Member Functions ---------------- -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_rid` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_rid` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** const | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | ++------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** - **mouse_entered** **(** **)** - **mouse_exited** **(** **)** @@ -82,7 +83,7 @@ Member Function Description .. _class_CollisionObject__input_event: -- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual +- void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_position, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual .. _class_CollisionObject_create_shape_owner: diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index c587e46e7..11776161c 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionObject2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionObject2D: diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index def937f27..68d4315fa 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionPolygon.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionPolygon: @@ -13,7 +14,7 @@ CollisionPolygon Brief Description ----------------- - +Editor-only class for defining a collision polygon in 3D space. Member Functions ---------------- @@ -35,9 +36,14 @@ Member Functions Member Variables ---------------- -- :ref:`float` **depth** -- :ref:`bool` **disabled** -- :ref:`PoolVector2Array` **polygon** +- :ref:`float` **depth** - Length that the resulting collision extends in either direction perpendicular to its polygon. +- :ref:`bool` **disabled** - If true, no collision will be produced. +- :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. + +Description +----------- + +Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape` for gameplay. Properties modified during gameplay will have no effect. Member Function Description --------------------------- diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 415a5bdf3..f860ef0f3 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionPolygon2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionPolygon2D: @@ -13,7 +14,7 @@ CollisionPolygon2D Brief Description ----------------- -Editor-only class for easy editing of collision polygons. +Editor-only class for defining a collision polygon in 2D space. Member Functions ---------------- @@ -39,15 +40,21 @@ Member Functions Member Variables ---------------- -- :ref:`int` **build_mode** -- :ref:`bool` **disabled** -- :ref:`bool` **one_way_collision** -- :ref:`PoolVector2Array` **polygon** +- :ref:`int` **build_mode** - If BUILD_SOLIDS, the polygon and the area within it will have collision. If BUILD_SEGMENTS, only the edges of the polygon will have collision. +- :ref:`bool` **disabled** - If true, no collision will be produced. +- :ref:`bool` **one_way_collision** - If true, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. +- :ref:`PoolVector2Array` **polygon** - Array of vertices which define the polygon. + +Numeric Constants +----------------- + +- **BUILD_SOLIDS** = **0** +- **BUILD_SEGMENTS** = **1** Description ----------- -Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in :ref:`CollisionObject2D`. This is not accessible from regular code. This class is for editing custom shape polygons. +Allows editing a collision polygon's vertices. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape2D` for gameplay. Properties modified during gameplay will have no effect. Member Function Description --------------------------- diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 377e0eb1a..8dddb5cca 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionShape: @@ -13,7 +14,7 @@ CollisionShape Brief Description ----------------- - +Node that represents collision shape data in 3D space. Member Functions ---------------- @@ -35,8 +36,13 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **disabled** -- :ref:`Shape` **shape** +- :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. +- :ref:`Shape` **shape** - The actual shape owned by this collision shape. + +Description +----------- + +Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area` to give it a detection shape, or add it to a :ref:`PhysicsBody` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. Member Function Description --------------------------- @@ -53,10 +59,14 @@ Member Function Description - 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: - void **resource_changed** **(** :ref:`Resource` resource **)** +If this method exists within a script it will be called whenever the shape resource has been modified. + .. _class_CollisionShape_set_disabled: - void **set_disabled** **(** :ref:`bool` enable **)** diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 088139567..314a81aab 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CollisionShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CollisionShape2D: @@ -13,7 +14,7 @@ CollisionShape2D Brief Description ----------------- -Editor-only class for easy editing of shapes. +Node that represents collision shape data in 2D space. Member Functions ---------------- @@ -35,14 +36,14 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **disabled** -- :ref:`bool` **one_way_collision** -- :ref:`Shape2D` **shape** +- :ref:`bool` **disabled** - A disabled collision shape has no effect in the world. +- :ref:`bool` **one_way_collision** - Sets whether this collision shape should only detect collision on one side (top or bottom). +- :ref:`Shape2D` **shape** - The actual shape owned by this collision shape. Description ----------- -Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in :ref:`CollisionObject2D`. This is not accessible from regular code. +Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D` to give it a detection shape, or add it to a :ref:`PhysicsBody2D` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape` to get the actual shape. Member Function Description --------------------------- @@ -51,8 +52,6 @@ Member Function Description - :ref:`Shape2D` **get_shape** **(** **)** const -Return this shape's :ref:`Shape2D`. - .. _class_CollisionShape2D_is_disabled: - :ref:`bool` **is_disabled** **(** **)** const @@ -73,6 +72,4 @@ Return this shape's :ref:`Shape2D`. - void **set_shape** **(** :ref:`Shape2D` shape **)** -Set this shape's :ref:`Shape2D`. This will not appear as a node, but can be directly edited as a property. - diff --git a/classes/class_color.rst b/classes/class_color.rst index 379dbc533..af4e108cc 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Color.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Color: @@ -11,7 +12,7 @@ Color Brief Description ----------------- -Color in RGBA format. +Color in RGBA format with some support for ARGB format. Member Functions ---------------- @@ -35,12 +36,12 @@ Member Functions +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`linear_interpolate` **(** :ref:`Color` b, :ref:`float` t **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_32` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`to_ARGB32` **(** **)** | +| :ref:`int` | :ref:`to_argb32` **(** **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_html` **(** :ref:`bool` with_alpha=True **)** | +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`to_rgba32` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -60,7 +61,7 @@ Member Variables Description ----------- -A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. +A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate(color)) may accept values > 1. Member Function Description --------------------------- @@ -69,72 +70,153 @@ Member Function Description - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b, :ref:`float` a **)** -Construct the color from an RGBA profile. +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_Color: - :ref:`Color` **Color** **(** :ref:`float` r, :ref:`float` g, :ref:`float` b **)** -Construct the color from an RGBA profile. +Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. + +:: + + var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`int` from **)** -Construct the color from an RGBA profile. +Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). + +:: + + var c = Color(274) # a color of an RGBA(0, 0, 1, 18) .. _class_Color_Color: - :ref:`Color` **Color** **(** :ref:`String` from **)** -Construct the color from an RGBA profile. +Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. + +The following string formats are supported: + +``"#ff00ff00"`` - ARGB format with '#' + +``"ff00ff00"`` - ARGB format + +``"#ff00ff"`` - RGB format with '#' + +``"ff00ff"`` - RGB format + +:: + + # The following code creates the same color of an RGBA(178, 217, 10, 255) + var c1 = Color("#ffb2d90a") # ARGB format with '#' + var c2 = Color("ffb2d90a") # ARGB format + var c3 = Color("#b2d90a") # RGB format with '#' + var c4 = Color("b2d90a") # RGB format .. _class_Color_blend: - :ref:`Color` **blend** **(** :ref:`Color` over **)** -Return a new color blended with anothor one. +Returns a new color resulting from blending this color over another color. If the color is opaque, the result would also be opaque. The other color could then take a range of values with different alpha values. + +:: + + var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50% + 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: - :ref:`Color` **contrasted** **(** **)** -Return the most contrasting color with this one. +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_gray: - :ref:`float` **gray** **(** **)** -Convert the color to gray. +Returns the color's grayscale. + +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: - :ref:`Color` **inverted** **(** **)** -Return the inverted color (1-r, 1-g, 1-b, 1-a). +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_linear_interpolate: - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** -Return the linear interpolation with another color. +Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float). -.. _class_Color_to_32: +:: -- :ref:`int` **to_32** **(** **)** + var c1 = Color(1.0, 0.0, 0.0) + 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) -Convert the color to a 32 its integer (each byte represents a RGBA). +.. _class_Color_to_argb32: -.. _class_Color_to_ARGB32: +- :ref:`int` **to_argb32** **(** **)** -- :ref:`int` **to_ARGB32** **(** **)** +Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX. -Convert color to ARGB32, more compatible with DirectX. +:: + + var c = Color(1, .5, .2) + print(str(c.to_32())) # prints 4294934323 .. _class_Color_to_html: - :ref:`String` **to_html** **(** :ref:`bool` with_alpha=True **)** -Return the HTML hexadecimal color string. +Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``). + +Optionally flag 'false' to not include alpha in hexadecimal string. + +:: + + var c = Color(1, 1, 1, .5) + var s1 = c.to_html() # Results "7fffffff" + var s2 = c.to_html(false) # Results 'ffffff' + +.. _class_Color_to_rgba32: + +- :ref:`int` **to_rgba32** **(** **)** + +Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). + +:: + + var c = Color(1, .5, .2) + print(str(c.to_32())) # prints 4294934323 + + + +*This is same as :ref:`to_ARGB32` but may be changed later to support RGBA format instead*. diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index f2641ba15..db63cafde 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ColorPicker.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ColorPicker: diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index e165e99e9..6cffb36ec 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ColorPickerButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ColorPickerButton: @@ -75,4 +76,13 @@ See :ref:`ColorPicker.set_edit_alpha` - void **set_pick_color** **(** :ref:`Color` color **)** +Set new color to ColorRect. + + + +:: + + var cr = get_node("colorrect_node") + cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red + diff --git a/classes/class_colorrect.rst b/classes/class_colorrect.rst index 13c579b95..eee3c3acc 100644 --- a/classes/class_colorrect.rst +++ b/classes/class_colorrect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ColorRect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ColorRect: @@ -13,7 +14,7 @@ ColorRect Brief Description ----------------- - +Colored rect for canvas. Member Functions ---------------- @@ -29,6 +30,11 @@ Member Variables - :ref:`Color` **color** +Description +----------- + +An object that is represented on the canvas as a rect with color. :ref:`Color` is used to set or get color info for the rect. + Member Function Description --------------------------- @@ -36,8 +42,22 @@ Member Function Description - :ref:`Color` **get_frame_color** **(** **)** const +Return the color in RGBA format. + +:: + + var cr = get_node("colorrect_node") + var c = cr.get_frame_color() # Default color is white + .. _class_ColorRect_set_frame_color: - void **set_frame_color** **(** :ref:`Color` color **)** +Set new color to ColorRect. + +:: + + var cr = get_node("colorrect_node") + cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red + diff --git a/classes/class_concavepolygonshape.rst b/classes/class_concavepolygonshape.rst index 16ce6b30c..094989632 100644 --- a/classes/class_concavepolygonshape.rst +++ b/classes/class_concavepolygonshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConcavePolygonShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConcavePolygonShape: diff --git a/classes/class_concavepolygonshape2d.rst b/classes/class_concavepolygonshape2d.rst index 9874ea98a..f192e95e4 100644 --- a/classes/class_concavepolygonshape2d.rst +++ b/classes/class_concavepolygonshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConcavePolygonShape2D: diff --git a/classes/class_conetwistjoint.rst b/classes/class_conetwistjoint.rst index 3e7dc0231..8bbecbbcf 100644 --- a/classes/class_conetwistjoint.rst +++ b/classes/class_conetwistjoint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConeTwistJoint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConeTwistJoint: diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 77c00a569..78c4984e5 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConfigFile.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConfigFile: diff --git a/classes/class_confirmationdialog.rst b/classes/class_confirmationdialog.rst index 2d61c541c..16e0f2a08 100644 --- a/classes/class_confirmationdialog.rst +++ b/classes/class_confirmationdialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConfirmationDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConfirmationDialog: diff --git a/classes/class_container.rst b/classes/class_container.rst index 0ddd32af4..9e8c0cb36 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Container.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Container: diff --git a/classes/class_control.rst b/classes/class_control.rst index b734e6e6b..0166c0eb3 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Control.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Control: @@ -8,14 +9,14 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Container`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core Brief Description ----------------- -Control is the base node for all the GUI components. +Base node for all User Interface components. Member Functions ---------------- @@ -39,9 +40,9 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_style_override` **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | +| :ref:`bool` | :ref:`can_drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`drop_data` **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual | +| void | :ref:`drop_data` **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_drag` **(** :ref:`Variant` data, :ref:`Control` preview **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,13 +56,13 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_constant` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const | +| :ref:`int` | :ref:`get_cursor_shape` **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_custom_minimum_size` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_default_cursor_shape` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` pos **)** virtual | +| :ref:`Object` | :ref:`get_drag_data` **(** :ref:`Vector2` position **)** virtual | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_end` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -113,7 +114,7 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Theme` | :ref:`get_theme` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const | +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -161,7 +162,7 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_area_as_parent_rect` **(** :ref:`int` margin=0 **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_begin` **(** :ref:`Vector2` position **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clip_contents` **(** :ref:`bool` enable **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,13 +174,13 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drag_preview` **(** :ref:`Control` control **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_end` **(** :ref:`Vector2` position **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_focus_mode` **(** :ref:`int` mode **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -191,7 +192,7 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -213,34 +214,34 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **focus_entered** **(** **)** -Emitted when keyboard focus is gained. +Emitted when the node gains keyboard focus. - **focus_exited** **(** **)** -Emitted when the keyboard focus is lost. +Emitted when the node loses keyboard focus. - **gui_input** **(** :ref:`Object` ev **)** - **minimum_size_changed** **(** **)** -Emitted when the minimum size of the control changed. +Emitted when the node's minimum size changes. - **modal_closed** **(** **)** - **mouse_entered** **(** **)** -Emitted when the mouse enters the control area. +Emitted when the mouse enters the control's area. - **mouse_exited** **(** **)** -Emitted when the mouse left the control area. +Emitted when the mouse leaves the control's area. - **resized** **(** **)** -Emitted when the control changed size. +Emitted when the control changes size. - **size_flags_changed** **(** **)** -Emitted when the size flags changed. +Emitted when the size flags change. Member Variables @@ -336,19 +337,19 @@ Numeric Constants Description ----------- -Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. +The base class Node for all User Interface components. Every UI node inherits from it. Any scene or portion of a scene tree composed of Control nodes is a User Interface. -Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, :ref:`Container` derived nodes can be used. +Controls use anchors and margins to place themselves relative to their parent. They adapt automatically when their parent or the screen size changes. To build flexible UIs, use built-in :ref:`Container` nodes or create your own. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. -Input device events are first sent to the root controls via the :ref:`Node._input`, which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling :ref:`MainLoop._input_event`. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even :ref:`Node._unhandled_input`), the control can accept it by calling :ref:`accept_event`. +Godot sends Input events to the root node first, via :ref:`Node._input`. The method distributes it through the node tree and delivers the input events to the node under the mouse cursor or on focus with the keyboard. To do so, it calls :ref:`MainLoop._input_event`. No need to enable :ref:`Node.set_process_input` on Controls to receive input events. Call :ref:`accept_event` to ensure no other node receives the event, not even :ref:`Node._unhandled_input`. -Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with :ref:`set_focus_mode`. Focus is lost when another control gains it, or the current focus owner is hidden. +Only the one Control node in focus receives keyboard events. To do so, the Control must get the focus mode with :ref:`set_focus_mode`. It loses focus when another Control gets it, or if the current Control in focus is hidden. -It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling :ref:`set_ignore_mouse` enables this function. +You'll sometimes want Controls to ignore mouse or touch events. For example, if you place an icon on top of a button. Call :ref:`set_ignore_mouse` for that. -Finally, controls are skinned according to a :ref:`Theme`. Setting a :ref:`Theme` on a control will propagate all the skinning down the tree. Optionally, skinning can be overridden per each control by calling the add\_\*_override functions, or from the editor. +:ref:`Theme` resources change the Control's appearance. If you change the :ref:`Theme` on a parent Control node, it will propagate to all of its children. You can override parts of the theme on each Control with the add\_\*_override methods, like :ref:`add_font_override`. You can also override the theme from the editor. Member Function Description --------------------------- @@ -357,7 +358,7 @@ Member Function Description - :ref:`Vector2` **_get_minimum_size** **(** **)** virtual -Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. +Returns the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. .. _class_Control__gui_input: @@ -367,7 +368,7 @@ Return the minimum size this Control can shrink to. A control will never be disp - void **accept_event** **(** **)** -Handles the event, no other control will receive it and it will not be sent to nodes waiting on :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. +Marks the input event as handled. No other Control will receive it, and the input event will not propagate. Not even to nodes listening to :ref:`Node._unhandled_input` or :ref:`Node._unhandled_key_input`. .. _class_Control_add_color_override: @@ -403,11 +404,11 @@ Override a single stylebox (Stylebox) in the theme of this Control. If stylebox .. _class_Control_can_drop_data: -- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual +- :ref:`bool` **can_drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual .. _class_Control_drop_data: -- void **drop_data** **(** :ref:`Vector2` pos, :ref:`Variant` data **)** virtual +- void **drop_data** **(** :ref:`Vector2` position, :ref:`Variant` data **)** virtual .. _class_Control_force_drag: @@ -437,7 +438,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg .. _class_Control_get_cursor_shape: -- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` pos=Vector2( 0, 0 ) **)** const +- :ref:`int` **get_cursor_shape** **(** :ref:`Vector2` position=Vector2( 0, 0 ) **)** const Return the cursor shape at a certain position in the control. @@ -453,7 +454,7 @@ Return the default cursor shape for this control. See enum CURSOR\_\* for the li .. _class_Control_get_drag_data: -- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` pos **)** virtual +- :ref:`Object` **get_drag_data** **(** :ref:`Vector2` position **)** virtual .. _class_Control_get_end: @@ -591,7 +592,7 @@ Return a :ref:`Theme` override, if one exists (see :ref:`set_theme< .. _class_Control_get_tooltip: -- :ref:`String` **get_tooltip** **(** :ref:`Vector2` atpos=Vector2( 0, 0 ) **)** const +- :ref:`String` **get_tooltip** **(** :ref:`Vector2` at_position=Vector2( 0, 0 ) **)** const Return the tooltip, which will appear when the cursor is resting over this control. @@ -699,7 +700,7 @@ Change all margins and anchors, so this Control always takes up the same area as .. _class_Control_set_begin: -- void **set_begin** **(** :ref:`Vector2` pos **)** +- void **set_begin** **(** :ref:`Vector2` position **)** Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin`). @@ -727,7 +728,7 @@ Set the default cursor shape for this control. See enum CURSOR\_\* for the list .. _class_Control_set_end: -- void **set_end** **(** :ref:`Vector2` pos **)** +- void **set_end** **(** :ref:`Vector2` position **)** Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin`). @@ -745,7 +746,7 @@ Force a neighbour for moving the input focus to. When pressing TAB or directiona .. _class_Control_set_global_position: -- void **set_global_position** **(** :ref:`Vector2` pos **)** +- void **set_global_position** **(** :ref:`Vector2` position **)** Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). @@ -777,7 +778,7 @@ Set when the control is ignoring mouse events (even touchpad events send mouse e .. _class_Control_set_position: -- void **set_position** **(** :ref:`Vector2` pos **)** +- void **set_position** **(** :ref:`Vector2` position **)** Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin`). @@ -839,6 +840,6 @@ Display a Control as modal. Control must be a subwindow. Modal controls capture .. _class_Control_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_pos **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** diff --git a/classes/class_convexpolygonshape.rst b/classes/class_convexpolygonshape.rst index 532559d2c..fb7cbd2e7 100644 --- a/classes/class_convexpolygonshape.rst +++ b/classes/class_convexpolygonshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConvexPolygonShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConvexPolygonShape: diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index d627ed385..a17eec392 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ConvexPolygonShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ConvexPolygonShape2D: diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index de1dfb955..e5a0d13ac 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CubeMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CubeMap: diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst index e0f3c1a73..dcf450a6f 100644 --- a/classes/class_cubemesh.rst +++ b/classes/class_cubemesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CubeMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CubeMesh: @@ -13,7 +14,7 @@ CubeMesh Brief Description ----------------- - +Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -39,10 +40,15 @@ Member Functions Member Variables ---------------- -- :ref:`Vector3` **size** -- :ref:`int` **subdivide_depth** -- :ref:`int` **subdivide_height** -- :ref:`int` **subdivide_width** +- :ref:`Vector3` **size** - Size of the cuboid mesh. Defaults to (2, 2, 2). +- :ref:`int` **subdivide_depth** - Number of extra edge loops inserted along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_height** - Number of extra edge loops inserted along the y-axis. Defaults to 0. +- :ref:`int` **subdivide_width** - Number of extra edge loops inserted along the x-axis. Defaults to 0. + +Description +----------- + +Generate an axis-aligned cuboid :ref:`PrimitiveMesh`. Member Function Description --------------------------- diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 22211b5fc..77b200fa0 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Curve.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Curve: @@ -18,55 +19,55 @@ Brief Description Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clean_dupes` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max_value` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min_value` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` index **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max_value` **(** :ref:`float` max **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min_value` **(** :ref:`float` min **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_value` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min_value` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` index **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_value` **(** :ref:`float` max **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min_value` **(** :ref:`float` min **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -81,12 +82,19 @@ Member Variables - :ref:`float` **max_value** - :ref:`float` **min_value** +Numeric Constants +----------------- + +- **TANGENT_FREE** = **0** +- **TANGENT_LINEAR** = **1** +- **TANGENT_MODE_COUNT** = **2** + Member Function Description --------------------------- .. _class_Curve_add_point: -- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** +- :ref:`int` **add_point** **(** :ref:`Vector2` position, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** .. _class_Curve_bake: @@ -120,9 +128,9 @@ Member Function Description - :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const -.. _class_Curve_get_point_pos: +.. _class_Curve_get_point_position: -- :ref:`Vector2` **get_point_pos** **(** :ref:`int` index **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` index **)** const .. _class_Curve_get_point_right_mode: diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index a5facbdfb..d9bed5b06 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Curve2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Curve2D: @@ -18,43 +19,43 @@ Describes a Bezier curve in 2D space. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=-1 **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector2` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector2` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -74,11 +75,11 @@ Member Function Description .. _class_Curve2D_add_point: -- void **add_point** **(** :ref:`Vector2` pos, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector2` position, :ref:`Vector2` in=Vector2( 0, 0 ), :ref:`Vector2` out=Vector2( 0, 0 ), :ref:`int` at_position=-1 **)** -Adds a point to a curve, at position "pos", with control points "in" and "out". +Adds a point to a curve, at "position", with control points "in" and "out". -If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. +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: @@ -120,9 +121,9 @@ Returns the position of the control point leading to the vertex "idx". If the in 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_pos: +.. _class_Curve2D_get_point_position: -- :ref:`Vector2` **get_point_pos** **(** :ref:`int` idx **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). @@ -164,19 +165,19 @@ Sets the distance in pixels between two adjacent cached points. Changing it forc .. _class_Curve2D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` pos **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector2` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve2D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector2` pos **)** +- 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_pos: +.. _class_Curve2D_set_point_position: -- void **set_point_pos** **(** :ref:`int` idx, :ref:`Vector2` pos **)** +- 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. diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 8d69abd68..3be8d672e 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Curve3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Curve3D: @@ -18,49 +19,49 @@ Describes a Bezier curve in 3D space. Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=-1 **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_points` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_baked_length` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` idx **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` idx, :ref:`Vector3` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bake_interval` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_baked_length` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_baked_points` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_baked_tilts` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_in` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_out` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_position` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_tilt` **(** :ref:`int` idx **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate` **(** :ref:`int` idx, :ref:`float` t **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolate_baked` **(** :ref:`float` offset, :ref:`bool` cubic=false **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`interpolatef` **(** :ref:`float` fofs **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_interval` **(** :ref:`float` distance **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_in` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_out` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` idx, :ref:`Vector3` position **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_tilt` **(** :ref:`int` idx, :ref:`float` tilt **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`tessellate` **(** :ref:`int` max_stages=5, :ref:`float` tolerance_degrees=4 **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -80,11 +81,11 @@ Member Function Description .. _class_Curve3D_add_point: -- void **add_point** **(** :ref:`Vector3` pos, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` atpos=-1 **)** +- void **add_point** **(** :ref:`Vector3` position, :ref:`Vector3` in=Vector3( 0, 0, 0 ), :ref:`Vector3` out=Vector3( 0, 0, 0 ), :ref:`int` at_position=-1 **)** -Adds a point to a curve, at position "pos", with control points "in" and "out". +Adds a point to a curve, at "position", with control points "in" and "out". -If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count`), the point will be appended at the end of the point list. +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: @@ -132,9 +133,9 @@ Returns the position of the control point leading to the vertex "idx". If the in 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_pos: +.. _class_Curve3D_get_point_position: -- :ref:`Vector3` **get_point_pos** **(** :ref:`int` idx **)** const +- :ref:`Vector3` **get_point_position** **(** :ref:`int` idx **)** const Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). @@ -182,19 +183,19 @@ Sets the distance in 3D units between two adjacent cached points. Changing it fo .. _class_Curve3D_set_point_in: -- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` pos **)** +- void **set_point_in** **(** :ref:`int` idx, :ref:`Vector3` position **)** Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. .. _class_Curve3D_set_point_out: -- void **set_point_out** **(** :ref:`int` idx, :ref:`Vector3` pos **)** +- 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_pos: +.. _class_Curve3D_set_point_position: -- void **set_point_pos** **(** :ref:`int` idx, :ref:`Vector3` pos **)** +- 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. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 07ad7f7c4..7fd1faaf1 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CurveTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CurveTexture: diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst index 68edcb3e0..a37362cf0 100644 --- a/classes/class_cylindermesh.rst +++ b/classes/class_cylindermesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the CylinderMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_CylinderMesh: @@ -13,7 +14,7 @@ CylinderMesh Brief Description ----------------- - +Class representing a cylindrical :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -43,11 +44,16 @@ Member Functions Member Variables ---------------- -- :ref:`float` **bottom_radius** -- :ref:`float` **height** -- :ref:`int` **radial_segments** -- :ref:`int` **rings** -- :ref:`float` **top_radius** +- :ref:`float` **bottom_radius** - Bottom radius of the cylinder. Defaults to 1.0. +- :ref:`float` **height** - Full height of the cylinder. Defaults to 2.0. +- :ref:`int` **radial_segments** - Number of radial segments on the cylinder. Defaults to 64. +- :ref:`int` **rings** - Number of edge rings along the height of the cylinder. Defaults to 4. +- :ref:`float` **top_radius** - Top radius of the cylinder. Defaults to 1.0. + +Description +----------- + +Class representing a cylindrical :ref:`PrimitiveMesh`. Member Function Description --------------------------- diff --git a/classes/class_dampedspringjoint2d.rst b/classes/class_dampedspringjoint2d.rst index a9db9aa21..7548d4a84 100644 --- a/classes/class_dampedspringjoint2d.rst +++ b/classes/class_dampedspringjoint2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the DampedSpringJoint2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_DampedSpringJoint2D: diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index bde14d739..d983019ce 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Dictionary.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Dictionary: diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 91b585790..1a34f1bdc 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the DirectionalLight.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_DirectionalLight: @@ -18,21 +19,27 @@ Directional Light, such as the Sun or the Moon. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------+ ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_depth_range` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_shadow_mode` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blend_splits_enabled` **(** **)** const | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_splits` **(** :ref:`bool` enabled **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_depth_range` **(** :ref:`int` mode **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_mode` **(** :ref:`int` mode **)** | ++--------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`float` **directional_shadow_bias_split_scale** - :ref:`bool` **directional_shadow_blend_splits** +- :ref:`int` **directional_shadow_depth_range** +- :ref:`float` **directional_shadow_max_distance** - :ref:`int` **directional_shadow_mode** - :ref:`float` **directional_shadow_normal_bias** - :ref:`float` **directional_shadow_split_1** @@ -45,6 +52,8 @@ Numeric Constants - **SHADOW_ORTHOGONAL** = **0** - **SHADOW_PARALLEL_2_SPLITS** = **1** - **SHADOW_PARALLEL_4_SPLITS** = **2** +- **SHADOW_DEPTH_RANGE_STABLE** = **0** +- **SHADOW_DEPTH_RANGE_OPTIMIZED** = **1** Description ----------- @@ -54,6 +63,10 @@ A DirectionalLight is a type of :ref:`Light` node that emits light Member Function Description --------------------------- +.. _class_DirectionalLight_get_shadow_depth_range: + +- :ref:`int` **get_shadow_depth_range** **(** **)** const + .. _class_DirectionalLight_get_shadow_mode: - :ref:`int` **get_shadow_mode** **(** **)** const @@ -66,6 +79,10 @@ Member Function Description - void **set_blend_splits** **(** :ref:`bool` enabled **)** +.. _class_DirectionalLight_set_shadow_depth_range: + +- void **set_shadow_depth_range** **(** :ref:`int` mode **)** + .. _class_DirectionalLight_set_shadow_mode: - void **set_shadow_mode** **(** :ref:`int` mode **)** diff --git a/classes/class_directory.rst b/classes/class_directory.rst index 28d6835a5..28c4f83d3 100644 --- a/classes/class_directory.rst +++ b/classes/class_directory.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Directory.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Directory: diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index 3bd9f007c..b3dc75380 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the DynamicFont.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_DynamicFont: diff --git a/classes/class_dynamicfontdata.rst b/classes/class_dynamicfontdata.rst index 0cc38f3b1..fda3e0738 100644 --- a/classes/class_dynamicfontdata.rst +++ b/classes/class_dynamicfontdata.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the DynamicFontData.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_DynamicFontData: diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst new file mode 100644 index 000000000..bb930910f --- /dev/null +++ b/classes/class_editorexportplugin.rst @@ -0,0 +1,57 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorExportPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorExportPlugin: + +EditorExportPlugin +================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PoolStringArray` features **)** virtual | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorExportPlugin__export_begin: + +- void **_export_begin** **(** :ref:`PoolStringArray` features **)** virtual + +.. _class_EditorExportPlugin__export_file: + +- void **_export_file** **(** :ref:`String` path, :ref:`String` type, :ref:`PoolStringArray` features **)** virtual + +.. _class_EditorExportPlugin_add_file: + +- void **add_file** **(** :ref:`String` path, :ref:`PoolByteArray` file, :ref:`bool` remap **)** + +.. _class_EditorExportPlugin_add_shared_object: + +- void **add_shared_object** **(** :ref:`String` path **)** + +.. _class_EditorExportPlugin_skip: + +- void **skip** **(** **)** + + diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index c7f297298..0cac4dd02 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorFileDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorFileDialog: @@ -78,6 +79,8 @@ Numeric Constants - **ACCESS_RESOURCES** = **0** - **ACCESS_USERDATA** = **1** - **ACCESS_FILESYSTEM** = **2** +- **DISPLAY_THUMBNAILS** = **0** +- **DISPLAY_LIST** = **1** Member Function Description --------------------------- diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 595ac0590..29172f551 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorFileSystem.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorFileSystem: diff --git a/classes/class_editorfilesystemdirectory.rst b/classes/class_editorfilesystemdirectory.rst index 1b6410783..68d191144 100644 --- a/classes/class_editorfilesystemdirectory.rst +++ b/classes/class_editorfilesystemdirectory.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorFileSystemDirectory.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorFileSystemDirectory: diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index d8be7fd92..8ae9656e0 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorImportPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorImportPlugin: @@ -13,7 +14,7 @@ EditorImportPlugin Brief Description ----------------- - +Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. Member Functions ---------------- @@ -40,6 +41,61 @@ Member Functions | :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your :ref:`EditorPlugin` with :ref:`EditorPlugin.add_import_plugin`. + + + +EditorImportPlugins work by associating with specific file extensions and a resource type. See :ref:`get_recognized_extension` and :ref:`get_resource_type`). They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the ``.import`` directory. + + + + + +Below is an example EditorImportPlugin that imports a :ref:`Mesh` from a file with the extension ".special" or ".spec": + +:: + + tool + extends EditorImportPlugin + + func get_importer_name(): + return "my.special.plugin" + + func get_visible_name(): + return "Special Mesh Importer" + + func get_recognized_extensions(): + return ["special", "spec"] + + func get_save_extension(): + return "mesh" + + func get_resource_type(): + return "Mesh" + + func get_preset_count(): + return 1 + + func get_preset_name(i): + return "Default" + + func get_import_optons(i): + return [{"name": "my_option", "default_value": false}] + + func load(src, dst, opts, r_platform_variants, r_gen_files): + var f = File.new() + if f.open(src, File.READ) != OK: + return FAILED + + var mesh = Mesh.new() + + var save = dst + "." + get_save_extension() + ResourceSaver.save(file, mesh) + return OK + Member Function Description --------------------------- @@ -47,10 +103,14 @@ Member Function Description - :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_importer_name: - :ref:`String` **get_importer_name** **(** **)** virtual +Get the unique name of the importer. + .. _class_EditorImportPlugin_get_option_visibility: - :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual @@ -59,26 +119,38 @@ Member Function Description - :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: - :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual +Get the name of the options preset at this index. + .. _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: - :ref:`String` **get_resource_type** **(** **)** virtual +Get the godot resource type associated with this loader. e.g. "Mesh" or "Animation". + .. _class_EditorImportPlugin_get_save_extension: - :ref:`String` **get_save_extension** **(** **)** virtual +Get the extension used to save this resource in the ``.import`` directory. + .. _class_EditorImportPlugin_get_visible_name: - :ref:`String` **get_visible_name** **(** **)** virtual +Get the name to display in the import window. + .. _class_EditorImportPlugin_import: - :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index b3e6fd5e6..ce6537ea9 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorInterface.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorInterface: diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 5d477d0d3..61e0aaa61 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorPlugin: @@ -27,6 +28,8 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`Object` submenu **)** | @@ -75,6 +78,8 @@ Member Functions +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_export_plugin` **(** :ref:`EditorExportPlugin` exporter **)** | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_import_plugin` **(** :ref:`EditorImportPlugin` importer **)** | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | @@ -167,6 +172,10 @@ 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: + +- void **add_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** + .. _class_EditorPlugin_add_import_plugin: - void **add_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** @@ -303,6 +312,10 @@ Remove the control from the dock. Don't forget to call this if you added one, so Remove a custom type added by :ref:`EditorPlugin.add_custom_type` +.. _class_EditorPlugin_remove_export_plugin: + +- void **remove_export_plugin** **(** :ref:`EditorExportPlugin` exporter **)** + .. _class_EditorPlugin_remove_import_plugin: - void **remove_import_plugin** **(** :ref:`EditorImportPlugin` importer **)** diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst new file mode 100644 index 000000000..9414a6661 --- /dev/null +++ b/classes/class_editorresourceconversionplugin.rst @@ -0,0 +1,39 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorResourceConversionPlugin.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorResourceConversionPlugin: + +EditorResourceConversionPlugin +============================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`_convert` **(** :ref:`Resource` resource **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_converts_to` **(** **)** virtual | ++----------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorResourceConversionPlugin__convert: + +- :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** virtual + +.. _class_EditorResourceConversionPlugin__converts_to: + +- :ref:`bool` **_converts_to** **(** **)** virtual + + diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 24cf88f1c..2a3379118 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorResourcePreview.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorResourcePreview: diff --git a/classes/class_editorresourcepreviewgenerator.rst b/classes/class_editorresourcepreviewgenerator.rst index 93449c7cd..2fa774a5a 100644 --- a/classes/class_editorresourcepreviewgenerator.rst +++ b/classes/class_editorresourcepreviewgenerator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorResourcePreviewGenerator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorResourcePreviewGenerator: diff --git a/classes/class_editorscript.rst b/classes/class_editorscript.rst index c006e3545..bef69da94 100644 --- a/classes/class_editorscript.rst +++ b/classes/class_editorscript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorScript: diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 461211a0c..db337bff4 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorSelection.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorSelection: diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 26714576c..d10f81194 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorSettings.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorSettings: diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 0d455cddb..e5001e5a8 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EditorSpatialGizmo.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EditorSpatialGizmo: @@ -21,7 +22,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_segments` **(** :ref:`PoolVector3Array` segments **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles **)** | +| void | :ref:`add_collision_triangles` **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_handles` **(** :ref:`PoolVector3Array` handles, :ref:`bool` billboard=false, :ref:`bool` secondary=false **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -60,7 +61,7 @@ Member Function Description .. _class_EditorSpatialGizmo_add_collision_triangles: -- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles **)** +- void **add_collision_triangles** **(** :ref:`TriangleMesh` triangles, :ref:`Rect3` bounds **)** 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`. diff --git a/classes/class_encodedobjectasid.rst b/classes/class_encodedobjectasid.rst index b042d0829..af61162bd 100644 --- a/classes/class_encodedobjectasid.rst +++ b/classes/class_encodedobjectasid.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the EncodedObjectAsID.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_EncodedObjectAsID: diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 4343550fb..6797a8a5f 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Engine.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Engine: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 136b5d0aa..6136d2712 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Environment.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Environment: @@ -378,12 +379,13 @@ Member Variables Numeric Constants ----------------- -- **BG_KEEP** = **4** +- **BG_KEEP** = **5** - **BG_CLEAR_COLOR** = **0** - **BG_COLOR** = **1** - **BG_SKY** = **2** -- **BG_CANVAS** = **3** -- **BG_MAX** = **5** +- **BG_COLOR_SKY** = **3** +- **BG_CANVAS** = **4** +- **BG_MAX** = **6** - **GLOW_BLEND_MODE_ADDITIVE** = **0** - **GLOW_BLEND_MODE_SCREEN** = **1** - **GLOW_BLEND_MODE_SOFTLIGHT** = **2** diff --git a/classes/class_file.rst b/classes/class_file.rst index 35b2df13f..a297e1a5a 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the File.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_File: @@ -57,7 +58,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_pascal_string` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pos` **(** **)** const | +| :ref:`int` | :ref:`get_position` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_real` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -75,9 +76,9 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` pos **)** | +| void | :ref:`seek` **(** :ref:`int` position **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` pos=0 **)** | +| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_endian_swap` **(** :ref:`bool` enable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -255,9 +256,9 @@ Return a md5 String representing the file at the given path or an empty :ref:`St Get a :ref:`String` saved in Pascal format from the file. -.. _class_File_get_pos: +.. _class_File_get_position: -- :ref:`int` **get_pos** **(** **)** const +- :ref:`int` **get_position** **(** **)** const Return the file cursor position. @@ -311,13 +312,13 @@ Open an encrypted file in write or read mode. You need to pass a password to enc .. _class_File_seek: -- void **seek** **(** :ref:`int` pos **)** +- 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: -- void **seek_end** **(** :ref:`int` pos=0 **)** +- void **seek_end** **(** :ref:`int` position=0 **)** Change 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. diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 2f469d85b..5efc0ef4c 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the FileDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_FileDialog: diff --git a/classes/class_float.rst b/classes/class_float.rst index ad3834a79..a403d9be0 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the float.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_float: diff --git a/classes/class_font.rst b/classes/class_font.rst index 7724c35bb..0d1e8571f 100644 --- a/classes/class_font.rst +++ b/classes/class_font.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Font.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Font: @@ -20,23 +21,23 @@ Internationalized font and text drawing support. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ascent` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_descent` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_changes` **(** **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ascent` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_descent` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_string_size` **(** :ref:`String` string **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_field_hint` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_changes` **(** **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -48,15 +49,15 @@ Member Function Description .. _class_Font_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`String` string, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`int` clip_w=-1 **)** const -Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. +Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. .. _class_Font_draw_char: -- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const +- :ref:`float` **draw_char** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`int` char, :ref:`int` next=-1, :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** const -Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" 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. +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: diff --git a/classes/class_funcref.rst b/classes/class_funcref.rst index 08a6d4534..6b923330a 100644 --- a/classes/class_funcref.rst +++ b/classes/class_funcref.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the FuncRef.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_FuncRef: diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 09ca36149..e8f1e5061 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDFunctionState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GDFunctionState: diff --git a/classes/class_gdnative.rst b/classes/class_gdnative.rst index 598b4a7a7..8bcb7d055 100644 --- a/classes/class_gdnative.rst +++ b/classes/class_gdnative.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GDNative: diff --git a/classes/class_gdnativeclass.rst b/classes/class_gdnativeclass.rst index 40582be35..f63de4071 100644 --- a/classes/class_gdnativeclass.rst +++ b/classes/class_gdnativeclass.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDNativeClass.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GDNativeClass: diff --git a/classes/class_gdnativelibrary.rst b/classes/class_gdnativelibrary.rst index 264ad8f15..924251253 100644 --- a/classes/class_gdnativelibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDNativeLibrary.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GDNativeLibrary: diff --git a/classes/class_gdscript.rst b/classes/class_gdscript.rst index 403f20592..1e716a894 100644 --- a/classes/class_gdscript.rst +++ b/classes/class_gdscript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GDScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GDScript: @@ -13,7 +14,7 @@ GDScript Brief Description ----------------- - +A script implemented in the GDScript programming language. Member Functions ---------------- @@ -24,6 +25,13 @@ Member Functions | :ref:`Object` | :ref:`new` **(** **)** vararg | +--------------------------------------------+-----------------------------------------------------------------------------+ +Description +----------- + +A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. + +:ref:`new` creates a new instance of the script. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. + Member Function Description --------------------------- @@ -31,8 +39,20 @@ Member Function Description - :ref:`PoolByteArray` **get_as_byte_code** **(** **)** const +Returns byte code for the script source code. + .. _class_GDScript_new: - :ref:`Object` **new** **(** **)** vararg +Returns a new instance of the script. + +For example: + +:: + + var MyClass = load("myclass.gd") + var instance = MyClass.new() + assert(instance.get_script() == MyClass) + diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 7861adbb5..6766b3557 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Generic6DOFJoint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Generic6DOFJoint: diff --git a/classes/class_geometry.rst b/classes/class_geometry.rst index 4f5382cc6..1bd138e22 100644 --- a/classes/class_geometry.rst +++ b/classes/class_geometry.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Geometry.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Geometry: @@ -18,47 +19,47 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_pos, :ref:`float` circle_radius **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_box_planes` **(** :ref:`Vector3` extents **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_capsule_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` lats, :ref:`int` axis=2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`build_cylinder_planes` **(** :ref:`float` radius, :ref:`float` height, :ref:`int` sides, :ref:`int` axis=2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_closest_point_to_segment_uncapped_2d` **(** :ref:`Vector2` point, :ref:`Vector2` s1, :ref:`Vector2` s2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_closest_points_between_segments` **(** :ref:`Vector3` p1, :ref:`Vector3` p2, :ref:`Vector3` q1, :ref:`Vector3` q2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_closest_points_between_segments_2d` **(** :ref:`Vector2` p1, :ref:`Vector2` q1, :ref:`Vector2` p2, :ref:`Vector2` q2 **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_uv84_normal_bit` **(** :ref:`Vector3` normal **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`make_atlas` **(** :ref:`PoolVector2Array` sizes **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`point_is_inside_triangle` **(** :ref:`Vector2` point, :ref:`Vector2` a, :ref:`Vector2` b, :ref:`Vector2` c **)** const | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`ray_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` dir, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`segment_intersects_circle` **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_convex` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` planes **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_cylinder` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`float` height, :ref:`float` radius **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_segment_2d` **(** :ref:`Vector2` from_a, :ref:`Vector2` to_a, :ref:`Vector2` from_b, :ref:`Vector2` to_b **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`segment_intersects_sphere` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`segment_intersects_triangle` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` a, :ref:`Vector3` b, :ref:`Vector3` c **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`triangulate_polygon` **(** :ref:`PoolVector2Array` polygon **)** | ++--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -117,7 +118,7 @@ Member Function Description .. _class_Geometry_segment_intersects_circle: -- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_pos, :ref:`float` circle_radius **)** +- :ref:`float` **segment_intersects_circle** **(** :ref:`Vector2` segment_from, :ref:`Vector2` segment_to, :ref:`Vector2` circle_position, :ref:`float` circle_radius **)** .. _class_Geometry_segment_intersects_convex: @@ -133,7 +134,7 @@ Member Function Description .. _class_Geometry_segment_intersects_sphere: -- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` spos, :ref:`float` sradius **)** +- :ref:`PoolVector3Array` **segment_intersects_sphere** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Vector3` sphere_position, :ref:`float` sphere_radius **)** .. _class_Geometry_segment_intersects_triangle: diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index dc381384d..c8e104577 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GeometryInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GeometryInstance: @@ -69,11 +70,12 @@ Member Variables Numeric Constants ----------------- -- **FLAG_MAX** = **1** - **SHADOW_CASTING_SETTING_OFF** = **0** - **SHADOW_CASTING_SETTING_ON** = **1** - **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** - **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** +- **FLAG_USE_BAKED_LIGHT** = **0** +- **FLAG_MAX** = **1** Description ----------- diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index 5f10ab6fc..3f48a9d69 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GIProbe.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GIProbe: diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index e7087094b..f5bf1191e 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GIProbeData.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GIProbeData: diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index f611cb127..76f53d2f8 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Gradient.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Gradient: diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 10a232efc..bec9e4d08 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GradientTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GradientTexture: @@ -13,7 +14,7 @@ GradientTexture Brief Description ----------------- - +Gradient filled texture. Member Functions ---------------- @@ -29,8 +30,13 @@ Member Functions Member Variables ---------------- -- :ref:`Gradient` **gradient** -- :ref:`int` **width** +- :ref:`Gradient` **gradient** - The [Gradient] that will be used to fill the texture. +- :ref:`int` **width** - The number of color samples that will be obtained from the [Gradient]. + +Description +----------- + +Uses a :ref:`Gradient` to fill the texture data, the gradient will be filled from left to right using colors obtained from the gradient, this means that the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`set_width`). Member Function Description --------------------------- diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index df286cb93..cc9217ac1 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GraphEdit.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GraphEdit: @@ -62,7 +63,7 @@ Signal sent at the end of a GraphNode movement. - **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. -- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_pos **)** +- **connection_to_empty** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`Vector2` release_position **)** - **delete_nodes_request** **(** **)** Signal sent when a GraphNode is attempted to be removed from the GraphEdit. diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 7b920fb46..3b35b5d36 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GraphNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GraphNode: @@ -27,7 +28,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_count` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_input_pos` **(** :ref:`int` idx **)** | +| :ref:`Vector2` | :ref:`get_connection_input_position` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_input_type` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -35,7 +36,7 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_count` **(** **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_connection_output_pos` **(** :ref:`int` idx **)** | +| :ref:`Vector2` | :ref:`get_connection_output_position` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connection_output_type` **(** :ref:`int` idx **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -145,9 +146,9 @@ Return the color of the input connection 'idx'. Return the number of enabled input slots (connections) to the GraphNode. -.. _class_GraphNode_get_connection_input_pos: +.. _class_GraphNode_get_connection_input_position: -- :ref:`Vector2` **get_connection_input_pos** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_input_position** **(** :ref:`int` idx **)** Return the position of the input connection 'idx'. @@ -169,9 +170,9 @@ Return the color of the output connection 'idx'. Return the number of enabled output slots (connections) of the GraphNode. -.. _class_GraphNode_get_connection_output_pos: +.. _class_GraphNode_get_connection_output_position: -- :ref:`Vector2` **get_connection_output_pos** **(** :ref:`int` idx **)** +- :ref:`Vector2` **get_connection_output_position** **(** :ref:`int` idx **)** Return the position of the output connection 'idx'. diff --git a/classes/class_gridcontainer.rst b/classes/class_gridcontainer.rst index 019acdd7b..71ed44348 100644 --- a/classes/class_gridcontainer.rst +++ b/classes/class_gridcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GridContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GridContainer: diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index f4300b26a..92dc34fa4 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GridMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GridMap: diff --git a/classes/class_groovejoint2d.rst b/classes/class_groovejoint2d.rst index 043ef8b89..10b312352 100644 --- a/classes/class_groovejoint2d.rst +++ b/classes/class_groovejoint2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the GrooveJoint2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_GrooveJoint2D: diff --git a/classes/class_hboxcontainer.rst b/classes/class_hboxcontainer.rst index 95fec1c9c..947582931 100644 --- a/classes/class_hboxcontainer.rst +++ b/classes/class_hboxcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HBoxContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HBoxContainer: diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 7ca29f478..145d1c883 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HingeJoint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HingeJoint: diff --git a/classes/class_hscrollbar.rst b/classes/class_hscrollbar.rst index f9897ddc7..a0626ed02 100644 --- a/classes/class_hscrollbar.rst +++ b/classes/class_hscrollbar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HScrollBar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HScrollBar: diff --git a/classes/class_hseparator.rst b/classes/class_hseparator.rst index 70a60461e..0d93c5d1d 100644 --- a/classes/class_hseparator.rst +++ b/classes/class_hseparator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HSeparator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HSeparator: diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index a4d815d51..e0b5e68f5 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HSlider.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HSlider: diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index 75e748c16..1d67b556f 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HSplitContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HSplitContainer: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 0b8603f14..ddbc93dca 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HTTPClient.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HTTPClient: diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index df4423edd..1e1808f72 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the HTTPRequest.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_HTTPRequest: diff --git a/classes/class_image.rst b/classes/class_image.rst index 78a25e8cd..5726da67f 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Image.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Image: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index fcb8230e4..6462eee86 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ImageTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ImageTexture: diff --git a/classes/class_immediategeometry.rst b/classes/class_immediategeometry.rst index a2be7ce2e..a6199933c 100644 --- a/classes/class_immediategeometry.rst +++ b/classes/class_immediategeometry.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ImmediateGeometry.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ImmediateGeometry: @@ -21,7 +22,7 @@ Member Functions +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_sphere` **(** :ref:`int` lats, :ref:`int` lons, :ref:`float` radius, :ref:`bool` add_uv=true **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` pos **)** | +| void | :ref:`add_vertex` **(** :ref:`Vector3` position **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`begin` **(** :ref:`int` primitive, :ref:`Texture` texture=null **)** | +-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,7 +52,7 @@ Simple helper to draw a uvsphere, with given latitudes, longitude and radius. .. _class_ImmediateGeometry_add_vertex: -- void **add_vertex** **(** :ref:`Vector3` pos **)** +- void **add_vertex** **(** :ref:`Vector3` position **)** Add a vertex with the currently set color/uv/etc. diff --git a/classes/class_input.rst b/classes/class_input.rst index d14a2ecc0..5b69daddd 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Input.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Input: @@ -87,7 +88,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_pos` **(** :ref:`Vector2` to **)** | +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -295,9 +296,9 @@ Note that not every hardware is compatible with long effect durations, it is rec Stops the vibration of the joypad. -.. _class_Input_warp_mouse_pos: +.. _class_Input_warp_mouse_position: -- void **warp_mouse_pos** **(** :ref:`Vector2` to **)** +- void **warp_mouse_position** **(** :ref:`Vector2` to **)** Sets the mouse position to the specified vector. diff --git a/classes/class_inputdefault.rst b/classes/class_inputdefault.rst index 187290af9..d8ac18fe0 100644 --- a/classes/class_inputdefault.rst +++ b/classes/class_inputdefault.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputDefault.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputDefault: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index fed85fc8f..698019f68 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEvent.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEvent: @@ -15,7 +16,7 @@ InputEvent Brief Description ----------------- - +Generic input event Member Functions ---------------- @@ -62,35 +63,43 @@ Member Function Description - :ref:`bool` **action_match** **(** :ref:`InputEvent` event **)** const +Returns true if this input event matches the event passed. + .. _class_InputEvent_as_text: - :ref:`String` **as_text** **(** **)** const +Returns a :ref:`String` representation of the event. + .. _class_InputEvent_get_device: - :ref:`int` **get_device** **(** **)** const +Returns the id of the device that generated the event. + .. _class_InputEvent_get_id: - :ref:`int` **get_id** **(** **)** const +Returns the id of the event. + .. _class_InputEvent_is_action: - :ref:`bool` **is_action** **(** :ref:`String` action **)** const -Return if this input event matches a pre-defined action, no matter the type. +Returns true if this input event matches a pre-defined action, no matter the type. .. _class_InputEvent_is_action_pressed: - :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** const -Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. +Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. .. _class_InputEvent_is_action_released: - :ref:`bool` **is_action_released** **(** :ref:`String` action **)** const -Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. +Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. .. _class_InputEvent_is_action_type: @@ -100,13 +109,13 @@ Return whether the given action is released (i.e. not pressed). Not relevant for - :ref:`bool` **is_echo** **(** **)** const -Return if this input event is an echo event (only for events of type KEY, it will return false for other types). +Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). .. _class_InputEvent_is_pressed: - :ref:`bool` **is_pressed** **(** **)** const -Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. +Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. .. _class_InputEvent_set_device: diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 505868fd9..4fbec9bdb 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventAction.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventAction: diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 587014e10..c8ad1f4ca 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventJoypadButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventJoypadButton: diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index 93740ea62..4377354ac 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventJoypadMotion.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventJoypadMotion: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 243dfa4a8..436f136ea 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventKey.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventKey: diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index 43f27ef03..0192acb3a 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventMouse.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventMouse: diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 1f09e28b2..8c3d582c2 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventMouseButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventMouseButton: diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 87ceaca64..bd399bd82 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventMouseMotion.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventMouseMotion: diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 2b1f42ed8..5f6e7b35e 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventScreenDrag.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventScreenDrag: diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index c86f5850f..596c639f0 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventScreenTouch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventScreenTouch: @@ -18,17 +19,17 @@ Input event type for screen touch events. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_position` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_index` **(** :ref:`int` index **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`int` index **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -54,7 +55,7 @@ Member Function Description .. _class_InputEventScreenTouch_set_position: -- void **set_position** **(** :ref:`Vector2` pos **)** +- void **set_position** **(** :ref:`Vector2` position **)** .. _class_InputEventScreenTouch_set_pressed: diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index f1e008539..100ed7446 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputEventWithModifiers.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputEventWithModifiers: diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index c166518a3..342731656 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InputMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InputMap: diff --git a/classes/class_instanceplaceholder.rst b/classes/class_instanceplaceholder.rst index 753759d52..d36f9c570 100644 --- a/classes/class_instanceplaceholder.rst +++ b/classes/class_instanceplaceholder.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InstancePlaceholder.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InstancePlaceholder: diff --git a/classes/class_int.rst b/classes/class_int.rst index 6fea70f36..0d6b9607f 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the int.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_int: diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index bf6d4cb8d..1ab0ed070 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the InterpolatedCamera.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_InterpolatedCamera: diff --git a/classes/class_ip.rst b/classes/class_ip.rst index b172e5edd..2ce8669ea 100644 --- a/classes/class_ip.rst +++ b/classes/class_ip.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the IP.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_IP: @@ -53,7 +54,7 @@ Numeric Constants Description ----------- -IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see :ref:`StreamPeerTCP` and :ref:`TCP_Server`). IP provides hostname resolution support, both blocking and threaded. +IP contains support functions for the IPv4 protocol. TCP/IP support is in different classes (see :ref:`StreamPeerTCP` and :ref:`TCP_Server`). IP provides hostname resolution support, both blocking and threaded. Member Function Description --------------------------- @@ -62,38 +63,42 @@ Member Function Description - 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: - void **erase_resolve_item** **(** :ref:`int` id **)** -Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen. +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: - :ref:`Array` **get_local_addresses** **(** **)** const +Returns all of the user's current IPv4 and IPv6 addresses as an array. + .. _class_IP_get_resolve_item_address: - :ref:`String` **get_resolve_item_address** **(** :ref:`int` id **)** const -Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see :ref:`get_resolve_item_status`). +Returns a queued hostname's IP address, given its queue "id". Returns an empty string on error or if resolution hasn't happened yet (see :ref:`get_resolve_item_status`). .. _class_IP_get_resolve_item_status: - :ref:`int` **get_resolve_item_status** **(** :ref:`int` id **)** const -Return the status of hostname queued for resolving, given its queue ID. Returned status can be any of the RESOLVER_STATUS\_\* enumeration. +Returns a queued hostname's status as a RESOLVER_STATUS\_\* constant, given its queue "id". .. _class_IP_resolve_hostname: - :ref:`String` **resolve_hostname** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** -Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". +Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the TYPE\_\* constant given as "ip_type". .. _class_IP_resolve_hostname_queue_item: - :ref:`int` **resolve_hostname_queue_item** **(** :ref:`String` host, :ref:`int` ip_type=3 **)** -Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. +Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the TYPE\_\* constant given as "ip_type". Returns the queue ID if successful, or RESOLVER_INVALID_ID on error. diff --git a/classes/class_ip_unix.rst b/classes/class_ip_unix.rst index 13f930df6..f1aa455f7 100644 --- a/classes/class_ip_unix.rst +++ b/classes/class_ip_unix.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the IP_Unix.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_IP_Unix: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 18fcd5b61..12963eca2 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ItemList.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ItemList: @@ -37,7 +38,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_icon_scale` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const | +| :ref:`int` | :ref:`get_item_at_position` **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_count` **(** **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -128,7 +129,7 @@ Signals - **item_activated** **(** :ref:`int` index **)** Fired when specified list item is activated via double click or Enter. -- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` atpos **)** +- **item_rmb_selected** **(** :ref:`int` index, :ref:`Vector2` at_position **)** Fired when specified list item has been selected via right mouse clicking. The click position is also provided to allow appropriate popup of context menus @@ -228,9 +229,9 @@ If column size has been fixed to a value, return that value. - :ref:`float` **get_icon_scale** **(** **)** const -.. _class_ItemList_get_item_at_pos: +.. _class_ItemList_get_item_at_position: -- :ref:`int` **get_item_at_pos** **(** :ref:`Vector2` pos, :ref:`bool` exact=false **)** const +- :ref:`int` **get_item_at_position** **(** :ref:`Vector2` position, :ref:`bool` exact=false **)** const Given a position within the control return the item (if any) at that point. diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 8b4181460..92659bab0 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Joint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Joint: @@ -8,7 +9,7 @@ Joint **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`ConeTwistJoint`, :ref:`SliderJoint`, :ref:`Generic6DOFJoint`, :ref:`HingeJoint`, :ref:`PinJoint` +**Inherited By:** :ref:`ConeTwistJoint`, :ref:`Generic6DOFJoint`, :ref:`SliderJoint`, :ref:`HingeJoint`, :ref:`PinJoint` **Category:** Core diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index bf8a86bff..3385fd7d9 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Joint2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Joint2D: diff --git a/classes/class_json.rst b/classes/class_json.rst new file mode 100644 index 000000000..8918c0343 --- /dev/null +++ b/classes/class_json.rst @@ -0,0 +1,39 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the JSON.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_JSON: + +JSON +==== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`JSONParseResult` | :ref:`parse` **(** :ref:`String` json **)** | ++------------------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`print` **(** :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_JSON_parse: + +- :ref:`JSONParseResult` **parse** **(** :ref:`String` json **)** + +.. _class_JSON_print: + +- :ref:`String` **print** **(** :ref:`Variant` value **)** + + diff --git a/classes/class_jsonparseresult.rst b/classes/class_jsonparseresult.rst new file mode 100644 index 000000000..f326ff81b --- /dev/null +++ b/classes/class_jsonparseresult.rst @@ -0,0 +1,83 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the JSONParseResult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_JSONParseResult: + +JSONParseResult +=============== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_error` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_error_line` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_error_string` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_result` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error` **(** :ref:`int` error **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error_line` **(** :ref:`int` error_line **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_error_string` **(** :ref:`String` error_string **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_result` **(** :ref:`Variant` result **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **error** +- :ref:`int` **error_line** +- :ref:`String` **error_string** +- :ref:`Variant` **result** + +Member Function Description +--------------------------- + +.. _class_JSONParseResult_get_error: + +- :ref:`int` **get_error** **(** **)** const + +.. _class_JSONParseResult_get_error_line: + +- :ref:`int` **get_error_line** **(** **)** const + +.. _class_JSONParseResult_get_error_string: + +- :ref:`String` **get_error_string** **(** **)** const + +.. _class_JSONParseResult_get_result: + +- :ref:`Variant` **get_result** **(** **)** const + +.. _class_JSONParseResult_set_error: + +- void **set_error** **(** :ref:`int` error **)** + +.. _class_JSONParseResult_set_error_line: + +- void **set_error_line** **(** :ref:`int` error_line **)** + +.. _class_JSONParseResult_set_error_string: + +- void **set_error_string** **(** :ref:`String` error_string **)** + +.. _class_JSONParseResult_set_result: + +- void **set_result** **(** :ref:`Variant` result **)** + + diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index e40f4d7a1..e40e45a94 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the KinematicBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_KinematicBody: diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index e5a8f249f..4608a3cb6 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the KinematicBody2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_KinematicBody2D: @@ -18,49 +19,29 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_count` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | -+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`get_slide_collision` **(** :ref:`int` slide_idx **)** | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_slide_count` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`KinematicCollision2D` | :ref:`move_and_collide` **(** :ref:`Vector2` rel_vec **)** | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2( 0, 0 ), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -79,56 +60,6 @@ Kinematic Characters: KinematicBody2D also has an api for moving objects (the :r Member Function Description --------------------------- -.. _class_KinematicBody2D_get_collision_collider: - -- :ref:`Object` **get_collision_collider** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_collider_id: - -- :ref:`int` **get_collision_collider_id** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_collider_metadata: - -- :ref:`Variant` **get_collision_collider_metadata** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_collider_shape: - -- :ref:`Object` **get_collision_collider_shape** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_collider_shape_index: - -- :ref:`int` **get_collision_collider_shape_index** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_collider_velocity: - -- :ref:`Vector2` **get_collision_collider_velocity** **(** :ref:`int` collision **)** const - -Return the velocity of the body that collided with this one. - -.. _class_KinematicBody2D_get_collision_count: - -- :ref:`int` **get_collision_count** **(** **)** const - -.. _class_KinematicBody2D_get_collision_local_shape: - -- :ref:`Object` **get_collision_local_shape** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_normal: - -- :ref:`Vector2` **get_collision_normal** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_position: - -- :ref:`Vector2` **get_collision_position** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_remainder: - -- :ref:`Vector2` **get_collision_remainder** **(** :ref:`int` collision **)** const - -.. _class_KinematicBody2D_get_collision_travel: - -- :ref:`Vector2` **get_collision_travel** **(** :ref:`int` collision **)** const - .. _class_KinematicBody2D_get_floor_velocity: - :ref:`Vector2` **get_floor_velocity** **(** **)** const @@ -137,6 +68,14 @@ Return the velocity of the body that collided with this one. - :ref:`float` **get_safe_margin** **(** **)** const +.. _class_KinematicBody2D_get_slide_collision: + +- :ref:`KinematicCollision2D` **get_slide_collision** **(** :ref:`int` slide_idx **)** + +.. _class_KinematicBody2D_get_slide_count: + +- :ref:`int` **get_slide_count** **(** **)** const + .. _class_KinematicBody2D_is_on_ceiling: - :ref:`bool` **is_on_ceiling** **(** **)** const @@ -149,29 +88,11 @@ Return the velocity of the body that collided with this one. - :ref:`bool` **is_on_wall** **(** **)** const -.. _class_KinematicBody2D_move: +.. _class_KinematicBody2D_move_and_collide: -- :ref:`Dictionary` **move** **(** :ref:`Vector2` rel_vec **)** +- :ref:`KinematicCollision2D` **move_and_collide** **(** :ref:`Vector2` rel_vec **)** -Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: - -- "position" - collision position - -- "normal" - collision normal - -- "local_shape" - id of this kinematic body shape that took part in a collision - -- "travel" - traveled movement before being stopped - -- "remainder" - remaining movement before being stopped - -- "collider_id" - id of the collider, it can be used when dealing with :ref:`Physics2DServer` - -- "collider" - colliding body - -- "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" - -If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than :ref:`move_and_slide`. If you don't want to program each edge case manually, then it's recommended to use :ref:`move_and_slide` instead. +Moves the body along the given vector. The body will stop if it collides. Returns a :ref:`KinematicCollision2D`, which contains information about the colliding body. .. _class_KinematicBody2D_move_and_slide: @@ -185,6 +106,6 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t - :ref:`bool` **test_move** **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** -Return true if there would be a collision if the body moved from the given point in the given direction. +Returns true if there would be a collision if the body moved from the given point in the given direction. diff --git a/classes/class_kinematiccollision.rst b/classes/class_kinematiccollision.rst index 1f3a22287..84377bceb 100644 --- a/classes/class_kinematiccollision.rst +++ b/classes/class_kinematiccollision.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the KinematicCollision.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_KinematicCollision: @@ -13,7 +14,7 @@ KinematicCollision Brief Description ----------------- - +Collision data for KinematicBody2D collisions. Member Functions ---------------- @@ -45,17 +46,24 @@ Member Functions Member Variables ---------------- -- :ref:`Object` **collider** -- :ref:`int` **collider_id** -- :ref:`Variant` **collider_metadata** -- :ref:`Object` **collider_shape** -- :ref:`int` **collider_shape_index** -- :ref:`Vector3` **collider_velocity** -- :ref:`Object` **local_shape** -- :ref:`Vector3` **normal** -- :ref:`Vector3` **position** -- :ref:`Vector3` **remainder** -- :ref:`Vector3` **travel** +- :ref:`Object` **collider** - The colliding body. +- :ref:`int` **collider_id** - The colliding body's unique [RID]. +- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See [Object]. +- :ref:`Object` **collider_shape** - The colliding body's shape. +- :ref:`int` **collider_shape_index** - The colliding shape's index. See [CollisionObject]. +- :ref:`Vector3` **collider_velocity** - The colliding object's velocity. +- :ref:`Object` **local_shape** - The moving object's colliding shape. +- :ref:`Vector3` **normal** - The colliding body's shape's normal at the point of collision. +- :ref:`Vector3` **position** - The point of collision. +- :ref:`Vector3` **remainder** - The moving object's remaining movement vector. +- :ref:`Vector3` **travel** - The distance the moving object traveled before collision. + +Description +----------- + +Contains collision data for KinematicBody collisions. When a :ref:`KinematicBody` is moved using :ref:`KinematicBody.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision object is returned. + +This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. Member Function Description --------------------------- diff --git a/classes/class_kinematiccollision2d.rst b/classes/class_kinematiccollision2d.rst new file mode 100644 index 000000000..1b5ce1352 --- /dev/null +++ b/classes/class_kinematiccollision2d.rst @@ -0,0 +1,115 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the KinematicCollision2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_KinematicCollision2D: + +KinematicCollision2D +==================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Collision data for KinematicBody2D collisions. + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_id` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape_index` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_local_shape` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_normal` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_remainder` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Object` **collider** - The colliding body. +- :ref:`int` **collider_id** - The colliding body's unique [RID]. +- :ref:`Variant` **collider_metadata** - The colliding body's metadata. See [Object]. +- :ref:`Object` **collider_shape** - The colliding body's shape. +- :ref:`int` **collider_shape_index** - The colliding shape's index. See [CollisionObject2D]. +- :ref:`Vector2` **collider_velocity** - The colliding object's velocity. +- :ref:`Object` **local_shape** - The moving object's colliding shape. +- :ref:`Vector2` **normal** - The colliding body's shape's normal at the point of collision. +- :ref:`Vector2` **position** - The point of collision. +- :ref:`Vector2` **remainder** - The moving object's remaining movement vector. +- :ref:`Vector2` **travel** - The distance the moving object traveled before collision. + +Description +----------- + +Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D` is moved using :ref:`KinematicBody2D.move_and_collide`, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned. + +This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response. + +Member Function Description +--------------------------- + +.. _class_KinematicCollision2D_get_collider: + +- :ref:`Object` **get_collider** **(** **)** const + +.. _class_KinematicCollision2D_get_collider_id: + +- :ref:`int` **get_collider_id** **(** **)** const + +.. _class_KinematicCollision2D_get_collider_metadata: + +- :ref:`Variant` **get_collider_metadata** **(** **)** const + +.. _class_KinematicCollision2D_get_collider_shape: + +- :ref:`Object` **get_collider_shape** **(** **)** const + +.. _class_KinematicCollision2D_get_collider_shape_index: + +- :ref:`int` **get_collider_shape_index** **(** **)** const + +.. _class_KinematicCollision2D_get_collider_velocity: + +- :ref:`Vector2` **get_collider_velocity** **(** **)** const + +.. _class_KinematicCollision2D_get_local_shape: + +- :ref:`Object` **get_local_shape** **(** **)** const + +.. _class_KinematicCollision2D_get_normal: + +- :ref:`Vector2` **get_normal** **(** **)** const + +.. _class_KinematicCollision2D_get_position: + +- :ref:`Vector2` **get_position** **(** **)** const + +.. _class_KinematicCollision2D_get_remainder: + +- :ref:`Vector2` **get_remainder** **(** **)** const + +.. _class_KinematicCollision2D_get_travel: + +- :ref:`Vector2` **get_travel** **(** **)** const + + diff --git a/classes/class_label.rst b/classes/class_label.rst index 3461e4c9f..28925620d 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Label.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Label: @@ -13,7 +14,7 @@ Label Brief Description ----------------- -Control that displays formatted text. +Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel`. Member Functions ---------------- @@ -71,15 +72,15 @@ Member Functions Member Variables ---------------- -- :ref:`int` **align** -- :ref:`bool` **autowrap** -- :ref:`bool` **clip_text** -- :ref:`int` **lines_skipped** -- :ref:`int` **max_lines_visible** -- :ref:`float` **percent_visible** -- :ref:`String` **text** -- :ref:`bool` **uppercase** -- :ref:`int` **valign** +- :ref:`int` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the [code]ALIGN_*[/code] constants. +- :ref:`bool` **autowrap** - If [code]true[/code], 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. +- :ref:`bool` **clip_text** - If [code]true[/code], the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely. +- :ref:`int` **lines_skipped** - The node ignores the first [code]lines_skipped[/code] lines before it starts to display text. +- :ref:`int` **max_lines_visible** - Limits the lines of text the node shows on screen. +- :ref:`float` **percent_visible** - Limits the count of visible characters. If you set [code]percent_visible[/code] to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. +- :ref:`String` **text** - The text to display on screen. +- :ref:`bool` **uppercase** - If [code]true[/code], all the text displays as UPPERCASE. +- :ref:`int` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants. Numeric Constants ----------------- @@ -96,7 +97,7 @@ Numeric Constants Description ----------- -Label is a control that displays formatted text, optionally autowrapping it to the :ref:`Control` area. It inherits from range to be able to scroll wrapped text vertically. +Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use :ref:`RichTextLabel` instead. Member Function Description --------------------------- @@ -111,13 +112,13 @@ Return the alignment mode (any of the ALIGN\_\* enumeration values). - :ref:`int` **get_line_count** **(** **)** const -Return the amount of lines. +Returns the amount of lines of text the Label has. .. _class_Label_get_line_height: - :ref:`int` **get_line_height** **(** **)** const -Return the height of a line. +Returns the font size in pixels. .. _class_Label_get_lines_skipped: @@ -175,13 +176,13 @@ Return the state of the *autowrap* mode (see :ref:`set_autowrap` **is_clipping_text** **(** **)** const -Return true if text would be cut off if it is too wide. +Return ``true`` if text would be cut off if it is too wide. .. _class_Label_is_uppercase: - :ref:`bool` **is_uppercase** **(** **)** const -Return true if text is displayed in all capitals. +Return ``true`` if text is displayed in all capitals. .. _class_Label_set_align: diff --git a/classes/class_largetexture.rst b/classes/class_largetexture.rst index a1498afbd..07e7c07a2 100644 --- a/classes/class_largetexture.rst +++ b/classes/class_largetexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the LargeTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_LargeTexture: diff --git a/classes/class_light.rst b/classes/class_light.rst index 0e480ea21..0869ee9c4 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Light.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Light: @@ -67,7 +68,6 @@ Member Variables - :ref:`Color` **shadow_color** - :ref:`float` **shadow_contact** - :ref:`bool` **shadow_enabled** -- :ref:`float` **shadow_max_distance** - :ref:`bool` **shadow_reverse_cull_face** Numeric Constants diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 02337df25..a1851f79e 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Light2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Light2D: @@ -107,27 +108,27 @@ Member Functions Member Variables ---------------- -- :ref:`Color` **color** -- :ref:`bool` **editor_only** -- :ref:`bool` **enabled** -- :ref:`float` **energy** -- :ref:`int` **mode** -- :ref:`Vector2` **offset** -- :ref:`float` **range_height** -- :ref:`int` **range_item_cull_mask** -- :ref:`int` **range_layer_max** -- :ref:`int` **range_layer_min** -- :ref:`int` **range_z_max** -- :ref:`int` **range_z_min** -- :ref:`int` **shadow_buffer_size** -- :ref:`Color` **shadow_color** -- :ref:`bool` **shadow_enabled** -- :ref:`int` **shadow_filter** -- :ref:`float` **shadow_filter_smooth** -- :ref:`float` **shadow_gradient_length** -- :ref:`int` **shadow_item_cull_mask** -- :ref:`Texture` **texture** -- :ref:`float` **texture_scale** +- :ref:`Color` **color** - The Light2D's [Color]. +- :ref:`bool` **editor_only** - If [code]true[/code] Light2D will only appear when editing the scene. Default value: [code]false[/code]. +- :ref:`bool` **enabled** - If [code]true[/code] Light2D will emit light. Default value: [code]true[/code]. +- :ref:`float` **energy** - The Light2D's energy value. The larger the value, the stronger the light. +- :ref:`int` **mode** - The Light2D's mode. See MODE_* constants for values. +- :ref:`Vector2` **offset** - The offset of the Light2D's [code]texture[/code]. +- :ref:`float` **range_height** - The height of the Light2D. Used with 2D normal mapping. +- :ref:`int` **range_item_cull_mask** - The layer mask. Only objects with a matching mask will be affected by the Light2D. +- :ref:`int` **range_layer_max** - Maximum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. +- :ref:`int` **range_layer_min** - Minimum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. +- :ref:`int` **range_z_max** - Maximum [code]Z[/code] value of objects that are affected by the Light2D. Default value: [code]1024[/code]. +- :ref:`int` **range_z_min** - Minimum [code]z[/code] value of objects that are affected by the Light2D. Default value: [code]-1024[/code]. +- :ref:`int` **shadow_buffer_size** - Shadow buffer size. Default value: [code]2048[/code]. +- :ref:`Color` **shadow_color** - [Color] of shadows cast by the Light2D. +- :ref:`bool` **shadow_enabled** - If [code]true[/code] the Light2D will cast shadows. Default value: [code]false[/code]. +- :ref:`int` **shadow_filter** - Shadow filter type. May be one of [code][None, PCF5, PCF9, PCF13][/code]. Default value: [code]None[/code]. +- :ref:`float` **shadow_filter_smooth** - Smoothing value for shadows. +- :ref:`float` **shadow_gradient_length** - Smooth shadow gradient length. +- :ref:`int` **shadow_item_cull_mask** - The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching shadow mask will cast shadows. +- :ref:`Texture` **texture** - [Texture] used for the Light2D's appearance. +- :ref:`float` **texture_scale** - The [code]texture[/code]'s scale factor. Numeric Constants ----------------- @@ -136,6 +137,12 @@ Numeric Constants - **MODE_SUB** = **1** --- Subtract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. - **MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. - **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. +- **SHADOW_FILTER_NONE** = **0** +- **SHADOW_FILTER_PCF3** = **1** +- **SHADOW_FILTER_PCF5** = **2** +- **SHADOW_FILTER_PCF7** = **3** +- **SHADOW_FILTER_PCF9** = **4** +- **SHADOW_FILTER_PCF13** = **5** Description ----------- diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index 9b9d17710..ffe99a277 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the LightOccluder2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_LightOccluder2D: @@ -13,7 +14,7 @@ LightOccluder2D Brief Description ----------------- -Occludes light cast by a Light2D, thus casting shadows. +Occludes light cast by a Light2D, casting shadows. Member Functions ---------------- @@ -31,13 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`int` **light_mask** -- :ref:`OccluderPolygon2D` **occluder** +- :ref:`int` **light_mask** - The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). +- :ref:`OccluderPolygon2D` **occluder** - The [OccluderPolygon2D] used to compute the shadow. Description ----------- -Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows. +Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an :ref:`OccluderPolygon2D` in order for the shadow to be computed. Member Function Description --------------------------- diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index ef52da625..6685e52d7 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Line2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Line2D: @@ -13,66 +14,66 @@ Line2D Brief Description ----------------- - +A 2D line. Member Functions ---------------- -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`Vector2` pos **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_default_color` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` i **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_round_precision` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_width` **(** **)** const | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` i **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_point_pos` **(** :ref:`int` i, :ref:`Vector2` pos **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`float` width **)** | -+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`Vector2` position **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_begin_cap_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_default_color` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_end_cap_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joint_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_round_precision` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sharp_limit` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_mode` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_width` **(** **)** const | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` i **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_begin_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_color` **(** :ref:`Color` color **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_end_cap_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gradient` **(** :ref:`Gradient` color **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_joint_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_position` **(** :ref:`int` i, :ref:`Vector2` position **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_round_precision` **(** :ref:`int` precision **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sharp_limit` **(** :ref:`float` limit **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_mode` **(** :ref:`int` mode **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`float` width **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -101,12 +102,19 @@ Numeric Constants - **LINE_TEXTURE_NONE** = **0** - **LINE_TEXTURE_TILE** = **1** +Description +----------- + +A line through several points in 2D space. + Member Function Description --------------------------- .. _class_Line2D_add_point: -- void **add_point** **(** :ref:`Vector2` pos **)** +- void **add_point** **(** :ref:`Vector2` position **)** + +Add a point at the x/y position in the supplied :ref:`Vector2` .. _class_Line2D_get_begin_cap_mode: @@ -132,9 +140,9 @@ Member Function Description - :ref:`int` **get_point_count** **(** **)** const -.. _class_Line2D_get_point_pos: +.. _class_Line2D_get_point_position: -- :ref:`Vector2` **get_point_pos** **(** :ref:`int` i **)** const +- :ref:`Vector2` **get_point_position** **(** :ref:`int` i **)** const .. _class_Line2D_get_points: @@ -164,6 +172,8 @@ Member Function Description - void **remove_point** **(** :ref:`int` i **)** +Remove the point at index 'i' from the line. + .. _class_Line2D_set_begin_cap_mode: - void **set_begin_cap_mode** **(** :ref:`int` mode **)** @@ -184,9 +194,9 @@ Member Function Description - void **set_joint_mode** **(** :ref:`int` mode **)** -.. _class_Line2D_set_point_pos: +.. _class_Line2D_set_point_position: -- void **set_point_pos** **(** :ref:`int` i, :ref:`Vector2` pos **)** +- void **set_point_position** **(** :ref:`int` i, :ref:`Vector2` position **)** .. _class_Line2D_set_points: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 95f076496..b0d06fa0a 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the LineEdit.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_LineEdit: @@ -33,7 +34,7 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_align` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cursor_pos` **(** **)** const | +| :ref:`int` | :ref:`get_cursor_position` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_expand_to_text_length` **(** **)** const | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -59,7 +60,7 @@ Member Functions +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_align` **(** :ref:`int` align **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cursor_pos` **(** :ref:`int` pos **)** | +| void | :ref:`set_cursor_position` **(** :ref:`int` position **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`bool` enabled **)** | +------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -104,16 +105,16 @@ Member Variables Numeric Constants ----------------- -- **ALIGN_LEFT** = **0** -- **ALIGN_CENTER** = **1** -- **ALIGN_RIGHT** = **2** -- **ALIGN_FILL** = **3** -- **MENU_CUT** = **0** -- **MENU_COPY** = **1** -- **MENU_PASTE** = **2** -- **MENU_CLEAR** = **3** -- **MENU_SELECT_ALL** = **4** -- **MENU_UNDO** = **5** +- **ALIGN_LEFT** = **0** --- Align left. +- **ALIGN_CENTER** = **1** --- Align center. +- **ALIGN_RIGHT** = **2** --- Align right. +- **ALIGN_FILL** = **3** --- Align fill. +- **MENU_CUT** = **0** --- Cut (Copy and clear). +- **MENU_COPY** = **1** --- Copy the selected text. +- **MENU_PASTE** = **2** --- Paste the clipboard text over the selected text. +- **MENU_CLEAR** = **3** --- Clear the text. +- **MENU_SELECT_ALL** = **4** --- Select all text. +- **MENU_UNDO** = **5** --- Undo an action. - **MENU_MAX** = **6** Description @@ -164,9 +165,11 @@ Set the line edit caret blink speed. Cannot be less then or equal to 0. - :ref:`int` **get_align** **(** **)** const -.. _class_LineEdit_get_cursor_pos: +Return the align mode of the :ref:`LineEdit`. -- :ref:`int` **get_cursor_pos** **(** **)** const +.. _class_LineEdit_get_cursor_position: + +- :ref:`int` **get_cursor_position** **(** **)** const Return the cursor position inside the :ref:`LineEdit`. @@ -184,14 +187,20 @@ Return the maximum amount of characters the :ref:`LineEdit` can - :ref:`PopupMenu` **get_menu** **(** **)** const +Return the :ref:`PopupMenu` of this :ref:`LineEdit`. + .. _class_LineEdit_get_placeholder: - :ref:`String` **get_placeholder** **(** **)** const +Return the placeholder text. + .. _class_LineEdit_get_placeholder_alpha: - :ref:`float` **get_placeholder_alpha** **(** **)** const +Return transparency of the placeholder text. + .. _class_LineEdit_get_text: - :ref:`String` **get_text** **(** **)** const @@ -214,10 +223,20 @@ Return the *secret* status of the :ref:`LineEdit` (see :ref:`set - void **menu_option** **(** :ref:`int` option **)** +Execute a given action as defined in the MENU\_\* enum. + .. _class_LineEdit_select: - void **select** **(** :ref:`int` from=0, :ref:`int` to=-1 **)** +Select the text inside :ref:`LineEdit` by the given character positions. ``from`` is default to the beginning. ``to`` is default to the end. + +:: + + select() # select all + select(5) # select from the fifth character to the end. + select(2, 5) # select from the second to the fifth character. + .. _class_LineEdit_select_all: - void **select_all** **(** **)** @@ -228,9 +247,11 @@ Select the whole string. - void **set_align** **(** :ref:`int` align **)** -.. _class_LineEdit_set_cursor_pos: +Set text alignment of the :ref:`LineEdit`. -- void **set_cursor_pos** **(** :ref:`int` pos **)** +.. _class_LineEdit_set_cursor_position: + +- void **set_cursor_position** **(** :ref:`int` position **)** Set the cursor position inside the :ref:`LineEdit`, causing it to scroll if needed. @@ -254,10 +275,14 @@ Set the maximum amount of characters the :ref:`LineEdit` can edi - void **set_placeholder** **(** :ref:`String` text **)** +Set the placeholder text. + .. _class_LineEdit_set_placeholder_alpha: - void **set_placeholder_alpha** **(** :ref:`float` alpha **)** +Set transparency of the placeholder text. + .. _class_LineEdit_set_secret: - void **set_secret** **(** :ref:`bool` enabled **)** diff --git a/classes/class_lineshape2d.rst b/classes/class_lineshape2d.rst index 7dd69a605..b04d0ec77 100644 --- a/classes/class_lineshape2d.rst +++ b/classes/class_lineshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the LineShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_LineShape2D: @@ -13,7 +14,7 @@ LineShape2D Brief Description ----------------- -Line shape for 2D collision objects. +Line shape for 2D collisions. Member Functions ---------------- @@ -31,13 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`float` **d** -- :ref:`Vector2` **normal** +- :ref:`float` **d** - The line's distance from the origin. +- :ref:`Vector2` **normal** - The line's normal. Description ----------- -Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. +Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. Member Function Description --------------------------- diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index e1b36e3e2..1ffd18257 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the LinkButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_LinkButton: diff --git a/classes/class_listener.rst b/classes/class_listener.rst index 518d6b0f4..26c5047ee 100644 --- a/classes/class_listener.rst +++ b/classes/class_listener.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Listener.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Listener: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 2570d7b4d..9c0938776 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MainLoop.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MainLoop: @@ -77,14 +78,20 @@ Member Function Description - void **_finalize** **(** **)** virtual +Called before the program exits. + .. _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: - void **_initialize** **(** **)** virtual +Called once during initialization. + .. _class_MainLoop__input_event: - void **_input_event** **(** :ref:`InputEvent` ev **)** virtual diff --git a/classes/class_margincontainer.rst b/classes/class_margincontainer.rst index 9a5908c19..64a9bd136 100644 --- a/classes/class_margincontainer.rst +++ b/classes/class_margincontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MarginContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MarginContainer: diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 29cfb467e..76c209f44 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Marshalls.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Marshalls: @@ -13,7 +14,7 @@ Marshalls Brief Description ----------------- - +Data transformation (marshalling) and encoding helpers. Member Functions ---------------- @@ -32,6 +33,11 @@ Member Functions | :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +Provides data transformation and encoding utility functions. + Member Function Description --------------------------- @@ -39,24 +45,36 @@ Member Function Description - :ref:`PoolByteArray` **base64_to_raw** **(** :ref:`String` base64_str **)** +Return :ref:`PoolByteArray` of a given base64 encoded String. + .. _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: - :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** +Return :ref:`Variant` of a given base64 encoded String. + .. _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: - :ref:`String` **utf8_to_base64** **(** :ref:`String` utf8_str **)** +Return base64 encoded String of a given utf8 String. + .. _class_Marshalls_variant_to_base64: - :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** +Return base64 encoded String of a given :ref:`Variant`. + diff --git a/classes/class_material.rst b/classes/class_material.rst index d7df9d03a..b43be4410 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Material.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Material: diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index 82c9969e6..6d21663c0 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MenuButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MenuButton: @@ -26,6 +27,8 @@ Signals ------- - **about_to_show** **(** **)** +Emitted when :ref:`PopupMenu` of this MenuButton is about to show. + Member Variables ---------------- diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 844971f9a..722c50fdb 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Mesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Mesh: @@ -42,6 +43,40 @@ Numeric Constants - **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). - **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. +- **BLEND_SHAPE_MODE_NORMALIZED** = **0** +- **BLEND_SHAPE_MODE_RELATIVE** = **1** +- **ARRAY_FORMAT_VERTEX** = **1** +- **ARRAY_FORMAT_NORMAL** = **2** +- **ARRAY_FORMAT_TANGENT** = **4** +- **ARRAY_FORMAT_COLOR** = **8** +- **ARRAY_FORMAT_TEX_UV** = **16** +- **ARRAY_FORMAT_TEX_UV2** = **32** +- **ARRAY_FORMAT_BONES** = **64** +- **ARRAY_FORMAT_WEIGHTS** = **128** +- **ARRAY_FORMAT_INDEX** = **256** +- **ARRAY_COMPRESS_BASE** = **9** +- **ARRAY_COMPRESS_VERTEX** = **512** +- **ARRAY_COMPRESS_NORMAL** = **1024** +- **ARRAY_COMPRESS_TANGENT** = **2048** +- **ARRAY_COMPRESS_COLOR** = **4096** +- **ARRAY_COMPRESS_TEX_UV** = **8192** +- **ARRAY_COMPRESS_TEX_UV2** = **16384** +- **ARRAY_COMPRESS_BONES** = **32768** +- **ARRAY_COMPRESS_WEIGHTS** = **65536** +- **ARRAY_COMPRESS_INDEX** = **131072** +- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** +- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** +- **ARRAY_COMPRESS_DEFAULT** = **97792** +- **ARRAY_VERTEX** = **0** +- **ARRAY_NORMAL** = **1** +- **ARRAY_TANGENT** = **2** +- **ARRAY_COLOR** = **3** +- **ARRAY_TEX_UV** = **4** +- **ARRAY_TEX_UV2** = **5** +- **ARRAY_BONES** = **6** +- **ARRAY_WEIGHTS** = **7** +- **ARRAY_INDEX** = **8** +- **ARRAY_MAX** = **9** Description ----------- @@ -55,20 +90,30 @@ Member Function Description - :ref:`Shape` **create_convex_shape** **(** **)** const +Calculate a :ref:`ConvexPolygonShape` from the mesh. + .. _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: - :ref:`Shape` **create_trimesh_shape** **(** **)** const +Calculate a :ref:`ConcavePolygonShape` from the mesh. + .. _class_Mesh_generate_triangle_mesh: - :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** const +Generate a :ref:`TriangleMesh` from the mesh. + .. _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. + diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index fefc8b212..41e175e28 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MeshDataTool.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MeshDataTool: diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 4d4f17a7f..f8d3fd194 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MeshInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MeshInstance: @@ -41,8 +42,8 @@ Member Functions Member Variables ---------------- -- :ref:`Mesh` **mesh** -- :ref:`NodePath` **skeleton** +- :ref:`Mesh` **mesh** - The [Mesh] resource for the instance. +- :ref:`NodePath` **skeleton** - [NodePath] to the [Skeleton] associated with the instance. Description ----------- @@ -56,6 +57,8 @@ Member Function Description - void **create_convex_collision** **(** **)** +This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConvexPolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. + .. _class_MeshInstance_create_debug_tangents: - void **create_debug_tangents** **(** **)** @@ -64,13 +67,13 @@ Member Function Description - void **create_trimesh_collision** **(** **)** -This helper creates a :ref:`StaticBody` child :ref:`Node` using the mesh geometry as collision. It's mainly used for testing. +This helper creates a :ref:`StaticBody` child :ref:`Node` with a :ref:`ConcavePolygonShape` :ref:`CollisionShape` calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_get_mesh: - :ref:`Mesh` **get_mesh** **(** **)** const -Return the current :ref:`Mesh` resource for the instance. +Returns the current :ref:`Mesh` resource for the instance. .. _class_MeshInstance_get_skeleton_path: @@ -80,12 +83,12 @@ Return the current :ref:`Mesh` resource for the instance. - :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const +Returns the :ref:`Material` for a surface of the :ref:`Mesh` resource. + .. _class_MeshInstance_set_mesh: - void **set_mesh** **(** :ref:`Mesh` mesh **)** -Set the :ref:`Mesh` resource for the instance. - .. _class_MeshInstance_set_skeleton_path: - void **set_skeleton_path** **(** :ref:`NodePath` skeleton_path **)** @@ -94,4 +97,6 @@ Set the :ref:`Mesh` resource for the instance. - void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** +Sets the :ref:`Material` for a surface of the :ref:`Mesh` resource. + diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 511e55787..1e41c0a05 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MeshLibrary.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MeshLibrary: diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index f86468657..798567bfd 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MultiMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MultiMesh: diff --git a/classes/class_multimeshinstance.rst b/classes/class_multimeshinstance.rst index 6b2b539e6..acc4bc4eb 100644 --- a/classes/class_multimeshinstance.rst +++ b/classes/class_multimeshinstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the MultiMeshInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_MultiMeshInstance: diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 3761a1a87..a21bccc93 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Mutex.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Mutex: diff --git a/classes/class_nativescript.rst b/classes/class_nativescript.rst index f15165ddc..e80bb2ed7 100644 --- a/classes/class_nativescript.rst +++ b/classes/class_nativescript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NativeScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NativeScript: diff --git a/classes/class_navigation.rst b/classes/class_navigation.rst index c9f19d0ab..9c4d23d8f 100644 --- a/classes/class_navigation.rst +++ b/classes/class_navigation.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Navigation.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Navigation: diff --git a/classes/class_navigation2d.rst b/classes/class_navigation2d.rst index 2095e71ee..118efcfc0 100644 --- a/classes/class_navigation2d.rst +++ b/classes/class_navigation2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Navigation2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Navigation2D: diff --git a/classes/class_navigationmesh.rst b/classes/class_navigationmesh.rst index 2b689b24f..99121ec3e 100644 --- a/classes/class_navigationmesh.rst +++ b/classes/class_navigationmesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NavigationMesh: @@ -18,28 +19,120 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_polygons` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_polygon` **(** :ref:`PoolIntArray` polygon **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_polygons` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_mesh` **(** :ref:`Mesh` mesh **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_height` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_max_climb` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_max_slope` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_agent_radius` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_height` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_cell_size` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_detail_sample_distance` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_detail_sample_max_error` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_edge_max_error` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_edge_max_length` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_ledge_spans` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_low_hanging_obstacles` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_filter_walkable_low_height_spans` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_polygon` **(** :ref:`int` idx **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_polygon_count` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_region_merge_size` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_region_min_size` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_sample_partition_type` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_vertices` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_verts_per_poly` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_height` **(** :ref:`float` agent_height **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_max_climb` **(** :ref:`float` agent_max_climb **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_max_slope` **(** :ref:`float` agent_max_slope **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_agent_radius` **(** :ref:`float` agent_radius **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_height` **(** :ref:`float` cell_height **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_size` **(** :ref:`float` cell_size **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_sample_distance` **(** :ref:`float` detail_sample_dist **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_detail_sample_max_error` **(** :ref:`float` detail_sample_max_error **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_max_error` **(** :ref:`float` edge_max_error **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_edge_max_length` **(** :ref:`float` edge_max_length **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_ledge_spans` **(** :ref:`bool` filter_ledge_spans **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_low_hanging_obstacles` **(** :ref:`bool` filter_low_hanging_obstacles **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filter_walkable_low_height_spans` **(** :ref:`bool` filter_walkable_low_height_spans **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_merge_size` **(** :ref:`float` region_merge_size **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_min_size` **(** :ref:`float` region_min_size **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sample_partition_type` **(** :ref:`int` sample_partition_type **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vertices` **(** :ref:`PoolVector3Array` vertices **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_verts_per_poly` **(** :ref:`float` verts_per_poly **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- +- :ref:`float` **agent/height** +- :ref:`float` **agent/max_climb** +- :ref:`float` **agent/max_slope** +- :ref:`float` **agent/radius** +- :ref:`float` **cell/height** +- :ref:`float` **cell/size** +- :ref:`float` **detail/sample_distance** +- :ref:`float` **detail/sample_max_error** +- :ref:`float` **edge/max_error** +- :ref:`float` **edge/max_length** +- :ref:`bool` **filter/filter_walkable_low_height_spans** +- :ref:`bool` **filter/ledge_spans** +- :ref:`bool` **filter/low_hanging_obstacles** +- :ref:`float` **polygon/verts_per_poly** - :ref:`Array` **polygons** +- :ref:`float` **region/merge_size** +- :ref:`float` **region/min_size** +- :ref:`int` **sample_partition_type/sample_partition_type** - :ref:`PoolVector3Array` **vertices** +Numeric Constants +----------------- + +- **SAMPLE_PARTITION_WATERSHED** = **0** +- **SAMPLE_PARTITION_MONOTONE** = **1** +- **SAMPLE_PARTITION_LAYERS** = **2** + Member Function Description --------------------------- @@ -55,6 +148,58 @@ Member Function Description - void **create_from_mesh** **(** :ref:`Mesh` mesh **)** +.. _class_NavigationMesh_get_agent_height: + +- :ref:`float` **get_agent_height** **(** **)** const + +.. _class_NavigationMesh_get_agent_max_climb: + +- :ref:`float` **get_agent_max_climb** **(** **)** const + +.. _class_NavigationMesh_get_agent_max_slope: + +- :ref:`float` **get_agent_max_slope** **(** **)** const + +.. _class_NavigationMesh_get_agent_radius: + +- :ref:`float` **get_agent_radius** **(** **)** + +.. _class_NavigationMesh_get_cell_height: + +- :ref:`float` **get_cell_height** **(** **)** const + +.. _class_NavigationMesh_get_cell_size: + +- :ref:`float` **get_cell_size** **(** **)** const + +.. _class_NavigationMesh_get_detail_sample_distance: + +- :ref:`float` **get_detail_sample_distance** **(** **)** const + +.. _class_NavigationMesh_get_detail_sample_max_error: + +- :ref:`float` **get_detail_sample_max_error** **(** **)** const + +.. _class_NavigationMesh_get_edge_max_error: + +- :ref:`float` **get_edge_max_error** **(** **)** const + +.. _class_NavigationMesh_get_edge_max_length: + +- :ref:`float` **get_edge_max_length** **(** **)** const + +.. _class_NavigationMesh_get_filter_ledge_spans: + +- :ref:`bool` **get_filter_ledge_spans** **(** **)** const + +.. _class_NavigationMesh_get_filter_low_hanging_obstacles: + +- :ref:`bool` **get_filter_low_hanging_obstacles** **(** **)** const + +.. _class_NavigationMesh_get_filter_walkable_low_height_spans: + +- :ref:`bool` **get_filter_walkable_low_height_spans** **(** **)** const + .. _class_NavigationMesh_get_polygon: - :ref:`PoolIntArray` **get_polygon** **(** :ref:`int` idx **)** @@ -63,12 +208,96 @@ Member Function Description - :ref:`int` **get_polygon_count** **(** **)** const +.. _class_NavigationMesh_get_region_merge_size: + +- :ref:`float` **get_region_merge_size** **(** **)** const + +.. _class_NavigationMesh_get_region_min_size: + +- :ref:`float` **get_region_min_size** **(** **)** const + +.. _class_NavigationMesh_get_sample_partition_type: + +- :ref:`int` **get_sample_partition_type** **(** **)** const + .. _class_NavigationMesh_get_vertices: - :ref:`PoolVector3Array` **get_vertices** **(** **)** const +.. _class_NavigationMesh_get_verts_per_poly: + +- :ref:`float` **get_verts_per_poly** **(** **)** const + +.. _class_NavigationMesh_set_agent_height: + +- void **set_agent_height** **(** :ref:`float` agent_height **)** + +.. _class_NavigationMesh_set_agent_max_climb: + +- void **set_agent_max_climb** **(** :ref:`float` agent_max_climb **)** + +.. _class_NavigationMesh_set_agent_max_slope: + +- void **set_agent_max_slope** **(** :ref:`float` agent_max_slope **)** + +.. _class_NavigationMesh_set_agent_radius: + +- void **set_agent_radius** **(** :ref:`float` agent_radius **)** + +.. _class_NavigationMesh_set_cell_height: + +- void **set_cell_height** **(** :ref:`float` cell_height **)** + +.. _class_NavigationMesh_set_cell_size: + +- void **set_cell_size** **(** :ref:`float` cell_size **)** + +.. _class_NavigationMesh_set_detail_sample_distance: + +- void **set_detail_sample_distance** **(** :ref:`float` detail_sample_dist **)** + +.. _class_NavigationMesh_set_detail_sample_max_error: + +- void **set_detail_sample_max_error** **(** :ref:`float` detail_sample_max_error **)** + +.. _class_NavigationMesh_set_edge_max_error: + +- void **set_edge_max_error** **(** :ref:`float` edge_max_error **)** + +.. _class_NavigationMesh_set_edge_max_length: + +- void **set_edge_max_length** **(** :ref:`float` edge_max_length **)** + +.. _class_NavigationMesh_set_filter_ledge_spans: + +- void **set_filter_ledge_spans** **(** :ref:`bool` filter_ledge_spans **)** + +.. _class_NavigationMesh_set_filter_low_hanging_obstacles: + +- void **set_filter_low_hanging_obstacles** **(** :ref:`bool` filter_low_hanging_obstacles **)** + +.. _class_NavigationMesh_set_filter_walkable_low_height_spans: + +- void **set_filter_walkable_low_height_spans** **(** :ref:`bool` filter_walkable_low_height_spans **)** + +.. _class_NavigationMesh_set_region_merge_size: + +- void **set_region_merge_size** **(** :ref:`float` region_merge_size **)** + +.. _class_NavigationMesh_set_region_min_size: + +- void **set_region_min_size** **(** :ref:`float` region_min_size **)** + +.. _class_NavigationMesh_set_sample_partition_type: + +- void **set_sample_partition_type** **(** :ref:`int` sample_partition_type **)** + .. _class_NavigationMesh_set_vertices: - void **set_vertices** **(** :ref:`PoolVector3Array` vertices **)** +.. _class_NavigationMesh_set_verts_per_poly: + +- void **set_verts_per_poly** **(** :ref:`float` verts_per_poly **)** + diff --git a/classes/class_navigationmeshinstance.rst b/classes/class_navigationmeshinstance.rst index 747a7134d..e486be9b8 100644 --- a/classes/class_navigationmeshinstance.rst +++ b/classes/class_navigationmeshinstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationMeshInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NavigationMeshInstance: diff --git a/classes/class_navigationpolygon.rst b/classes/class_navigationpolygon.rst index b5ce1a575..07d564bfa 100644 --- a/classes/class_navigationpolygon.rst +++ b/classes/class_navigationpolygon.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationPolygon.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NavigationPolygon: diff --git a/classes/class_navigationpolygoninstance.rst b/classes/class_navigationpolygoninstance.rst index e8ae09f72..22446f439 100644 --- a/classes/class_navigationpolygoninstance.rst +++ b/classes/class_navigationpolygoninstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NavigationPolygonInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NavigationPolygonInstance: diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index f99a1a23c..a982b155f 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NetworkedMultiplayerENet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NetworkedMultiplayerENet: @@ -57,10 +58,14 @@ Member Function Description - :ref:`int` **create_client** **(** :ref:`String` ip, :ref:`int` port, :ref:`int` in_bandwidth=0, :ref:`int` out_bandwidth=0 **)** +Create client that connects to a server at address ``ip`` using specified ``port``. + .. _class_NetworkedMultiplayerENet_create_server: - :ref:`int` **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``. + .. _class_NetworkedMultiplayerENet_get_compression_mode: - :ref:`int` **get_compression_mode** **(** **)** const diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 4184248c6..1a665dc08 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NetworkedMultiplayerPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NetworkedMultiplayerPeer: @@ -42,10 +43,20 @@ Signals ------- - **connection_failed** **(** **)** +Emitted when failed to connect to server. + - **connection_succeeded** **(** **)** +Emitted when successfully connected to server. + - **peer_connected** **(** :ref:`int` id **)** +Emitted by the server when a client is connected. + - **peer_disconnected** **(** :ref:`int` id **)** +Emitted by the server when a client is disconnected. + - **server_disconnected** **(** **)** +Emitted by clients when server is disconnected. + Numeric Constants ----------------- @@ -78,6 +89,8 @@ Member Function Description - :ref:`bool` **is_refusing_new_connections** **(** **)** const +Return whether this :ref:`NetworkedMultiplayerPeer` is refusing new connections. + .. _class_NetworkedMultiplayerPeer_poll: - void **poll** **(** **)** @@ -86,6 +99,8 @@ Member Function Description - void **set_refuse_new_connections** **(** :ref:`bool` enable **)** +If ``endable`` is true, this :ref:`NetworkedMultiplayerPeer` will refuse new connections. + .. _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 c6093bcc0..b4f91b5eb 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Nil.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Nil: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index 8f59b9358..9f293de42 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NinePatchRect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NinePatchRect: @@ -13,7 +14,7 @@ NinePatchRect Brief Description ----------------- - +Scalable texture-based frame that tiles the texture's centers and sides, but keeps the corners' original size. Perfect for panels and dialog boxes. Member Functions ---------------- @@ -48,26 +49,33 @@ Signals ------- - **texture_changed** **(** **)** +Fired when the node's texture changes. + Member Variables ---------------- -- :ref:`int` **axis_stretch_horizontal** -- :ref:`int` **axis_stretch_vertical** -- :ref:`bool` **draw_center** -- :ref:`int` **patch_margin_bottom** -- :ref:`int` **patch_margin_left** -- :ref:`int` **patch_margin_right** -- :ref:`int` **patch_margin_top** -- :ref:`Rect2` **region_rect** -- :ref:`Texture` **texture** +- :ref:`int` **axis_stretch_horizontal** - Doesn't do anything at the time of writing. +- :ref:`int` **axis_stretch_vertical** - Doesn't do anything at the time of writing. +- :ref:`bool` **draw_center** - If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code] +- :ref:`int` **patch_margin_bottom** - 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 indivually to create panels with non-uniform borders. +- :ref:`int` **patch_margin_left** - The height of the 9-slice's left column. +- :ref:`int` **patch_margin_right** - The height of the 9-slice's right column. +- :ref:`int` **patch_margin_top** - The height of the 9-slice's top row. +- :ref:`Rect2` **region_rect** - Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. +- :ref:`Texture` **texture** - The node's texture resource. Numeric Constants ----------------- -- **AXIS_STRETCH_MODE_STRETCH** = **0** -- **AXIS_STRETCH_MODE_TILE** = **1** -- **AXIS_STRETCH_MODE_TILE_FIT** = **2** +- **AXIS_STRETCH_MODE_STRETCH** = **0** --- Doesn't do anything at the time of writing. Default value for ``axis_stretch_horizontal`` and ``axis_stretch_vertical``. +- **AXIS_STRETCH_MODE_TILE** = **1** --- Doesn't do anything at the time of writing. +- **AXIS_STRETCH_MODE_TILE_FIT** = **2** --- Doesn't do anything at the time of writing. + +Description +----------- + +Better known as 9-slice panels, NinePatchRect produces clean panels of any size, based on a small texture. To do so, it splits the texture in a 3 by 3 grid. When you scale the node, it tiles the texture's sides horizontally or vertically, the center on both axes but it doesn't scale or tile the corners. Member Function Description --------------------------- diff --git a/classes/class_node.rst b/classes/class_node.rst index cb2882e63..93aaec5e1 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Node.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Node: @@ -8,7 +9,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`AudioStreamPlayer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` +**Inherited By:** :ref:`Viewport`, :ref:`AudioStreamPlayer`, :ref:`EditorFileSystem`, :ref:`CanvasLayer`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorInterface`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`Timer`, :ref:`Tween` **Category:** Core @@ -20,177 +21,179 @@ Base class for all the *scene* elements. Member Functions ---------------- -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_enter_tree` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_exit_tree` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_ready` **(** **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_process` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_child_count` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_children` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_filename` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_groups` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_index` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_master` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_owner` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_parent` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_network_master` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_pos **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_stray_nodes` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`print_tree` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_free` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_and_skip` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_child` **(** :ref:`Node` node **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_ready` **(** **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_filename` **(** :ref:`String` filename **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_name` **(** :ref:`String` name **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | -+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_enter_tree` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_exit_tree` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_fixed_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_process` **(** :ref:`float` delta **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_ready` **(** **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_child_below_node` **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_to_group` **(** :ref:`String` group, :ref:`bool` persistent=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_process` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`duplicate` **(** :ref:`int` flags=15 **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`find_node` **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_child` **(** :ref:`int` idx **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_child_count` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_children` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_filename` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fixed_process_delta_time` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_groups` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_network_master` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_node_and_resource` **(** :ref:`NodePath` path **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_owner` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_parent` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_path_to` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_pause_mode` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position_in_parent` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_process_delta_time` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_scene_instance_load_placeholder` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTree` | :ref:`get_tree` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Viewport` | :ref:`get_viewport` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_node_and_resource` **(** :ref:`NodePath` path **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_a_parent_of` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_displayed_folded` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fixed_processing_internal` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_greater_than` **(** :ref:`Node` node **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_group` **(** :ref:`String` group **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_inside_tree` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_network_master` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_internal` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_processing_unhandled_key_input` **(** **)** const | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_child` **(** :ref:`Node` child_node, :ref:`int` to_position **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_stray_nodes` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`print_tree` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_call` **(** :ref:`String` method, :ref:`Array` args=[ ], :ref:`bool` parent_first=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`propagate_notification` **(** :ref:`int` what **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_free` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`raise` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_and_skip` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_child` **(** :ref:`Node` node **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_from_group` **(** :ref:`String` group **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`replace_by` **(** :ref:`Node` node, :ref:`bool` keep_data=false **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_ready` **(** **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc` **(** :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rpc_config` **(** :ref:`String` method, :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable` **(** :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`rpc_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` method **)** vararg | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_config` **(** :ref:`String` property, :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rset_unreliable_id` **(** :ref:`int` peer_id, :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_display_folded` **(** :ref:`bool` fold **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_filename` **(** :ref:`String` filename **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_name` **(** :ref:`String` name **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_owner` **(** :ref:`Node` owner **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pause_mode` **(** :ref:`int` mode **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_internal` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_unhandled_key_input` **(** :ref:`bool` enable **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scene_instance_load_placeholder` **(** :ref:`bool` load_placeholder **)** | ++------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -199,7 +202,11 @@ Signals Emitted when the node is renamed. - **tree_entered** **(** **)** +Emitted when Node enters the tree. + - **tree_exited** **(** **)** +Emitted when Node exits the tree. + Member Variables ---------------- @@ -229,13 +236,13 @@ Numeric Constants - **NOTIFICATION_INTERNAL_PROCESS** = **25** - **NOTIFICATION_INTERNAL_FIXED_PROCESS** = **26** - **RPC_MODE_DISABLED** = **0** -- **RPC_MODE_REMOTE** = **1** -- **RPC_MODE_SYNC** = **2** -- **RPC_MODE_MASTER** = **3** -- **RPC_MODE_SLAVE** = **4** -- **PAUSE_MODE_INHERIT** = **0** -- **PAUSE_MODE_STOP** = **1** -- **PAUSE_MODE_PROCESS** = **2** +- **RPC_MODE_REMOTE** = **1** --- Call a method remotely. +- **RPC_MODE_SYNC** = **2** --- Call a method both remotely and locally. +- **RPC_MODE_MASTER** = **3** --- Call a method if the Node is Master. +- **RPC_MODE_SLAVE** = **4** --- Call a method if the Node is Slave. +- **PAUSE_MODE_INHERIT** = **0** --- Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. +- **PAUSE_MODE_STOP** = **1** --- Stop processing when SceneTree is paused. +- **PAUSE_MODE_PROCESS** = **2** --- Continue to process regardless of SceneTree pause state. - **DUPLICATE_SIGNALS** = **1** - **DUPLICATE_GROUPS** = **2** - **DUPLICATE_SCRIPTS** = **4** @@ -297,6 +304,8 @@ Corresponds to the NOTIFICATION_FIXED_PROCESS notification in :ref:`Object._noti - void **_input** **(** :ref:`InputEvent` event **)** virtual +Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. + .. _class_Node__process: - void **_process** **(** :ref:`float` delta **)** virtual @@ -319,6 +328,8 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification - void **_unhandled_input** **(** :ref:`InputEvent` event **)** virtual +Propagated to all nodes when the previous InputEvent is not consumed by any nodes. + .. _class_Node__unhandled_key_input: - void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual @@ -331,6 +342,10 @@ Add a child :ref:`Node`. Nodes can have as many children as they wan The optional boolean argument enforces creating child nodes with human-readable names, based on the name of the node being instanced instead of its type only. +.. _class_Node_add_child_below_node: + +- void **add_child_below_node** **(** :ref:`Node` node, :ref:`Node` child_node, :ref:`bool` legible_unique_name=false **)** + .. _class_Node_add_to_group: - void **add_to_group** **(** :ref:`String` group, :ref:`bool` persistent=false **)** @@ -471,10 +486,14 @@ Return the relative path from the current node to the specified node in "node" a - :ref:`int` **get_pause_mode** **(** **)** const +Return the pause mode (PAUSE_MODE\_\*) of this Node. + .. _class_Node_get_position_in_parent: - :ref:`int` **get_position_in_parent** **(** **)** const +Return the order in the node tree branch, i.e. if called by the first child Node, return 0. + .. _class_Node_get_process_delta_time: - :ref:`float` **get_process_delta_time** **(** **)** const @@ -489,6 +508,8 @@ Return the time elapsed (in seconds) since the last process callback. This is al - :ref:`SceneTree` **get_tree** **(** **)** const +Return a :ref:`SceneTree` that this node is inside. + .. _class_Node_get_viewport: - :ref:`Viewport` **get_viewport** **(** **)** const @@ -497,6 +518,8 @@ Return the time elapsed (in seconds) since the last process callback. This is al - :ref:`bool` **has_node** **(** :ref:`NodePath` path **)** const +Return whether the node that a given :ref:`NodePath` points too exists. + .. _class_Node_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const @@ -531,10 +554,14 @@ Return *true* if "node" occurs later in the scene hierarchy than the current nod - :ref:`bool` **is_in_group** **(** :ref:`String` group **)** const +Return whether this Node is in the specified group. + .. _class_Node_is_inside_tree: - :ref:`bool` **is_inside_tree** **(** **)** const +Return whether this Node is inside a :ref:`SceneTree`. + .. _class_Node_is_network_master: - :ref:`bool` **is_network_master** **(** **)** const @@ -567,7 +594,7 @@ Return true if the node is processing unhandled input (see :ref:`set_process_unh .. _class_Node_move_child: -- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_pos **)** +- void **move_child** **(** :ref:`Node` child_node, :ref:`int` to_position **)** Move 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. @@ -597,6 +624,8 @@ Notify the current node and all its children recursively by calling notification - void **queue_free** **(** **)** +Queues a node for deletion at the end of the current frame. When deleted, all of its children 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 know whether a node will be deleted at the end of the frame. + .. _class_Node_raise: - void **raise** **(** **)** @@ -631,6 +660,8 @@ Replace a node in a scene by a given one. Subscriptions that pass through this n - void **request_ready** **(** **)** +Request that ``_ready`` be called again. + .. _class_Node_rpc: - :ref:`Variant` **rpc** **(** :ref:`String` method **)** vararg @@ -731,6 +762,8 @@ Set the node owner. A node can have any other node as owner (as long as a valid - void **set_pause_mode** **(** :ref:`int` mode **)** +Set pause mode (PAUSE_MODE\_\*) of this Node. + .. _class_Node_set_process: - void **set_process** **(** :ref:`bool` enable **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 51915dd8a..d9cac7fae 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Node2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Node2D: @@ -8,14 +9,14 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParallaxLayer`, :ref:`Line2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`Path2D`, :ref:`AudioStreamPlayer2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`RayCast2D`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Line2D`, :ref:`Position2D`, :ref:`AudioStreamPlayer2D`, :ref:`CanvasModulate`, :ref:`Sprite`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`ParallaxLayer`, :ref:`Polygon2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` **Category:** Core Brief Description ----------------- -Base node for 2D system. +A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. Member Functions ---------------- @@ -59,7 +60,7 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`rotate` **(** :ref:`float` radians **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_global_position` **(** :ref:`Vector2` position **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_rotation` **(** :ref:`float` radians **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,7 +70,7 @@ Member Functions +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_transform` **(** :ref:`Transform2D` xform **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ @@ -93,23 +94,23 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **global_position** -- :ref:`float` **global_rotation** -- :ref:`float` **global_rotation_deg** -- :ref:`Vector2` **global_scale** -- :ref:`Transform2D` **global_transform** -- :ref:`Vector2` **position** -- :ref:`float` **rotation** -- :ref:`float` **rotation_deg** -- :ref:`Vector2` **scale** -- :ref:`Transform2D` **transform** -- :ref:`int` **z** -- :ref:`bool` **z_as_relative** +- :ref:`Vector2` **global_position** - Global position. +- :ref:`float` **global_rotation** - Global rotation in radians. +- :ref:`float` **global_rotation_deg** - Global rotation in degrees. +- :ref:`Vector2` **global_scale** - Global scale. +- :ref:`Transform2D` **global_transform** - Global [Transform2D]. +- :ref:`Vector2` **position** - Position, relative to the node's parent. +- :ref:`float` **rotation** - Rotation in radians. +- :ref:`float` **rotation_deg** - Rotation in degrees. +- :ref:`Vector2` **scale** - Rotation in degrees. +- :ref:`Transform2D` **transform** - Local [Transform2D]. +- :ref:`int` **z** - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. +- :ref:`bool` **z_as_relative** - Make the node's Z-index 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. Description ----------- -Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform (:ref:`Transform2D`). A tree of Node2Ds allows complex hierarchies for animation and positioning. +A 2D game object, with a position, rotation and scale. All 2D physics nodes and sprites inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control on the node's render order. Member Function Description --------------------------- @@ -118,187 +119,187 @@ Member Function Description - void **apply_scale** **(** :ref:`Vector2` ratio **)** -Apply the 'ratio' scale to the 2D node, according to its current scale value. +Multiplies the current scale by the 'ratio' vector. .. _class_Node2D_edit_set_pivot: - void **edit_set_pivot** **(** :ref:`Vector2` pivot **)** -Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. +Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method. .. _class_Node2D_get_angle_to: - :ref:`float` **get_angle_to** **(** :ref:`Vector2` point **)** const -Return the rotation angle in radians needed for the 2d node to point at 'point' position. +Returns the angle between the node and the 'point' in radians. .. _class_Node2D_get_global_position: - :ref:`Vector2` **get_global_position** **(** **)** const -Return the global position of the 2D node. +Returns the node's global position. .. _class_Node2D_get_global_rotation: - :ref:`float` **get_global_rotation** **(** **)** const -Return the global rotation in radians of the 2D node. +Returns the node's global rotation in radians. .. _class_Node2D_get_global_rotation_in_degrees: - :ref:`float` **get_global_rotation_in_degrees** **(** **)** const -Return the global rotation in degrees of the 2D node. +Return the node's global rotation in degrees. .. _class_Node2D_get_global_scale: - :ref:`Vector2` **get_global_scale** **(** **)** const -Return the global scale of the 2D node. +Returns the node's global scale. .. _class_Node2D_get_position: - :ref:`Vector2` **get_position** **(** **)** const -Return the position of the 2D node. +Returns the node's position. .. _class_Node2D_get_relative_transform_to_parent: - :ref:`Transform2D` **get_relative_transform_to_parent** **(** :ref:`Node` parent **)** const -Return the transform :ref:`Transform2D` calculated relatively to the parent of this 2D node. +Returns the :ref:`Transform2D` relative to this node's parent. .. _class_Node2D_get_rotation: - :ref:`float` **get_rotation** **(** **)** const -Return the rotation in radians of the 2D node. +Returns the node's rotation in radians. .. _class_Node2D_get_rotation_in_degrees: - :ref:`float` **get_rotation_in_degrees** **(** **)** const -Return the rotation in degrees of the 2D node. +Returns the node's rotation in degrees. .. _class_Node2D_get_scale: - :ref:`Vector2` **get_scale** **(** **)** const -Return the scale of the 2D node. +Returns the node's scale. .. _class_Node2D_get_z: - :ref:`int` **get_z** **(** **)** const -Return the Z-index of the 2D node. +Returns the node's Z-index. .. _class_Node2D_global_translate: - void **global_translate** **(** :ref:`Vector2` offset **)** -Apply a global translation of 'offset' to the 2D node, starting from its current global position. +Adds the 'offset' vector to the node's global position. .. _class_Node2D_is_z_relative: - :ref:`bool` **is_z_relative** **(** **)** const -Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. +Returns true if this node's Z-index is relative to its parent's. Else, returns false. .. _class_Node2D_look_at: - void **look_at** **(** :ref:`Vector2` point **)** -Rotate the 2d node so it points at 'point' position. +Rotates the node so it points towards the 'point'. .. _class_Node2D_move_local_x: - void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. +Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. .. _class_Node2D_move_local_y: - void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. +Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. .. _class_Node2D_rotate: - void **rotate** **(** :ref:`float` radians **)** -Apply a rotation (in radians) to the 2D node, starting from its current rotation. +Apply a rotation to the node, in radians, starting from its current rotation. .. _class_Node2D_set_global_position: -- void **set_global_position** **(** :ref:`Vector2` pos **)** +- void **set_global_position** **(** :ref:`Vector2` position **)** -Set the global position of the 2D node. +Set the node's global position. .. _class_Node2D_set_global_rotation: - void **set_global_rotation** **(** :ref:`float` radians **)** -Set the global rotation in radians of the 2D node +Set the node's global rotation in radians. .. _class_Node2D_set_global_rotation_in_degrees: - void **set_global_rotation_in_degrees** **(** :ref:`float` degrees **)** -Set the global rotation in degrees of the 2D node +Set the node's global rotation in degrees. .. _class_Node2D_set_global_scale: - void **set_global_scale** **(** :ref:`Vector2` scale **)** -Set the global scale of the 2D node. +Set the node's global scale. .. _class_Node2D_set_global_transform: - void **set_global_transform** **(** :ref:`Transform2D` xform **)** -Set the global transform :ref:`Transform2D` of the 2D node. +Set the node's global :ref:`Transform2D`. .. _class_Node2D_set_position: -- void **set_position** **(** :ref:`Vector2` pos **)** +- void **set_position** **(** :ref:`Vector2` position **)** -Set the position of the 2D node. +Set the node's position. .. _class_Node2D_set_rotation: - void **set_rotation** **(** :ref:`float` radians **)** -Set the rotation in radians of the 2D node. +Set the node's rotation in radians. .. _class_Node2D_set_rotation_in_degrees: - void **set_rotation_in_degrees** **(** :ref:`float` degrees **)** -Set the rotation in degrees of the 2D node. +Set the node's rotation in degrees. .. _class_Node2D_set_scale: - void **set_scale** **(** :ref:`Vector2` scale **)** -Set the scale of the 2D node. +Set the node's scale. .. _class_Node2D_set_transform: - void **set_transform** **(** :ref:`Transform2D` xform **)** -Set the local transform :ref:`Transform2D` of the 2D node. +Set the node's local :ref:`Transform2D`. .. _class_Node2D_set_z: - void **set_z** **(** :ref:`int` z **)** -Set the Z-index value of the 2D node. +Set the node's Z-index. .. _class_Node2D_set_z_as_relative: - void **set_z_as_relative** **(** :ref:`bool` enable **)** -Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5. +Make the node's Z-index 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_to_global: @@ -312,6 +313,6 @@ Set the Z-index value as relative to the parent node of this 2D node. Thus, if t - void **translate** **(** :ref:`Vector2` offset **)** -Apply a local translation of 'offset' to the 2D node, starting from its current local position. +Translate the node locally by the 'offset' vector, starting from its current local position. diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index ab8589ad8..e2f51ec26 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the NodePath.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_NodePath: diff --git a/classes/class_object.rst b/classes/class_object.rst index 90ff84861..d498f2074 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -1,12 +1,13 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Object.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Object: Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Physics2DServer`, :ref:`MainLoop`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`ARVRPositionalTracker`, :ref:`TreeItem`, :ref:`PhysicsDirectBodyState`, :ref:`ARVRServer`, :ref:`PhysicsDirectSpaceState`, :ref:`Reference`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`JSON`, :ref:`AudioServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`VisualServer`, :ref:`OS`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index f6b89c7e7..793ba58f9 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the OccluderPolygon2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_OccluderPolygon2D: diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index 05db18e9d..fa90522d4 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the OmniLight.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_OmniLight: @@ -36,6 +37,14 @@ Member Variables - :ref:`int` **omni_shadow_detail** - :ref:`int` **omni_shadow_mode** +Numeric Constants +----------------- + +- **SHADOW_DUAL_PARABOLOID** = **0** +- **SHADOW_CUBE** = **1** +- **SHADOW_DETAIL_VERTICAL** = **0** +- **SHADOW_DETAIL_HORIZONTAL** = **1** + Description ----------- diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 00d4b716b..d80f69509 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the OptionButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_OptionButton: diff --git a/classes/class_os.rst b/classes/class_os.rst index 0d5fae519..c26e3b09e 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the OS.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_OS: diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 8471921bd..8fc2b6979 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PackedDataContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PackedDataContainer: diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 7affe5b48..53d252e6c 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PackedDataContainerRef.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PackedDataContainerRef: diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index 036fa5546..7c25d7c51 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PackedScene.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PackedScene: diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index 11d4f11b8..36a387a8f 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PacketPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PacketPeer: diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 2e9cfa4fa..b45bcfa85 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PacketPeerStream.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PacketPeerStream: diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index ae4aad678..2b63b5bc8 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PacketPeerUDP.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PacketPeerUDP: diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 3ce84e6a7..9d995d307 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Panel.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Panel: diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index df8abd859..d3c6173f3 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PanelContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PanelContainer: diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst index 68f188869..dd53b2442 100644 --- a/classes/class_panoramasky.rst +++ b/classes/class_panoramasky.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PanoramaSky.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PanoramaSky: diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index d1a3c4a91..7b45a3282 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ParallaxBackground.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ParallaxBackground: diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index 81b44a74c..192d0ed8b 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ParallaxLayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ParallaxLayer: diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 53738e396..72a45ed18 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Particles.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Particles: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 45bbeef37..7bfe8be91 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Particles2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Particles2D: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index 58bc5519f..a2bc9c3b9 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ParticlesMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ParticlesMaterial: diff --git a/classes/class_path.rst b/classes/class_path.rst index 316ba5354..7a9e4cf78 100644 --- a/classes/class_path.rst +++ b/classes/class_path.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Path.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Path: diff --git a/classes/class_path2d.rst b/classes/class_path2d.rst index aec53f08f..423459177 100644 --- a/classes/class_path2d.rst +++ b/classes/class_path2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Path2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Path2D: diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index f86f61aee..a81881736 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PathFollow.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PathFollow: diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index cb727f7d2..908c3c407 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PathFollow2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PathFollow2D: diff --git a/classes/class_pckpacker.rst b/classes/class_pckpacker.rst index e83238087..19fbdf192 100644 --- a/classes/class_pckpacker.rst +++ b/classes/class_pckpacker.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PCKPacker.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PCKPacker: diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 01b6d2caf..70e175a6c 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Performance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Performance: diff --git a/classes/class_phashtranslation.rst b/classes/class_phashtranslation.rst index 88c1c705a..bbd47421d 100644 --- a/classes/class_phashtranslation.rst +++ b/classes/class_phashtranslation.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PHashTranslation.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PHashTranslation: diff --git a/classes/class_physics2ddirectbodystate.rst b/classes/class_physics2ddirectbodystate.rst index 81cf69595..bac49c9fe 100644 --- a/classes/class_physics2ddirectbodystate.rst +++ b/classes/class_physics2ddirectbodystate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DDirectBodyState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DDirectBodyState: @@ -20,61 +21,61 @@ Direct access object to a physics body in the :ref:`Physics2DServer` | :ref:`get_angular_velocity` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_pos` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_pos` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_contact_local_pos` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_inertia` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_total_gravity` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`float` velocity **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` velocity **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_velocity` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_contact_collider_shape_metadata` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_inertia` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_linear_velocity` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Physics2DDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_total_gravity` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`float` velocity **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector2` velocity **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform2D` transform **)** | ++--------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -108,9 +109,9 @@ Return the object id of the collider. 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_pos: +.. _class_Physics2DDirectBodyState_get_contact_collider_position: -- :ref:`Vector2` **get_contact_collider_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const Return the contact position in the collider. @@ -126,9 +127,9 @@ Return the collider shape index. 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_pos: +.. _class_Physics2DDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector2` **get_contact_collider_velocity_at_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const Return the linear velocity vector at contact point of the collider. @@ -144,9 +145,9 @@ Return the amount of contacts this body has with other bodies. Note that by defa Return the local normal (of this body) of the contact point. -.. _class_Physics2DDirectBodyState_get_contact_local_pos: +.. _class_Physics2DDirectBodyState_get_contact_local_position: -- :ref:`Vector2` **get_contact_local_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector2` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const Return the local position (of this body) of the contact point. diff --git a/classes/class_physics2ddirectbodystatesw.rst b/classes/class_physics2ddirectbodystatesw.rst index 7c3fab57a..003befbad 100644 --- a/classes/class_physics2ddirectbodystatesw.rst +++ b/classes/class_physics2ddirectbodystatesw.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DDirectBodyStateSW.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DDirectBodyStateSW: diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index fa689d1d7..6b72e06e4 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DDirectSpaceState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DDirectSpaceState: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index 606519c3f..7d5987f20 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DServer: @@ -73,7 +74,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ) **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** | +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -427,7 +428,7 @@ Add a shape to the body, along with a transform matrix. Shapes are usually refer .. _class_Physics2DServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` pos, :ref:`Vector2` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` position, :ref:`Vector2` impulse **)** Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. diff --git a/classes/class_physics2dserversw.rst b/classes/class_physics2dserversw.rst index eeecfb808..252ece95f 100644 --- a/classes/class_physics2dserversw.rst +++ b/classes/class_physics2dserversw.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DServerSW.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DServerSW: diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index ef3371df0..151002dd4 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DShapeQueryParameters.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DShapeQueryParameters: diff --git a/classes/class_physics2dshapequeryresult.rst b/classes/class_physics2dshapequeryresult.rst index d2a84b7de..958ec855c 100644 --- a/classes/class_physics2dshapequeryresult.rst +++ b/classes/class_physics2dshapequeryresult.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DShapeQueryResult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DShapeQueryResult: diff --git a/classes/class_physics2dtestmotionresult.rst b/classes/class_physics2dtestmotionresult.rst index d7eb51e48..f9cd36db6 100644 --- a/classes/class_physics2dtestmotionresult.rst +++ b/classes/class_physics2dtestmotionresult.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Physics2DTestMotionResult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Physics2DTestMotionResult: diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index ff08266d0..74de45f92 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsBody: @@ -15,7 +16,7 @@ PhysicsBody Brief Description ----------------- -Base class for different types of Physics bodies. +Base class for all objects affected by physics in 3D space. Member Functions ---------------- @@ -45,13 +46,15 @@ Member Functions Member Variables ---------------- -- :ref:`int` **collision_layer** -- :ref:`int` **collision_mask** +- :ref:`int` **collision_layer** - The physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + 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. +- :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. Description ----------- -PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. +PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it. Member Function Description --------------------------- @@ -60,7 +63,7 @@ Member Function Description - void **add_collision_exception_with** **(** :ref:`Node` body **)** -Adds a body to the collision exception list. This list contains bodies that this body will not collide with. +Adds a body to the list of bodies that this body can't collide with. .. _class_PhysicsBody_get_collision_layer: @@ -82,7 +85,7 @@ Adds a body to the collision exception list. This list contains bodies that this - void **remove_collision_exception_with** **(** :ref:`Node` body **)** -Removes a body from the collision exception list. +Removes a body from the list of bodies that this body can't collide with. .. _class_PhysicsBody_set_collision_layer: diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 8e5eaa25a..4c48d615f 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsBody2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsBody2D: @@ -15,7 +16,7 @@ PhysicsBody2D Brief Description ----------------- -Base class for all objects affected by physics. +Base class for all objects affected by physics in 2D space. Member Functions ---------------- @@ -45,9 +46,11 @@ Member Functions Member Variables ---------------- -- :ref:`int` **collision_layer** -- :ref:`int` **collision_mask** -- :ref:`int` **layers** +- :ref:`int` **collision_layer** - The physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + 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. +- :ref:`int` **collision_mask** - The physics layers this area can scan for collisions. +- :ref:`int` **layers** - Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. Description ----------- @@ -61,6 +64,8 @@ Member Function Description - 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: - :ref:`int` **get_collision_layer** **(** **)** const @@ -89,6 +94,8 @@ Return an individual bit on the collision mask. - 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: - void **set_collision_layer** **(** :ref:`int` layer **)** diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 9dc3fba7d..df29da0ba 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsDirectBodyState: @@ -20,80 +21,80 @@ Brief Description Member Functions ---------------- -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` pos **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` pos, :ref:`Vector3` j **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_torqe_impulse` **(** :ref:`Vector3` j **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_center_of_mass` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_pos` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_pos` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_count` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_contact_local_pos` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_inverse_inertia` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Basis` | :ref:`get_principal_inertia_axes` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_step` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_total_gravity` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`integrate_forces` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` velocity **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` velocity **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_force` **(** :ref:`Vector3` force, :ref:`Vector3` position **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` j **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`apply_torqe_impulse` **(** :ref:`Vector3` j **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_angular_velocity` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_center_of_mass` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_contact_collider` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_id` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_contact_collider_object` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_collider_shape` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_count` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_normal` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_contact_local_position` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_contact_local_shape` **(** :ref:`int` contact_idx **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_inverse_inertia` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_inverse_mass` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_linear_velocity` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`get_principal_inertia_axes` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_space_state` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_step` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_angular_damp` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_total_gravity` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_total_linear_damp` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`integrate_forces` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_sleeping` **(** **)** const | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_velocity` **(** :ref:`Vector3` velocity **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_velocity` **(** :ref:`Vector3` velocity **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sleep_state` **(** :ref:`bool` enabled **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` transform **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_PhysicsDirectBodyState_add_force: -- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` pos **)** +- void **add_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** .. _class_PhysicsDirectBodyState_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` pos, :ref:`Vector3` j **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` j **)** .. _class_PhysicsDirectBodyState_apply_torqe_impulse: @@ -119,17 +120,17 @@ Member Function Description - :ref:`Object` **get_contact_collider_object** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_pos: +.. _class_PhysicsDirectBodyState_get_contact_collider_position: -- :ref:`Vector3` **get_contact_collider_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_collider_shape: - :ref:`int` **get_contact_collider_shape** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_pos: +.. _class_PhysicsDirectBodyState_get_contact_collider_velocity_at_position: -- :ref:`Vector3` **get_contact_collider_velocity_at_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_count: @@ -139,9 +140,9 @@ Member Function Description - :ref:`Vector3` **get_contact_local_normal** **(** :ref:`int` contact_idx **)** const -.. _class_PhysicsDirectBodyState_get_contact_local_pos: +.. _class_PhysicsDirectBodyState_get_contact_local_position: -- :ref:`Vector3` **get_contact_local_pos** **(** :ref:`int` contact_idx **)** const +- :ref:`Vector3` **get_contact_local_position** **(** :ref:`int` contact_idx **)** const .. _class_PhysicsDirectBodyState_get_contact_local_shape: diff --git a/classes/class_physicsdirectbodystatesw.rst b/classes/class_physicsdirectbodystatesw.rst index d49072d25..892aa8dd6 100644 --- a/classes/class_physicsdirectbodystatesw.rst +++ b/classes/class_physicsdirectbodystatesw.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsDirectBodyStateSW.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsDirectBodyStateSW: diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index f80cb393e..ed1840897 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsDirectSpaceState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsDirectSpaceState: diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 91423da44..368e4e24f 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsServer: @@ -73,7 +74,7 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform` transform=Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** | +| void | :ref:`body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`Vector3` impulse **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -335,6 +336,18 @@ Numeric Constants - **INFO_ACTIVE_OBJECTS** = **0** - **INFO_COLLISION_PAIRS** = **1** - **INFO_ISLAND_COUNT** = **2** +- **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** +- **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** +- **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** +- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** +- **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO** = **6** +- **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **7** +- **BODY_AXIS_LOCK_DISABLED** = **0** +- **BODY_AXIS_LOCK_X** = **1** +- **BODY_AXIS_LOCK_Y** = **2** +- **BODY_AXIS_LOCK_Z** = **3** Member Function Description --------------------------- @@ -445,7 +458,7 @@ Member Function Description .. _class_PhysicsServer_body_apply_impulse: -- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` pos, :ref:`Vector3` impulse **)** +- void **body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` position, :ref:`Vector3` impulse **)** .. _class_PhysicsServer_body_apply_torque_impulse: diff --git a/classes/class_physicsserversw.rst b/classes/class_physicsserversw.rst index 74c704a26..9c5169ef5 100644 --- a/classes/class_physicsserversw.rst +++ b/classes/class_physicsserversw.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsServerSW.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsServerSW: diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 0280b819e..7ccaf615a 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsShapeQueryParameters.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsShapeQueryParameters: diff --git a/classes/class_physicsshapequeryresult.rst b/classes/class_physicsshapequeryresult.rst index 67b8a8bdc..7d22c392e 100644 --- a/classes/class_physicsshapequeryresult.rst +++ b/classes/class_physicsshapequeryresult.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PhysicsShapeQueryResult.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PhysicsShapeQueryResult: diff --git a/classes/class_pinjoint.rst b/classes/class_pinjoint.rst index 1937508e0..02cef4181 100644 --- a/classes/class_pinjoint.rst +++ b/classes/class_pinjoint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PinJoint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PinJoint: diff --git a/classes/class_pinjoint2d.rst b/classes/class_pinjoint2d.rst index 8cc75ce2f..8be8ae64f 100644 --- a/classes/class_pinjoint2d.rst +++ b/classes/class_pinjoint2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PinJoint2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PinJoint2D: diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 027c3fba4..8754a846f 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Plane.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Plane: diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst index 215f91539..a43590652 100644 --- a/classes/class_planemesh.rst +++ b/classes/class_planemesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PlaneMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PlaneMesh: @@ -13,7 +14,7 @@ PlaneMesh Brief Description ----------------- - +Class representing a planar :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -35,9 +36,14 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **size** -- :ref:`int` **subdivide_depth** -- :ref:`int` **subdivide_width** +- :ref:`Vector2` **size** - Size of the generated plane. Defaults to (2.0, 2.0). +- :ref:`int` **subdivide_depth** - Number of subdivision along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_width** - Number of subdivision along the x-axis. Defaults to 0. + +Description +----------- + +Class representing a planar :ref:`PrimitiveMesh`. This flat mesh does not have a thickness. Member Function Description --------------------------- diff --git a/classes/class_planeshape.rst b/classes/class_planeshape.rst index d6174eb63..a46730e91 100644 --- a/classes/class_planeshape.rst +++ b/classes/class_planeshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PlaneShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PlaneShape: diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index c6db91a93..0a827ae46 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Polygon2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Polygon2D: diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 8d9bb610c..6a58cb178 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PolygonPathFinder.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PolygonPathFinder: diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index 1aed4a460..b14b826fb 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolByteArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolByteArray: @@ -66,35 +67,37 @@ Create from a generic array. - void **append** **(** :ref:`int` byte **)** +Append an element at the end of the array (alias of :ref:`push_back`). + .. _class_PoolByteArray_append_array: - void **append_array** **(** :ref:`PoolByteArray` array **)** -Append an :ref:`PoolByteArray` at the end of this array. +Append a :ref:`PoolByteArray` at the end of this array. .. _class_PoolByteArray_compress: - :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** -Returns a new :ref:`PoolByteArray` with the data compressed. The compression mode can be set using one of the COMPRESS\_\* constants of :ref:`File`. +Returns a new :ref:`PoolByteArray` with the data compressed. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_decompress: - :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** -Returns a new :ref:`PoolByteArray` with the data decompressed. The buffer_size should be set as the size of the uncompressed data. The compression mode can be set using one of the COMPRESS\_\* constants of :ref:`File`. +Returns a new :ref:`PoolByteArray` with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of :ref:`File`'s COMPRESS\_\* constants. .. _class_PoolByteArray_get_string_from_ascii: - :ref:`String` **get_string_from_ascii** **(** **)** -Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). +Returns a copy of the array's contents as :ref:`String`. Fast alternative to :ref:`PoolByteArray.get_string_from_utf8` if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use :ref:`PoolByteArray.get_string_from_utf8`. .. _class_PoolByteArray_get_string_from_utf8: - :ref:`String` **get_string_from_utf8** **(** **)** -Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. +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: @@ -124,7 +127,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the :ref:`PoolByteArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_poolcolorarray.rst b/classes/class_poolcolorarray.rst index 64252f67f..636855318 100644 --- a/classes/class_poolcolorarray.rst +++ b/classes/class_poolcolorarray.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolColorArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolColorArray: @@ -41,7 +42,7 @@ Member Functions Description ----------- -Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. +Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. Member Function Description --------------------------- @@ -62,7 +63,7 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** -Append an :ref:`PoolColorArray` at the end of this array. +Append a :ref:`PoolColorArray` at the end of this array. .. _class_PoolColorArray_insert: @@ -92,7 +93,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the :ref:`PoolColorArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: @@ -104,6 +105,6 @@ Change the :ref:`Color` at the given index. - :ref:`int` **size** **(** **)** -Return the array size. +Return the size of the array. diff --git a/classes/class_poolintarray.rst b/classes/class_poolintarray.rst index 781b1104e..5b9f7caec 100644 --- a/classes/class_poolintarray.rst +++ b/classes/class_poolintarray.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolIntArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolIntArray: @@ -41,7 +42,7 @@ Member Functions Description ----------- -Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. +Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. Member Function Description --------------------------- @@ -92,7 +93,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the :ref:`PoolIntArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 9fc18cc75..4991e1f75 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolRealArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolRealArray: @@ -92,7 +93,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the RealArray. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 30bfe115b..da5363893 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolStringArray.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolStringArray: @@ -27,7 +28,7 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`invert` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`join` **(** :ref:`String` string **)** | +| :ref:`String` | :ref:`join` **(** :ref:`String` delimiter **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`push_back` **(** :ref:`String` string **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -76,11 +77,13 @@ Insert a new element at a given position in the array. The position must be vali - void **invert** **(** **)** +Reverse the order of the elements in the array (so first element will now be the last). + .. _class_PoolStringArray_join: -- :ref:`String` **join** **(** :ref:`String` string **)** +- :ref:`String` **join** **(** :ref:`String` delimiter **)** -Reverse the order of the elements in the array (so first element will now be the last). +Returns a :ref:`String` with each element of the array joined with the delimiter. .. _class_PoolStringArray_push_back: @@ -98,7 +101,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the StringArray. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_poolvector2array.rst b/classes/class_poolvector2array.rst index 00fa0f194..8158fb778 100644 --- a/classes/class_poolvector2array.rst +++ b/classes/class_poolvector2array.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolVector2Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolVector2Array: @@ -92,7 +93,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the PoolVector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_poolvector3array.rst b/classes/class_poolvector3array.rst index 402f6fa54..359577d33 100644 --- a/classes/class_poolvector3array.rst +++ b/classes/class_poolvector3array.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PoolVector3Array.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PoolVector3Array: @@ -80,7 +81,7 @@ Reverse the order of the elements in the array (so first element will now be the - void **push_back** **(** :ref:`Vector3` vector3 **)** -Insert a Vector3 at the end. +Insert a :ref:`Vector3` at the end. .. _class_PoolVector3Array_remove: @@ -92,7 +93,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the PoolVector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +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: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index aabaa3594..4214c109d 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Popup.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Popup: diff --git a/classes/class_popupdialog.rst b/classes/class_popupdialog.rst index ba21eefb9..6a5b8aea3 100644 --- a/classes/class_popupdialog.rst +++ b/classes/class_popupdialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PopupDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PopupDialog: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index bf0a62fe2..1636c7a35 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PopupMenu.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PopupMenu: diff --git a/classes/class_popuppanel.rst b/classes/class_popuppanel.rst index 270b19363..3ba5baf0e 100644 --- a/classes/class_popuppanel.rst +++ b/classes/class_popuppanel.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PopupPanel.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PopupPanel: diff --git a/classes/class_position2d.rst b/classes/class_position2d.rst index c4cb173b2..e1c0bf509 100644 --- a/classes/class_position2d.rst +++ b/classes/class_position2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Position2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Position2D: diff --git a/classes/class_position3d.rst b/classes/class_position3d.rst index c41ed796a..7edfe8639 100644 --- a/classes/class_position3d.rst +++ b/classes/class_position3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Position3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Position3D: diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index b39041320..6c555c3bf 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PrimitiveMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PrimitiveMesh: @@ -15,7 +16,7 @@ PrimitiveMesh Brief Description ----------------- - +Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. Member Functions ---------------- @@ -23,13 +24,20 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_material` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_mesh_arrays` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_material` **(** :ref:`Material` material **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`Material` **material** +- :ref:`Material` **material** - The current [Material] of the primitive mesh. + +Description +----------- + +Base class for all primitive meshes. Handles applying a :ref:`Material` to a primitive mesh. Member Function Description --------------------------- @@ -38,6 +46,10 @@ Member Function Description - :ref:`Material` **get_material** **(** **)** const +.. _class_PrimitiveMesh_get_mesh_arrays: + +- :ref:`Array` **get_mesh_arrays** **(** **)** const + .. _class_PrimitiveMesh_set_material: - void **set_material** **(** :ref:`Material` material **)** diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst index 1f3200ca5..6a2e9fa3e 100644 --- a/classes/class_prismmesh.rst +++ b/classes/class_prismmesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the PrismMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_PrismMesh: @@ -13,7 +14,7 @@ PrismMesh Brief Description ----------------- - +Class representing a prism-shaped :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -43,11 +44,16 @@ Member Functions Member Variables ---------------- -- :ref:`float` **left_to_right** -- :ref:`Vector3` **size** -- :ref:`int` **subdivide_depth** -- :ref:`int` **subdivide_height** -- :ref:`int` **subdivide_width** +- :ref:`float` **left_to_right** - Displacement of 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). +- :ref:`Vector3` **size** - Size of the prism. Defaults to (2.0, 2.0, 2.0). +- :ref:`int` **subdivide_depth** - Number of added edge loops along the z-axis. Defaults to 0. +- :ref:`int` **subdivide_height** - Number of added edge loops along the y-axis. Defaults to 0. +- :ref:`int` **subdivide_width** - Number of added edge loops along the x-axis. Defaults to 0. + +Description +----------- + +Class representing a prism-shaped :ref:`PrimitiveMesh`. Member Function Description --------------------------- diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst index 024a58c32..4300af077 100644 --- a/classes/class_proceduralsky.rst +++ b/classes/class_proceduralsky.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ProceduralSky.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ProceduralSky: diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index a70d50509..c6ef96ddc 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ProgressBar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ProgressBar: diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 12624a59e..4ee663db5 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ProjectSettings.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ProjectSettings: @@ -47,7 +48,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` pos **)** | +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` position **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -143,7 +144,7 @@ Convert a path to a localized path (res:// path). .. _class_ProjectSettings_set_order: -- void **set_order** **(** :ref:`String` name, :ref:`int` pos **)** +- void **set_order** **(** :ref:`String` name, :ref:`int` position **)** Set the order of a configuration value (influences when saved to the config file). diff --git a/classes/class_proximitygroup.rst b/classes/class_proximitygroup.rst index cb69cbe95..3c2c79f6d 100644 --- a/classes/class_proximitygroup.rst +++ b/classes/class_proximitygroup.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ProximityGroup.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ProximityGroup: diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index d08ab2634..cfdf4787c 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the QuadMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_QuadMesh: @@ -13,5 +14,10 @@ QuadMesh Brief Description ----------------- +Class representing a square mesh. +Description +----------- + +Class representing a square mesh with size (2,2,0). Consider using a :ref:`PlaneMesh` if you require a differently sized plane. diff --git a/classes/class_quat.rst b/classes/class_quat.rst index bff251afa..355be276b 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Quat.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Quat: diff --git a/classes/class_range.rst b/classes/class_range.rst index f5599f17f..85d7397c8 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Range.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Range: diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index bc55f061a..8cc9bc0b6 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RayCast.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RayCast: @@ -61,23 +62,27 @@ Member Functions Member Variables ---------------- -- :ref:`Vector3` **cast_to** -- :ref:`int` **collision_layer** -- :ref:`bool` **enabled** -- :ref:`int` **type_mask** +- :ref:`Vector3` **cast_to** - The ray's destination point, relative to the RayCast's [code]position[/code]. +- :ref:`int` **collision_layer** - The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected. +- :ref:`bool` **enabled** - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. +- :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. + Example: + [codeblock] + RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY + [/codeblock] Description ----------- -A RayCast represents a line from its origin to its destination position ``cast_to``, it is used to query the 3D space in order to find the closest object intersecting with the ray. +A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 3D space in order to find the closest object along the path of the ray. -RayCast can ignore some objects by adding them to the exception list via ``add_exception``, setting proper filtering with layers, or by filtering object types with type masks. +RayCast can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. -Only enabled raycasts will be able to query the space and report collisions! +Only enabled raycasts will be able to query the space and report collisions. @@ -90,23 +95,27 @@ Member Function Description - void **add_exception** **(** :ref:`Object` node **)** -Adds a collision exception so the ray does not report collisions with the specified ``node``. +Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** +Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. + .. _class_RayCast_clear_exceptions: - void **clear_exceptions** **(** **)** -Removes all collision exception for this ray. +Removes all collision exceptions for this ray. .. _class_RayCast_force_raycast_update: - void **force_raycast_update** **(** **)** -Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, ``set_enabled`` is not required for this to work. +Updates the collision information for the ray. + +Use this method to update the collision information immediately instead of waiting for the next ``_fixed_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_cast_to: @@ -118,13 +127,27 @@ Return the destination point of this ray object. - :ref:`Object` **get_collider** **(** **)** const -Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. +Return the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. + +Example: + +:: + + if RayCast.is_colliding(): + var collider = RayCast.get_collider() .. _class_RayCast_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const -Returns the collision shape of the closest object the ray is pointing to. +Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. + +Example: + +:: + + if RayCast.is_colliding(): + var shape = RayCast.get_collider_shape() .. _class_RayCast_get_collision_layer: @@ -136,13 +159,13 @@ Returns the collision layer for this ray. - :ref:`Vector3` **get_collision_normal** **(** **)** const -Returns the normal of the intersecting object shape face containing the collision point. +Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast_get_collision_point: - :ref:`Vector3` **get_collision_point** **(** **)** const -Returns collision point. This point is in **global** coordinate system. +Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. .. _class_RayCast_get_type_mask: @@ -160,23 +183,25 @@ Return whether the closest object the ray is pointing to is colliding with the v - :ref:`bool` **is_enabled** **(** **)** const -Returns whether this raycast is enabled or not. +Returns whether the ray is enabled or not. .. _class_RayCast_remove_exception: - void **remove_exception** **(** :ref:`Object` node **)** -Removes a collision exception so the ray does report collisions with the specified ``node``. +Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** +Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. + .. _class_RayCast_set_cast_to: - void **set_cast_to** **(** :ref:`Vector3` local_point **)** -Sets to which point ray should be casted. This point is in **local** coordinate system. +Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point``. .. _class_RayCast_set_collision_layer: diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 0fa709464..427131a34 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RayCast2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RayCast2D: @@ -65,26 +66,24 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **cast_to** -- :ref:`int` **collision_layer** -- :ref:`bool` **enabled** -- :ref:`bool` **exclude_parent** -- :ref:`int` **type_mask** +- :ref:`Vector2` **cast_to** - The ray's destination point, relative to the RayCast's [code]position[/code]. +- :ref:`int` **collision_layer** - The RayCast2D's collison layer(s). Only bodies in the same collision layer(s) will be detected. +- :ref:`bool` **enabled** - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. +- :ref:`bool` **exclude_parent** - If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code]. +- :ref:`int` **type_mask** - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. + Example: + [codeblock] + RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY + [/codeblock] Description ----------- -A RayCast2D represents a line from its origin to its destination position ``cast_to``, it is used to query the 2D space in order to find the closest object intersecting with the ray. - - - -RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, setting proper filtering with layers, or by filtering object types with type masks. - - - -Only enabled raycasts will be able to query the space and report collisions! +A RayCast represents a line from its origin to its destination position, ``cast_to``. It is used to query the 2D space in order to find the closest object along the path of the ray. +RayCast2D can ignore some objects by adding them to the exception list via ``add_exception``, by setting proper filtering with collision layers, or by filtering object types with type masks. +Only enabled raycasts will be able to query the space and report collisions. RayCast2D calculates intersection every fixed frame (see :ref:`Node`), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use :ref:`force_raycast_update` after adjusting the raycast. @@ -95,23 +94,25 @@ Member Function Description - void **add_exception** **(** :ref:`Object` node **)** -Adds a collision exception so the ray does not report collisions with the specified ``node``. +Adds a collision exception so the ray does not report collisions with the specified node. .. _class_RayCast2D_add_exception_rid: - void **add_exception_rid** **(** :ref:`RID` rid **)** +Adds a collision exception so the ray does not report collisions with the specified :ref:`RID`. + .. _class_RayCast2D_clear_exceptions: - void **clear_exceptions** **(** **)** -Removes all collision exception for this ray. +Removes all collision exceptions for this ray. .. _class_RayCast2D_force_raycast_update: - void **force_raycast_update** **(** **)** -Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, ``set_enabled`` is not required for this to work. +Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next ``_fixed_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_cast_to: @@ -123,13 +124,27 @@ Return the destination point of this ray object. - :ref:`Object` **get_collider** **(** **)** const -Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. +Returns the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. + +Example: + +:: + + if RayCast2D.is_colliding(): + var collider = RayCast2D.get_collider() .. _class_RayCast2D_get_collider_shape: - :ref:`int` **get_collider_shape** **(** **)** const -Returns the collision shape of the closest object the ray is pointing to. +Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use :ref:`is_colliding` to check if the object returned is actually colliding with the ray. + +Example: + +:: + + if RayCast2D.is_colliding(): + var shape = RayCast2D.get_collider_shape() .. _class_RayCast2D_get_collision_layer: @@ -141,13 +156,13 @@ Returns the collision layer for this ray. - :ref:`Vector2` **get_collision_normal** **(** **)** const -Returns the normal of the intersecting object shape face containing the collision point. +Returns the normal of the intersecting object's shape at the collision point. .. _class_RayCast2D_get_collision_point: - :ref:`Vector2` **get_collision_point** **(** **)** const -Returns the collision point in which the ray intersects the closest object. This point is in **global** coordinate system. +Returns the collision point at which the ray intersects the closest object. Note: this point is in the **global** coordinate system. .. _class_RayCast2D_get_exclude_parent_body: @@ -177,12 +192,14 @@ Returns whether this raycast is enabled or not. - void **remove_exception** **(** :ref:`Object` node **)** -Removes a collision exception so the ray does report collisions with the specified ``node``. +Removes a collision exception so the ray does report collisions with the specified node. .. _class_RayCast2D_remove_exception_rid: - void **remove_exception_rid** **(** :ref:`RID` rid **)** +Removes a collision exception so the ray does report collisions with the specified :ref:`RID`. + .. _class_RayCast2D_set_cast_to: - void **set_cast_to** **(** :ref:`Vector2` local_point **)** diff --git a/classes/class_rayshape.rst b/classes/class_rayshape.rst index bcd2b3095..c5b71d615 100644 --- a/classes/class_rayshape.rst +++ b/classes/class_rayshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RayShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RayShape: diff --git a/classes/class_rayshape2d.rst b/classes/class_rayshape2d.rst index d43eebd71..23161045a 100644 --- a/classes/class_rayshape2d.rst +++ b/classes/class_rayshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RayShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RayShape2D: @@ -13,7 +14,7 @@ RayShape2D Brief Description ----------------- -Ray 2D shape resource for physics. +Ray shape for 2D collisions. Member Functions ---------------- @@ -27,12 +28,12 @@ Member Functions Member Variables ---------------- -- :ref:`float` **length** +- :ref:`float` **length** - The ray's length. Description ----------- -Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. +Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. Member Function Description --------------------------- diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index e5c667a6d..c5ef957d8 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Rect2.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Rect2: @@ -17,7 +18,7 @@ Member Functions ---------------- +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` pos, :ref:`Vector2` size **)** | +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` position, :ref:`Vector2` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +62,7 @@ Member Function Description .. _class_Rect2_Rect2: -- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` pos, :ref:`Vector2` size **)** +- :ref:`Rect2` **Rect2** **(** :ref:`Vector2` position, :ref:`Vector2` size **)** Construct a :ref:`Rect2` by position and size. diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst index aaf38c553..c809a66a4 100644 --- a/classes/class_rect3.rst +++ b/classes/class_rect3.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Rect3.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Rect3: @@ -17,7 +18,7 @@ Member Functions ---------------- +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** | +| :ref:`Rect3` | :ref:`Rect3` **(** :ref:`Vector3` position, :ref:`Vector3` size **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`encloses` **(** :ref:`Rect3` with **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,7 +78,7 @@ Member Function Description .. _class_Rect3_Rect3: -- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` pos, :ref:`Vector3` size **)** +- :ref:`Rect3` **Rect3** **(** :ref:`Vector3` position, :ref:`Vector3` size **)** Optional constructor, accepts position and size. diff --git a/classes/class_rectangleshape2d.rst b/classes/class_rectangleshape2d.rst index 2c541bec6..aceb2c11f 100644 --- a/classes/class_rectangleshape2d.rst +++ b/classes/class_rectangleshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RectangleShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RectangleShape2D: @@ -13,7 +14,7 @@ RectangleShape2D Brief Description ----------------- -Rectangle Shape for 2D Physics. +Rectangle shape for 2D collisions. Member Functions ---------------- @@ -27,12 +28,12 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **extents** +- :ref:`Vector2` **extents** - The rectangle's half extents. The width and height of this shape is twice the half extents. Description ----------- -Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects. +Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects. Member Function Description --------------------------- diff --git a/classes/class_reference.rst b/classes/class_reference.rst index c3f0bc131..7aca05367 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Reference.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Reference: @@ -8,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`KinematicCollision`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`EncodedObjectAsID`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`GDFunctionState`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`SurfaceTool`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`RegEx`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core @@ -23,7 +24,7 @@ Member Functions +--------------------------+--------------------------------------------------------------+ | :ref:`bool` | :ref:`init_ref` **(** **)** | +--------------------------+--------------------------------------------------------------+ -| void | :ref:`reference` **(** **)** | +| :ref:`bool` | :ref:`reference` **(** **)** | +--------------------------+--------------------------------------------------------------+ | :ref:`bool` | :ref:`unreference` **(** **)** | +--------------------------+--------------------------------------------------------------+ @@ -42,7 +43,7 @@ Member Function Description .. _class_Reference_reference: -- void **reference** **(** **)** +- :ref:`bool` **reference** **(** **)** Increase the internal reference counter. Use this only if you really know what you are doing. diff --git a/classes/class_referencerect.rst b/classes/class_referencerect.rst index 4ddb1813d..3f563eaa2 100644 --- a/classes/class_referencerect.rst +++ b/classes/class_referencerect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ReferenceRect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ReferenceRect: diff --git a/classes/class_reflectionprobe.rst b/classes/class_reflectionprobe.rst index 65194e08c..e24c855e8 100644 --- a/classes/class_reflectionprobe.rst +++ b/classes/class_reflectionprobe.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ReflectionProbe.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ReflectionProbe: diff --git a/classes/class_regex.rst b/classes/class_regex.rst index 7573cf0b7..8a0ddf869 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RegEx.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RegEx: diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index b022dc534..10ee944ae 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RegExMatch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RegExMatch: diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 09b7e0745..7e09f47df 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RemoteTransform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RemoteTransform: diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index 13732f105..12f28bb40 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RemoteTransform2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RemoteTransform2D: diff --git a/classes/class_resource.rst b/classes/class_resource.rst index aaef19aa5..2bc89f5e2 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Resource.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Resource: @@ -8,7 +9,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core diff --git a/classes/class_resourceimporter.rst b/classes/class_resourceimporter.rst index 8f29a5495..6505477ab 100644 --- a/classes/class_resourceimporter.rst +++ b/classes/class_resourceimporter.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourceImporter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourceImporter: diff --git a/classes/class_resourceimporteroggvorbis.rst b/classes/class_resourceimporteroggvorbis.rst index 1cfc996cc..a86285211 100644 --- a/classes/class_resourceimporteroggvorbis.rst +++ b/classes/class_resourceimporteroggvorbis.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourceImporterOGGVorbis.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourceImporterOGGVorbis: diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 9ce7eebfa..b17a5d136 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourceInteractiveLoader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourceInteractiveLoader: diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index 98f4c2efd..674106848 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourceLoader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourceLoader: diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index c4708d005..dda0983cc 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourcePreloader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourcePreloader: diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 7810602c5..d0f3ec7a4 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ResourceSaver.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ResourceSaver: diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 107fba7f3..17f89c5f2 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RichTextLabel.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RichTextLabel: @@ -29,6 +30,8 @@ Member Functions +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_bbcode` **(** **)** const | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_line_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_percent_visible` **(** **)** const | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tab_size` **(** **)** const | @@ -41,6 +44,8 @@ Member Functions +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_visible_characters` **(** **)** const | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_line_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | +--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | @@ -165,6 +170,10 @@ Member Function Description - :ref:`String` **get_bbcode** **(** **)** const +.. _class_RichTextLabel_get_line_count: + +- :ref:`int` **get_line_count** **(** **)** const + .. _class_RichTextLabel_get_percent_visible: - :ref:`float` **get_percent_visible** **(** **)** const @@ -191,6 +200,10 @@ Returns the raw text, stripping out the formatting information. - :ref:`int` **get_visible_characters** **(** **)** const +.. _class_RichTextLabel_get_visible_line_count: + +- :ref:`int` **get_visible_line_count** **(** **)** const + .. _class_RichTextLabel_is_meta_underlined: - :ref:`bool` **is_meta_underlined** **(** **)** const diff --git a/classes/class_rid.rst b/classes/class_rid.rst index 6c879670a..50bebdea9 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RID.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RID: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index dafe1b78a..f233e510f 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RigidBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RigidBody: @@ -13,7 +14,7 @@ RigidBody Brief Description ----------------- -Rigid body node. +Physics Body whose position is determined through physics simulation in 3D space. Member Functions ---------------- @@ -21,7 +22,7 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_integrate_forces` **(** :ref:`PhysicsDirectBodyState` state **)** virtual | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`apply_impulse` **(** :ref:`Vector3` pos, :ref:`Vector3` impulse **)** | +| void | :ref:`apply_impulse` **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angular_damp` **(** **)** const | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,23 +123,24 @@ Emitted when the body changes its sleeping state. Either by sleeping or waking u Member Variables ---------------- -- :ref:`float` **angular_damp** -- :ref:`Vector3` **angular_velocity** -- :ref:`int` **axis_lock** -- :ref:`float` **bounce** -- :ref:`bool` **can_sleep** -- :ref:`bool` **contact_monitor** -- :ref:`int` **contacts_reported** -- :ref:`bool` **continuous_cd** -- :ref:`bool` **custom_integrator** -- :ref:`float` **friction** -- :ref:`float` **gravity_scale** -- :ref:`float` **linear_damp** -- :ref:`Vector3` **linear_velocity** -- :ref:`float` **mass** -- :ref:`int` **mode** -- :ref:`bool` **sleeping** -- :ref:`float` **weight** +- :ref:`float` **angular_damp** - Damps RigidBody's rotational forces. +- :ref:`Vector3` **angular_velocity** - RigidBody's rotational velocity. +- :ref:`int` **axis_lock** - Locks the rotational forces to a particular axis, preventing rotations on other axes. +- :ref:`float` **bounce** - RigidBody's bounciness. +- :ref:`bool` **can_sleep** - If [code]true[/code] 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 [code]apply_impulse[/code] method is used. +- :ref:`bool` **contact_monitor** - If true, the RigidBody will emit signals when it collides with another RigidBody. +- :ref:`int` **contacts_reported** - The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. +- :ref:`bool` **continuous_cd** - If [code]true[/code] 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. +- :ref:`bool` **custom_integrator** - If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. +- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (max friction). +- :ref:`float` **gravity_scale** - 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. +- :ref:`float` **linear_damp** - 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. +- :ref:`Vector3` **linear_velocity** - RigidBody's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. +- :ref:`float` **mass** - RigidBody's mass. +- :ref:`int` **mode** - The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. +- :ref:`bool` **sleeping** - If [code]true[/code] RigidBody is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. +- :ref:`float` **weight** - RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". Numeric Constants ----------------- @@ -147,11 +149,23 @@ Numeric Constants - **MODE_KINEMATIC** = **3** --- Kinematic body. The body behaves like a :ref:`KinematicBody`, and can only move by user code. - **MODE_RIGID** = **0** --- Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. - **MODE_CHARACTER** = **2** --- Character body. This behaves like a rigid body, but can not rotate. +- **AXIS_LOCK_DISABLED** = **0** +- **AXIS_LOCK_X** = **1** +- **AXIS_LOCK_Y** = **2** +- **AXIS_LOCK_Z** = **3** Description ----------- -Rigid body node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift mode between regular Rigid body, Kinematic, Character or Static. +This is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. + +This node can use custom force integration, for writing complex physics motion behavior per node. + +This node can shift state between regular Rigid body, Kinematic, Character or Static. + +Character mode forbids this node from being rotated. + +As a warning, don't change RigidBody's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. Member Function Description --------------------------- @@ -164,7 +178,7 @@ Called during physics processing, allowing you to read and safely modify the sim .. _class_RigidBody_apply_impulse: -- void **apply_impulse** **(** :ref:`Vector3` pos, :ref:`Vector3` impulse **)** +- void **apply_impulse** **(** :ref:`Vector3` position, :ref:`Vector3` impulse **)** Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 72964c72b..8e167268e 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the RigidBody2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_RigidBody2D: @@ -13,7 +14,7 @@ RigidBody2D Brief Description ----------------- -Rigid body 2D node. +Physics Body whose position is determined through physics simulation in 2D space. Member Functions ---------------- @@ -134,22 +135,23 @@ Emitted when the body changes its sleeping state. Either by sleeping or waking u Member Variables ---------------- -- :ref:`float` **angular_damp** -- :ref:`float` **angular_velocity** -- :ref:`float` **bounce** -- :ref:`bool` **can_sleep** -- :ref:`bool` **contact_monitor** -- :ref:`int` **contacts_reported** -- :ref:`int` **continuous_cd** -- :ref:`bool` **custom_integrator** -- :ref:`float` **friction** -- :ref:`float` **gravity_scale** -- :ref:`float` **linear_damp** -- :ref:`Vector2` **linear_velocity** -- :ref:`float` **mass** -- :ref:`int` **mode** -- :ref:`bool` **sleeping** -- :ref:`float` **weight** +- :ref:`float` **angular_damp** - Damps RigidBody2D's rotational forces. +- :ref:`float` **angular_velocity** - RigidBody2D's rotational velocity. +- :ref:`float` **bounce** - RigidBody2D's bounciness. +- :ref:`bool` **can_sleep** - If [code]true[/code] RigidBody2D will not calculate forces and will act as a static body while there is no movement. It will wake up when other forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. Default value: [code]true[/code] +- :ref:`bool` **contact_monitor** - If [code]true[/code] RigidBody2D will emit signals when it collides with another RigidBody2D. +- :ref:`int` **contacts_reported** - The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. +- :ref:`int` **continuous_cd** - If [code]true[/code] continuous collision detection is used. Default value: [code]false[/code] + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. +- :ref:`bool` **custom_integrator** - If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. +- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (max friction). +- :ref:`float` **gravity_scale** - This is multiplied by the global 2D gravity setting found in "Project > Project Settings > Physics > 2d" to produce RigidBody2D's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. +- :ref:`float` **linear_damp** - RigidBody2D's linear damp. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. +- :ref:`Vector2` **linear_velocity** - RigidBody2D's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. +- :ref:`float` **mass** - RigidBody2D's mass. +- :ref:`int` **mode** - The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. +- :ref:`bool` **sleeping** - If [code]true[/code] RigidBody2D is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. +- :ref:`float` **weight** - RigidBody2D's weight based on its mass and the global 2D gravity. Global values are set in "Project > Project Settings > Physics > 2d". Numeric Constants ----------------- @@ -165,11 +167,15 @@ Numeric Constants Description ----------- -Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. +This is the node that implements full 2D physics. This means that you do not control a RigidBody2D directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. -Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. +This node can use custom force integration, for writing complex physics motion behavior per node. -As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. +This node can shift state between regular Rigid body, Kinematic, Character or Static. + +Character mode forbids this node from being rotated. + +As a warning, don't change RigidBody2D's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. Member Function Description --------------------------- diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index e047f5370..a3507f0b6 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SceneState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SceneState: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index e64741176..2387190f4 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SceneTree.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SceneTree: diff --git a/classes/class_scenetreetimer.rst b/classes/class_scenetreetimer.rst index a3e800f89..2611c4d0a 100644 --- a/classes/class_scenetreetimer.rst +++ b/classes/class_scenetreetimer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SceneTreeTimer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SceneTreeTimer: diff --git a/classes/class_script.rst b/classes/class_script.rst index e3ad07558..45f215c6e 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Script.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Script: @@ -15,7 +16,7 @@ Script Brief Description ----------------- -Base class for scripts. +A class stored as a resource. Member Functions ---------------- @@ -43,7 +44,9 @@ Member Functions Description ----------- -Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. +A class stored as a resource. The script exends the functionality of all objects that instance it. + +The 'new' method of a script subclass creates a new instance. :ref:`Object.set_script` extends an existing object, if that object's class matches one of the script's base classes. Member Function Description --------------------------- @@ -52,7 +55,7 @@ Member Function Description - :ref:`bool` **can_instance** **(** **)** const -Return true if this script can be instance (ie not a library). +Returns true if the script can be instanced. .. _class_Script_get_node_type: @@ -62,36 +65,42 @@ Return true if this script can be instance (ie not a library). - :ref:`String` **get_source_code** **(** **)** const -Return the script source code (if available). +Returns the script source code, or an empty string if source code is not available. .. _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: - :ref:`bool` **has_source_code** **(** **)** const -Return true if the script contains source code. +Returns true if the script contains non-empty source code. .. _class_Script_instance_has: - :ref:`bool` **instance_has** **(** :ref:`Object` base_object **)** const -Return true if a given object uses an instance of this script. +Returns true if 'base_object' is an instance of this script. .. _class_Script_is_tool: - :ref:`bool` **is_tool** **(** **)** const +Returns true if the script is a tool script. A tool script can run in the editor. + .. _class_Script_reload: - :ref:`int` **reload** **(** :ref:`bool` keep_state=false **)** +Reloads the script's class implementation. Returns an error code. + .. _class_Script_set_source_code: - void **set_source_code** **(** :ref:`String` source **)** -Set the script source code. +Sets the script source code. Does not reload the class implementation. diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst index 0802e9e04..9891a56b1 100644 --- a/classes/class_scripteditor.rst +++ b/classes/class_scripteditor.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ScriptEditor.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ScriptEditor: diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index bd9de0d1e..65e5b25e2 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ScrollBar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ScrollBar: diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 9cf95653e..524719d5b 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ScrollContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ScrollContainer: diff --git a/classes/class_segmentshape2d.rst b/classes/class_segmentshape2d.rst index e9dee34ab..15f9ffb9e 100644 --- a/classes/class_segmentshape2d.rst +++ b/classes/class_segmentshape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SegmentShape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SegmentShape2D: @@ -13,7 +14,7 @@ SegmentShape2D Brief Description ----------------- -Segment Shape for 2D Collision Detection. +Segment shape for 2D collisions. Member Functions ---------------- @@ -31,13 +32,13 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **a** -- :ref:`Vector2` **b** +- :ref:`Vector2` **a** - The segment's first point position. +- :ref:`Vector2` **b** - The segment's second point position. Description ----------- -Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. +Segment shape for 2D collisions. Consists of two points, ``a`` and ``b``. Member Function Description --------------------------- diff --git a/classes/class_semaphore.rst b/classes/class_semaphore.rst index 0a4b96633..73ef15f44 100644 --- a/classes/class_semaphore.rst +++ b/classes/class_semaphore.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Semaphore.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Semaphore: diff --git a/classes/class_separator.rst b/classes/class_separator.rst index c285ab758..5855a7ada 100644 --- a/classes/class_separator.rst +++ b/classes/class_separator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Separator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Separator: diff --git a/classes/class_shader.rst b/classes/class_shader.rst index 71c5dbd46..6a5fb3fd1 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Shader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Shader: diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 8b4928f9e..ad2c56967 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ShaderMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ShaderMaterial: diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 7d9e354de..f4cbfc8c4 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Shape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Shape: @@ -8,7 +9,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`SphereShape`, :ref:`PlaneShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` +**Inherited By:** :ref:`PlaneShape`, :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` **Category:** Core diff --git a/classes/class_shape2d.rst b/classes/class_shape2d.rst index d7476b451..993502b46 100644 --- a/classes/class_shape2d.rst +++ b/classes/class_shape2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Shape2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Shape2D: @@ -8,7 +9,7 @@ Shape2D **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`RayShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`CircleShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` +**Inherited By:** :ref:`RayShape2D`, :ref:`CircleShape2D`, :ref:`CapsuleShape2D`, :ref:`LineShape2D`, :ref:`ConcavePolygonShape2D`, :ref:`ConvexPolygonShape2D`, :ref:`RectangleShape2D`, :ref:`SegmentShape2D` **Category:** Core diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index 7ab090ad0..40c96602a 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ShortCut.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ShortCut: diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index c9cf74158..be9ab41b5 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Skeleton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Skeleton: diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 179b54af2..1ffe2deb4 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Sky.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Sky: diff --git a/classes/class_slider.rst b/classes/class_slider.rst index f11e89efc..3e402abb1 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Slider.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Slider: diff --git a/classes/class_sliderjoint.rst b/classes/class_sliderjoint.rst index 330369f3f..da09f5355 100644 --- a/classes/class_sliderjoint.rst +++ b/classes/class_sliderjoint.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SliderJoint.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SliderJoint: diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 4ccc27cd7..0978cd4a4 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Spatial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Spatial: @@ -8,132 +9,136 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`ARVRController`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`ARVRAnchor`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`Listener`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton`, :ref:`ARVROrigin` **Category:** Core Brief Description ----------------- -Base class for all 3D nodes. +Most basic 3D game object, parent of all 3D related nodes. Member Functions ---------------- -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpatialGizmo` | :ref:`get_gizmo` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_rotation_deg` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_scale` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_transform` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_translation` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`World` | :ref:`get_world` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`look_at_from_pos` **(** :ref:`Vector3` pos, :ref:`Vector3` target, :ref:`Vector3` up **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`orthonormalize` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_x` **(** :ref:`float` radians **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_y` **(** :ref:`float` radians **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rotate_z` **(** :ref:`float` radians **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gizmo` **(** :ref:`SpatialGizmo` gizmo **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_identity` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation` **(** :ref:`Vector3` rotation_rad **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_rotation_deg` **(** :ref:`Vector3` rotation_deg **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_transform` **(** :ref:`Transform` local **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update_gizmo` **(** **)** | -+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpatialGizmo` | :ref:`get_gizmo` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_global_transform` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Spatial` | :ref:`get_parent_spatial` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_rotation` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_rotation_deg` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_scale` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_transform` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_translation` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`World` | :ref:`get_world` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_translate` **(** :ref:`Vector3` offset **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at` **(** :ref:`Vector3` target, :ref:`Vector3` up **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`look_at_from_position` **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`orthonormalize` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate` **(** :ref:`Vector3` normal, :ref:`float` radians **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_x` **(** :ref:`float` radians **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_y` **(** :ref:`float` radians **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rotate_z` **(** :ref:`float` radians **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gizmo` **(** :ref:`SpatialGizmo` gizmo **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_transform` **(** :ref:`Transform` global **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_identity` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ignore_transform_notification` **(** :ref:`bool` enabled **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation` **(** :ref:`Vector3` rotation_rad **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_deg` **(** :ref:`Vector3` rotation_deg **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_transform` **(** :ref:`Transform` local **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_translation` **(** :ref:`Vector3` translation **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` visible **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_global` **(** :ref:`Vector3` local_point **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`to_local` **(** :ref:`Vector3` global_point **)** const | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`translate` **(** :ref:`Vector3` offset **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_gizmo` **(** **)** | ++------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **visibility_changed** **(** **)** +Emitted when node visibility changes. + Member Variables ---------------- -- :ref:`Transform` **global_transform** -- :ref:`Vector3` **rotation** -- :ref:`Vector3` **rotation_deg** -- :ref:`Vector3` **scale** -- :ref:`Transform` **transform** -- :ref:`Vector3` **translation** -- :ref:`bool` **visible** +- :ref:`Transform` **global_transform** - World space (global) [Transform] of this node. +- :ref:`Vector3` **rotation** - Local euler rotation in radians of this node. +- :ref:`Vector3` **rotation_deg** - Local euler rotation in degrees of this node. +- :ref:`Vector3` **scale** - Local scale of this node. +- :ref:`Transform` **transform** - Local space [Transform] of this node. +- :ref:`Vector3` **translation** - Local translation of this node. +- :ref:`bool` **visible** - Visibility of this node. Toggles if this node is rendered. Numeric Constants ----------------- -- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. -- **NOTIFICATION_ENTER_WORLD** = **41** -- **NOTIFICATION_EXIT_WORLD** = **42** -- **NOTIFICATION_VISIBILITY_CHANGED** = **43** +- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. + +In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). +- **NOTIFICATION_ENTER_WORLD** = **41** --- Spatial nodes receives this notification when they are registered to new :ref:`World` resource. +- **NOTIFICATION_EXIT_WORLD** = **42** --- Spatial nodes receives this notification when they are unregistered from current :ref:`World` resource. +- **NOTIFICATION_VISIBILITY_CHANGED** = **43** --- Spatial nodes receives this notification when their visibility changes. Description ----------- -Spatial is the base for every type of 3D :ref:`Node`. It contains a 3D :ref:`Transform` which can be set or get as local or global. If a Spatial :ref:`Node` has Spatial children, their transforms will be relative to the parent. +Most basic 3D game object, with a 3D :ref:`Transform` and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. Member Function Description --------------------------- @@ -142,29 +147,31 @@ Member Function Description - :ref:`SpatialGizmo` **get_gizmo** **(** **)** const +Returns the SpatialGizmo for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. + .. _class_Spatial_get_global_transform: - :ref:`Transform` **get_global_transform** **(** **)** const -Return the global transform, relative to worldspace. +Returns the global transform, relative to worldspace. .. _class_Spatial_get_parent_spatial: - :ref:`Spatial` **get_parent_spatial** **(** **)** const -Return the parent :ref:`Spatial`, or an empty :ref:`Object` if no parent exists or parent is not of type :ref:`Spatial`. +Returns the parent :ref:`Spatial`, or an empty :ref:`Object` if no parent exists or parent is not of type :ref:`Spatial`. .. _class_Spatial_get_rotation: - :ref:`Vector3` **get_rotation** **(** **)** const -Return the rotation (in radians). +Returns the rotation (in radians). .. _class_Spatial_get_rotation_deg: - :ref:`Vector3` **get_rotation_deg** **(** **)** const -Return the rotation (in degrees). +Returns the rotation (in degrees). .. _class_Spatial_get_scale: @@ -174,7 +181,7 @@ Return the rotation (in degrees). - :ref:`Transform` **get_transform** **(** **)** const -Return the local transform, relative to the bone parent. +Returns the local transform, relative to the bone parent. .. _class_Spatial_get_translation: @@ -184,96 +191,140 @@ Return the local transform, relative to the bone parent. - :ref:`World` **get_world** **(** **)** const +Returns the current :ref:`World` resource this Spatial node is registered to. + .. _class_Spatial_global_rotate: - void **global_rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** +Rotates the current node along normal :ref:`Vector3` by angle in radians in Global space. + .. _class_Spatial_global_translate: - void **global_translate** **(** :ref:`Vector3` offset **)** +Moves the node by :ref:`Vector3` offset in Global space. + .. _class_Spatial_hide: - void **hide** **(** **)** +Disables rendering of this node. Change Spatial Visible property to false. + .. _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_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: - :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: - :ref:`bool` **is_visible** **(** **)** const +Returns whether the node is set to be visible. + .. _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: - void **look_at** **(** :ref:`Vector3` target, :ref:`Vector3` up **)** -.. _class_Spatial_look_at_from_pos: +Rotates itself to point into direction of target position. Operations take place in global space. -- void **look_at_from_pos** **(** :ref:`Vector3` pos, :ref:`Vector3` target, :ref:`Vector3` up **)** +.. _class_Spatial_look_at_from_position: + +- void **look_at_from_position** **(** :ref:`Vector3` position, :ref:`Vector3` target, :ref:`Vector3` up **)** + +Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space. .. _class_Spatial_orthonormalize: - void **orthonormalize** **(** **)** +Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node Transform3D. + .. _class_Spatial_rotate: - void **rotate** **(** :ref:`Vector3` normal, :ref:`float` radians **)** +Rotates the node in local space on given normal :ref:`Vector3` by angle in radians. + .. _class_Spatial_rotate_x: - void **rotate_x** **(** :ref:`float` radians **)** +Rotates the node in local space on X axis by angle in radians. + .. _class_Spatial_rotate_y: - void **rotate_y** **(** :ref:`float` radians **)** +Rotates the node in local space on Y axis by angle in radians. + .. _class_Spatial_rotate_z: - void **rotate_z** **(** :ref:`float` radians **)** +Rotates the node in local space on Z axis by angle in radians. + .. _class_Spatial_set_as_toplevel: - void **set_as_toplevel** **(** :ref:`bool` enable **)** +Makes the node ignore its parents tranformations. Node tranformations are only in global space. + .. _class_Spatial_set_gizmo: - void **set_gizmo** **(** :ref:`SpatialGizmo` gizmo **)** +Set :ref:`SpatialGizmo` for this node. Used for example in :ref:`EditorSpatialGizmo` as custom visualization and editing handles in Editor. + .. _class_Spatial_set_global_transform: - void **set_global_transform** **(** :ref:`Transform` global **)** -Set the transform globally, relative to worldspace. +Set the transform globally, relative to world space. .. _class_Spatial_set_identity: - void **set_identity** **(** **)** +Reset all tranformations for this node. Set its Transform3D to identity matrix. + .. _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: - 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: - 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_set_rotation: - void **set_rotation** **(** :ref:`Vector3` rotation_rad **)** @@ -290,6 +341,8 @@ Set the rotation (in degrees). - void **set_scale** **(** :ref:`Vector3` scale **)** +Set the scale. + .. _class_Spatial_set_transform: - void **set_transform** **(** :ref:`Transform` local **)** @@ -308,20 +361,30 @@ Set the transform locally, relative to the parent spatial node. - void **show** **(** **)** +Enables rendering of this node. Change Spatial Visible property to "True". + .. _class_Spatial_to_global: - :ref:`Vector3` **to_global** **(** :ref:`Vector3` local_point **)** const +Tranforms :ref:`Vector3` "local_point" from this node's local space to world space. + .. _class_Spatial_to_local: - :ref:`Vector3` **to_local** **(** :ref:`Vector3` global_point **)** const +Tranforms :ref:`Vector3` "global_point" from world space to this node's local space. + .. _class_Spatial_translate: - void **translate** **(** :ref:`Vector3` offset **)** +Changes the node's position by given offset :ref:`Vector3`. + .. _class_Spatial_update_gizmo: - void **update_gizmo** **(** **)** +Updates the :ref:`SpatialGizmo` of this node. + diff --git a/classes/class_spatialgizmo.rst b/classes/class_spatialgizmo.rst index a57636bbd..64470508a 100644 --- a/classes/class_spatialgizmo.rst +++ b/classes/class_spatialgizmo.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpatialGizmo.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpatialGizmo: diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 8e07af4fb..6f9221235 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpatialMaterial.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpatialMaterial: @@ -51,6 +52,10 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_diffuse_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_distance_fade_max_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_distance_fade_min_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_emission` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_emission_energy` **(** **)** const | @@ -77,6 +82,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_size` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_proximity_fade_distance` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_refraction` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_refraction_texture_channel` **(** **)** const | @@ -113,8 +120,12 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_distance_fade_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_grow_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_proximity_fade_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_alpha_scissor_threshold` **(** :ref:`float` threshold **)** | @@ -149,6 +160,12 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_diffuse_mode` **(** :ref:`int` diffuse_mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade_max_distance` **(** :ref:`float` distance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_distance_fade_min_distance` **(** :ref:`float` distance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission` **(** :ref:`Color` emission **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_energy` **(** :ref:`float` emission_energy **)** | @@ -177,6 +194,10 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_size` **(** :ref:`float` point_size **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_proximity_fade` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_proximity_fade_distance` **(** :ref:`float` distance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refraction_texture_channel` **(** :ref:`int` channel **)** | @@ -240,6 +261,9 @@ Member Variables - :ref:`Texture` **detail_mask** - :ref:`Texture` **detail_normal** - :ref:`int` **detail_uv_layer** +- :ref:`bool` **distance_fade_enable** +- :ref:`float` **distance_fade_max_distance** +- :ref:`float` **distance_fade_min_distance** - :ref:`Color` **emission** - :ref:`bool` **emission_enabled** - :ref:`float` **emission_energy** @@ -273,6 +297,8 @@ Member Variables - :ref:`int` **particles_anim_h_frames** - :ref:`int` **particles_anim_loop** - :ref:`int` **particles_anim_v_frames** +- :ref:`float` **proximity_fade_distance** +- :ref:`bool` **proximity_fade_enable** - :ref:`bool` **refraction_enabled** - :ref:`float` **refraction_scale** - :ref:`Texture` **refraction_texture** @@ -447,6 +473,14 @@ Member Function Description - :ref:`int` **get_diffuse_mode** **(** **)** const +.. _class_SpatialMaterial_get_distance_fade_max_distance: + +- :ref:`float` **get_distance_fade_max_distance** **(** **)** const + +.. _class_SpatialMaterial_get_distance_fade_min_distance: + +- :ref:`float` **get_distance_fade_min_distance** **(** **)** const + .. _class_SpatialMaterial_get_emission: - :ref:`Color` **get_emission** **(** **)** const @@ -499,6 +533,10 @@ Member Function Description - :ref:`float` **get_point_size** **(** **)** const +.. _class_SpatialMaterial_get_proximity_fade_distance: + +- :ref:`float` **get_proximity_fade_distance** **(** **)** const + .. _class_SpatialMaterial_get_refraction: - :ref:`float` **get_refraction** **(** **)** const @@ -571,10 +609,18 @@ Member Function Description - :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const +.. _class_SpatialMaterial_is_distance_fade_enabled: + +- :ref:`bool` **is_distance_fade_enabled** **(** **)** const + .. _class_SpatialMaterial_is_grow_enabled: - :ref:`bool` **is_grow_enabled** **(** **)** const +.. _class_SpatialMaterial_is_proximity_fade_enabled: + +- :ref:`bool` **is_proximity_fade_enabled** **(** **)** const + .. _class_SpatialMaterial_set_albedo: - void **set_albedo** **(** :ref:`Color` albedo **)** @@ -643,6 +689,18 @@ Member Function Description - void **set_diffuse_mode** **(** :ref:`int` diffuse_mode **)** +.. _class_SpatialMaterial_set_distance_fade: + +- void **set_distance_fade** **(** :ref:`bool` enabled **)** + +.. _class_SpatialMaterial_set_distance_fade_max_distance: + +- void **set_distance_fade_max_distance** **(** :ref:`float` distance **)** + +.. _class_SpatialMaterial_set_distance_fade_min_distance: + +- void **set_distance_fade_min_distance** **(** :ref:`float` distance **)** + .. _class_SpatialMaterial_set_emission: - void **set_emission** **(** :ref:`Color` emission **)** @@ -699,6 +757,14 @@ Member Function Description - void **set_point_size** **(** :ref:`float` point_size **)** +.. _class_SpatialMaterial_set_proximity_fade: + +- void **set_proximity_fade** **(** :ref:`bool` enabled **)** + +.. _class_SpatialMaterial_set_proximity_fade_distance: + +- void **set_proximity_fade_distance** **(** :ref:`float` distance **)** + .. _class_SpatialMaterial_set_refraction: - void **set_refraction** **(** :ref:`float` refraction **)** diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst index b6dd5a65b..1f822c11b 100644 --- a/classes/class_spatialvelocitytracker.rst +++ b/classes/class_spatialvelocitytracker.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpatialVelocityTracker.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpatialVelocityTracker: diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 05d23c37b..0519dd289 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SphereMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SphereMesh: @@ -13,7 +14,7 @@ SphereMesh Brief Description ----------------- - +Class representing a spherical :ref:`PrimitiveMesh`. Member Functions ---------------- @@ -43,11 +44,16 @@ Member Functions Member Variables ---------------- -- :ref:`float` **height** -- :ref:`bool` **is_hemisphere** -- :ref:`int` **radial_segments** -- :ref:`float` **radius** -- :ref:`int` **rings** +- :ref:`float` **height** - Full height of the sphere. Defaults to 2.0. +- :ref:`bool` **is_hemisphere** - 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. +- :ref:`int` **radial_segments** - Number of radial segments on the sphere. Defaults to 64. +- :ref:`float` **radius** - Radius of sphere. Defaults to 1.0. +- :ref:`int` **rings** - Number of segments along the height of the sphere. Defaults to 32. + +Description +----------- + +Class representing a spherical :ref:`PrimitiveMesh`. Member Function Description --------------------------- diff --git a/classes/class_sphereshape.rst b/classes/class_sphereshape.rst index 5fe6b969a..0472ba88f 100644 --- a/classes/class_sphereshape.rst +++ b/classes/class_sphereshape.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SphereShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SphereShape: diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index f70440f74..548bf2de0 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpinBox.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpinBox: diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index cbf7942c8..c85556884 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SplitContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SplitContainer: diff --git a/classes/class_spotlight.rst b/classes/class_spotlight.rst index 3067e3767..e67426643 100644 --- a/classes/class_spotlight.rst +++ b/classes/class_spotlight.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpotLight.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpotLight: diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index 006f0417d..1c8266a23 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Sprite.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Sprite: diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 2efd72230..fab0f3395 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Sprite3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Sprite3D: diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 73a78b913..d972db247 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpriteBase3D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpriteBase3D: diff --git a/classes/class_spriteframes.rst b/classes/class_spriteframes.rst index a36863149..38ae83c66 100644 --- a/classes/class_spriteframes.rst +++ b/classes/class_spriteframes.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SpriteFrames.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SpriteFrames: @@ -18,37 +19,37 @@ Sprite frame library for AnimatedSprite. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_animation` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=-1 **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_all` **(** **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_animation` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_frame` **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_all` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_animation_loop` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_animation_speed` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_frame` **(** :ref:`String` anim, :ref:`int` idx **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame_count` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_animation` **(** :ref:`String` anim **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_animation` **(** :ref:`String` anim **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_frame` **(** :ref:`String` anim, :ref:`int` idx **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`rename_animation` **(** :ref:`String` anim, :ref:`String` newname **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_loop` **(** :ref:`String` anim, :ref:`bool` loop **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_animation_speed` **(** :ref:`String` anim, :ref:`float` speed **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`String` anim, :ref:`int` idx, :ref:`Texture` txt **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -70,7 +71,7 @@ Member Function Description .. _class_SpriteFrames_add_frame: -- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` atpos=-1 **)** +- void **add_frame** **(** :ref:`String` anim, :ref:`Texture` frame, :ref:`int` at_position=-1 **)** .. _class_SpriteFrames_clear: diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 8a61061f2..3264e623d 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StaticBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StaticBody: @@ -39,10 +40,10 @@ Member Functions Member Variables ---------------- -- :ref:`float` **bounce** -- :ref:`Vector3` **constant_angular_velocity** -- :ref:`Vector3` **constant_linear_velocity** -- :ref:`float` **friction** +- :ref:`float` **bounce** - The body bounciness. +- :ref:`Vector3` **constant_angular_velocity** - The constant angular velocity for the body. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation. +- :ref:`Vector3` **constant_linear_velocity** - The constant linear velocity for the body. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement. +- :ref:`float` **friction** - The body friction, from 0 (frictionless) to 1 (full friction). Description ----------- diff --git a/classes/class_staticbody2d.rst b/classes/class_staticbody2d.rst index 10ed604b9..aa3fa5e6e 100644 --- a/classes/class_staticbody2d.rst +++ b/classes/class_staticbody2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StaticBody2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StaticBody2D: diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 4e6c2e06a..da20a523b 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StreamPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StreamPeer: diff --git a/classes/class_streampeerbuffer.rst b/classes/class_streampeerbuffer.rst index 98177c7dd..3b3ab11fe 100644 --- a/classes/class_streampeerbuffer.rst +++ b/classes/class_streampeerbuffer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StreamPeerBuffer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StreamPeerBuffer: @@ -25,13 +26,13 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`get_data_array` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_pos` **(** **)** const | +| :ref:`int` | :ref:`get_position` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_size` **(** **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` size **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` pos **)** | +| void | :ref:`seek` **(** :ref:`int` position **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_data_array` **(** :ref:`PoolByteArray` data **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ @@ -51,9 +52,9 @@ Member Function Description - :ref:`PoolByteArray` **get_data_array** **(** **)** const -.. _class_StreamPeerBuffer_get_pos: +.. _class_StreamPeerBuffer_get_position: -- :ref:`int` **get_pos** **(** **)** const +- :ref:`int` **get_position** **(** **)** const .. _class_StreamPeerBuffer_get_size: @@ -65,7 +66,7 @@ Member Function Description .. _class_StreamPeerBuffer_seek: -- void **seek** **(** :ref:`int` pos **)** +- void **seek** **(** :ref:`int` position **)** .. _class_StreamPeerBuffer_set_data_array: diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 0661db1a6..77d90207b 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StreamPeerSSL.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StreamPeerSSL: diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 5b766769c..02664fac2 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StreamPeerTCP.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StreamPeerTCP: diff --git a/classes/class_streamtexture.rst b/classes/class_streamtexture.rst index 1d909353a..e44e2aca6 100644 --- a/classes/class_streamtexture.rst +++ b/classes/class_streamtexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StreamTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StreamTexture: diff --git a/classes/class_string.rst b/classes/class_string.rst index 1a9c8e78c..ea8768ef1 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the String.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_String: @@ -81,7 +82,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase` **(** :ref:`int` pos, :ref:`int` chars **)** | +| void | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -103,7 +104,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`insert` **(** :ref:`int` pos, :ref:`String` what **)** | +| :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_abs_path` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,7 +126,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`json_escape` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`left` **(** :ref:`int` pos **)** | +| :ref:`String` | :ref:`left` **(** :ref:`int` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -159,7 +160,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`right` **(** :ref:`int` pos **)** | +| :ref:`String` | :ref:`right` **(** :ref:`int` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`sha256_buffer` **(** **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -346,9 +347,9 @@ Return true if the strings ends with the given string. .. _class_String_erase: -- void **erase** **(** :ref:`int` pos, :ref:`int` chars **)** +- void **erase** **(** :ref:`int` position, :ref:`int` chars **)** -Erase ``chars`` characters from the string starting from ``pos``. +Erase ``chars`` characters from the string starting from ``position``. .. _class_String_find: @@ -410,7 +411,7 @@ Convert a string containing a hexadecimal number into an int. .. _class_String_insert: -- :ref:`String` **insert** **(** :ref:`int` pos, :ref:`String` what **)** +- :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** Insert a substring at a given position. @@ -476,7 +477,7 @@ Return a copy of the string with special characters escaped using the JSON stand .. _class_String_left: -- :ref:`String` **left** **(** :ref:`int` pos **)** +- :ref:`String` **left** **(** :ref:`int` position **)** Return an amount of characters from the left of the string. @@ -578,7 +579,7 @@ Perform a search for a substring, but start from the end of the string instead o .. _class_String_right: -- :ref:`String` **right** **(** :ref:`int` pos **)** +- :ref:`String` **right** **(** :ref:`int` position **)** Return the right side of the string from a given position. diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index a1a2b9b5b..8bcbfc78e 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StyleBox.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StyleBox: diff --git a/classes/class_styleboxempty.rst b/classes/class_styleboxempty.rst index 780c9a9f9..55a4be732 100644 --- a/classes/class_styleboxempty.rst +++ b/classes/class_styleboxempty.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StyleBoxEmpty.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StyleBoxEmpty: diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 1ca6739c1..e15a4480a 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StyleBoxFlat.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StyleBoxFlat: @@ -122,7 +123,7 @@ This stylebox can be used to achieve all kinds of looks without the need of a te About corner radius: - Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: :: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 5f05fa8bd..5a2c53286 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the StyleBoxTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_StyleBoxTexture: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index b4110a087..24685a2d6 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the SurfaceTool.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_SurfaceTool: diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index a674f4535..20fef0d88 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TabContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TabContainer: @@ -74,6 +75,13 @@ Member Variables - :ref:`int` **tab_align** - :ref:`bool` **tabs_visible** +Numeric Constants +----------------- + +- **ALIGN_LEFT** = **0** +- **ALIGN_CENTER** = **1** +- **ALIGN_RIGHT** = **2** + Description ----------- diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index a1ad94499..69acc2d3f 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Tabs.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Tabs: diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 8ea4c2367..ee2af49fd 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TCP_Server.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TCP_Server: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 334f47cdd..91b86f322 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TextEdit.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TextEdit: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 3db05ca21..5b8ea660c 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Texture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Texture: @@ -8,7 +9,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`StreamTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core @@ -21,7 +22,7 @@ Member Functions ---------------- +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,7 +65,7 @@ Member Function Description .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` position, :ref:`Color` modulate=Color( 1, 1, 1, 1 ), :ref:`bool` transpose=false, :ref:`Texture` normal_map=null **)** const .. _class_Texture_draw_rect: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index cf47b770b..8a0b2198c 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TextureButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TextureButton: diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index ced5349b5..a3d972d67 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TextureProgress.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TextureProgress: @@ -13,7 +14,7 @@ TextureProgress Brief Description ----------------- -Textured progress bar implementation. +Textured progress bar. Member Functions ---------------- @@ -59,18 +60,18 @@ Member Functions Member Variables ---------------- -- :ref:`int` **fill_mode** -- :ref:`bool` **nine_patch_stretch** -- :ref:`Vector2` **radial_center_offset** -- :ref:`float` **radial_fill_degrees** -- :ref:`float` **radial_initial_angle** -- :ref:`int` **stretch_margin_bottom** -- :ref:`int` **stretch_margin_left** -- :ref:`int` **stretch_margin_right** -- :ref:`int` **stretch_margin_top** -- :ref:`Texture` **texture_over** -- :ref:`Texture` **texture_progress** -- :ref:`Texture` **texture_under** +- :ref:`int` **fill_mode** - The fill direction. Uses FILL_* constants. +- :ref:`bool` **nine_patch_stretch** - If [code]true[/code] textures will be stretched as [NinePatchRect]. Uses [code]stretch_margin[/code] properties (see below). Default value: [code]false[/code] +- :ref:`Vector2` **radial_center_offset** - The offset amount for radial mode. +- :ref:`float` **radial_fill_degrees** - The amount of the texture to use for radial mode. +- :ref:`float` **radial_initial_angle** - Start angle for radial mode. +- :ref:`int` **stretch_margin_bottom** - Nine-patch texture offset for bottom margin. +- :ref:`int` **stretch_margin_left** - Nine-patch texture offset for left margin. +- :ref:`int` **stretch_margin_right** - Nine-patch texture offset for right margin. +- :ref:`int` **stretch_margin_top** - Nine-patch texture offset for top margin. +- :ref:`Texture` **texture_over** - The [Texture] that will be drawn over the progress bar. +- :ref:`Texture` **texture_progress** - The [Texture] used to display [code]value[/code]. +- :ref:`Texture` **texture_under** - The [Texture] that will be drawn under the progress bar. Numeric Constants ----------------- @@ -85,7 +86,7 @@ Numeric Constants Description ----------- -:ref:`ProgressBar` implementation that is easier to theme (by just passing a few textures). +A :ref:`ProgressBar` that uses textures to display fill percentage. Can be set to linear or radial mode. Member Function Description --------------------------- diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 5b5a91272..c672704a4 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TextureRect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TextureRect: @@ -13,7 +14,7 @@ TextureRect Brief Description ----------------- -Control Frame that draws a texture. +Draws a sprite or a texture inside a User Interface. The texture can tile or not. Member Functions ---------------- @@ -35,26 +36,26 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **expand** -- :ref:`int` **stretch_mode** -- :ref:`Texture` **texture** +- :ref:`bool` **expand** - If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. +- :ref:`int` **stretch_mode** - Controls the texture's behavior when you resize the node's bounding rectangle. Set it to one of the [code]STRETCH_*[/code] constants. See the constants to learn more. +- :ref:`Texture` **texture** - The node's [Texture] resource. Numeric Constants ----------------- -- **STRETCH_SCALE_ON_EXPAND** = **0** -- **STRETCH_SCALE** = **1** -- **STRETCH_TILE** = **2** -- **STRETCH_KEEP** = **3** -- **STRETCH_KEEP_CENTERED** = **4** -- **STRETCH_KEEP_ASPECT** = **5** -- **STRETCH_KEEP_ASPECT_CENTERED** = **6** -- **STRETCH_KEEP_ASPECT_COVERED** = **7** +- **STRETCH_SCALE_ON_EXPAND** = **0** --- Scale to fit the node's bounding rectangle, only if ``expand`` is ``true``. Default ``stretch_mode``, for backwards compatibility. Until you set ``expand`` to ``true``, the texture will behave like ``STRETCH_KEEP``. +- **STRETCH_SCALE** = **1** --- Scale to fit the node's bounding rectangle. +- **STRETCH_TILE** = **2** --- Tile inside the node's bounding rectangle. +- **STRETCH_KEEP** = **3** --- The texture keeps its original size and stays in the bounding rectangle's top-left corner. +- **STRETCH_KEEP_CENTERED** = **4** --- The texture keeps its original size and stays centered in the node's bounding rectangle. +- **STRETCH_KEEP_ASPECT** = **5** --- Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. +- **STRETCH_KEEP_ASPECT_CENTERED** = **6** --- Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. +- **STRETCH_KEEP_ASPECT_COVERED** = **7** --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. Description ----------- -Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. +Use TextureRect to draw icons and sprites in your User Interfaces. To create panels and menu boxes, take a look at NinePatchFrame. Its Stretch Mode property controls the texture's scale and placement. It can scale, tile and stay centered inside its bounding rectangle. TextureRect is one of the 5 most common nodes to create game UI. Member Function Description --------------------------- diff --git a/classes/class_theme.rst b/classes/class_theme.rst index 628a60a1c..5f8eee6f4 100644 --- a/classes/class_theme.rst +++ b/classes/class_theme.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Theme.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Theme: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index f13cd3dd3..fdc34938e 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Thread.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Thread: @@ -47,19 +48,19 @@ Member Function Description - :ref:`String` **get_id** **(** **)** const -Return the id of the thread, uniquely identifying it among all threads. +Returns the current :ref:`Thread`\ s id, uniquely identifying it among all threads. .. _class_Thread_is_active: - :ref:`bool` **is_active** **(** **)** const -Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with :ref:`wait_to_finish`. +Returns true if this :ref:`Thread` is currently active. An active :ref:`Thread` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. .. _class_Thread_start: - :ref:`int` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** -Start a new :ref:`Thread`, it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY\_\* enum. +Starts a new :ref:`Thread` that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the :ref:`Thread` can be changed by passing a PRIORITY\_\* enum. Returns OK on success, or ERR_CANT_CREATE on failure. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 698d7d8b5..e55220733 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TileMap.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TileMap: @@ -13,7 +14,7 @@ TileMap Brief Description ----------------- -Node for 2D tile-based games. +Node for 2D tile-based maps. Member Functions ---------------- @@ -25,7 +26,7 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_cell_size` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` pos **)** const | +| :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_center_x` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,13 +74,13 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_y_sort_mode_enabled` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const | +| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell` **(** :ref:`int` x, :ref:`int` y, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_size` **(** :ref:`Vector2` size **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cellv` **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +| void | :ref:`set_cellv` **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_center_x` **(** :ref:`bool` enable **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -115,34 +116,34 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_y_sort_mode` **(** :ref:`bool` enable **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` worldpos **)** const | +| :ref:`Vector2` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **settings_changed** **(** **)** -Signal indicating that a tilemap setting has changed. +Emitted when a tilemap setting has changed. Member Variables ---------------- -- :ref:`Transform2D` **cell_custom_transform** -- :ref:`int` **cell_half_offset** -- :ref:`int` **cell_quadrant_size** -- :ref:`Vector2` **cell_size** -- :ref:`int` **cell_tile_origin** -- :ref:`bool` **cell_y_sort** -- :ref:`float` **collision_bounce** -- :ref:`float` **collision_friction** -- :ref:`int` **collision_layer** -- :ref:`int` **collision_mask** -- :ref:`bool` **collision_use_kinematic** -- :ref:`int` **mode** -- :ref:`int` **occluder_light_mask** -- :ref:`PoolIntArray` **tile_data** -- :ref:`TileSet` **tile_set** +- :ref:`Transform2D` **cell_custom_transform** - The custom [Transform2D] to be applied to the TileMap's cells. +- :ref:`int` **cell_half_offset** - Amount to offset alternating tiles. Uses HALF_OFFSET_* constants. Default value: HALF_OFFSET_DISABLED. +- :ref:`int` **cell_quadrant_size** - The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. +- :ref:`Vector2` **cell_size** - The TileMap's cell size. +- :ref:`int` **cell_tile_origin** - Position for tile origin. Uses TILE_ORIGIN_* constants. Default value: TILE_ORIGIN_TOP_LEFT. +- :ref:`bool` **cell_y_sort** - If [code]true[/code] the TileMap's children will be drawn in order of their Y coordinate. Default value: [code]false[/code]. +- :ref:`float` **collision_bounce** - Bounce value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 0. +- :ref:`float` **collision_friction** - Friction value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 1. +- :ref:`int` **collision_layer** - The collision layer(s) for all colliders in the TileMap. +- :ref:`int` **collision_mask** - The collision mask(s) for all colliders in the TileMap. +- :ref:`bool` **collision_use_kinematic** - If [code]true[/code] TileMap collisions will be handled as a kinematic body. If [code]false[/code] collisions will be handled as static body. Default value: [code]false[/code]. +- :ref:`int` **mode** - The TileMap orientation mode. Uses MODE_* constants. Default value: MODE_SQUARE. +- :ref:`int` **occluder_light_mask** - 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). +- :ref:`PoolIntArray` **tile_data** - A [PoolIntArray] containing +- :ref:`TileSet` **tile_set** - The assigned [TileSet]. Numeric Constants ----------------- @@ -161,9 +162,7 @@ Numeric Constants Description ----------- -Node for 2D tile-based games. Tilemaps use a :ref:`TileSet` which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. - -To optimize drawing and culling (sort of like :ref:`GridMap`), you can specify a quadrant size, so chunks of the map will be batched together at drawing time. +Node for 2D tile-based maps. Tilemaps use a :ref:`TileSet` which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. Member Function Description --------------------------- @@ -188,7 +187,7 @@ Return the cell size. .. _class_TileMap_get_cellv: -- :ref:`int` **get_cellv** **(** :ref:`Vector2` pos **)** const +- :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const Return the tile index of the cell referenced by a Vector2. @@ -322,7 +321,7 @@ Return the Y sort mode. .. _class_TileMap_map_to_world: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` mappos, :ref:`bool` ignore_half_ofs=false **)** const +- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2` map_position, :ref:`bool` ignore_half_ofs=false **)** const Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. @@ -346,7 +345,7 @@ Set the cell size. .. _class_TileMap_set_cellv: -- void **set_cellv** **(** :ref:`Vector2` pos, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** +- void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. @@ -462,7 +461,7 @@ A tile with a higher Y coordinate will therefore be drawn later, potentially cov .. _class_TileMap_world_to_map: -- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` worldpos **)** const +- :ref:`Vector2` **world_to_map** **(** :ref:`Vector2` world_position **)** const Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index af4e12516..209e0beef 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TileSet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TileSet: diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 422de54ca..2316e874c 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Timer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Timer: @@ -13,7 +14,7 @@ Timer Brief Description ----------------- -A simple Timer node. +A countdown timer. Member Functions ---------------- @@ -52,27 +53,27 @@ Signals ------- - **timeout** **(** **)** -Emitted when the time runs out. +Emitted when the Timer reaches 0. Member Variables ---------------- -- :ref:`bool` **autostart** -- :ref:`bool` **one_shot** -- :ref:`int` **process_mode** -- :ref:`float` **wait_time** +- :ref:`bool` **autostart** - If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code]. +- :ref:`bool` **one_shot** - If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. +- :ref:`int` **process_mode** - Processing mode. Uses TIMER_PROCESS_* constants as value. +- :ref:`float` **wait_time** - Wait time in seconds. Numeric Constants ----------------- -- **TIMER_PROCESS_FIXED** = **0** --- Update the timer at fixed intervals (framerate processing). -- **TIMER_PROCESS_IDLE** = **1** --- Update the timer during the idle time at each frame. +- **TIMER_PROCESS_FIXED** = **0** --- Update the Timer at fixed intervals (framerate processing). +- **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame. Description ----------- -Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop. +Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode. Member Function Description --------------------------- @@ -151,12 +152,12 @@ Set wait time in seconds. When the time is over, it will emit the timeout signal - void **start** **(** **)** -Start the timer. +Start the Timer. .. _class_Timer_stop: - void **stop** **(** **)** -Stop (cancel) the timer. +Stop (cancel) the Timer. diff --git a/classes/class_toolbutton.rst b/classes/class_toolbutton.rst index d90be35bc..b5b65483d 100644 --- a/classes/class_toolbutton.rst +++ b/classes/class_toolbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ToolButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ToolButton: @@ -13,5 +14,17 @@ ToolButton Brief Description ----------------- +Flat button helper class. + +Description +----------- + +This is a helper class to generate a flat :ref:`Button` (see :ref:`Button.set_flat`), creating a ToolButton is equivalent to: + +:: + + var btn = Button.new() + btn.set_flat(true) + diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index e3a106dda..f4bf11147 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TouchScreenButton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TouchScreenButton: @@ -77,6 +78,12 @@ Member Variables - :ref:`bool` **shape_visible** - :ref:`int` **visibility_mode** +Numeric Constants +----------------- + +- **VISIBILITY_ALWAYS** = **0** +- **VISIBILITY_TOUCHSCREEN_ONLY** = **1** + Member Function Description --------------------------- diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 394678c6f..2d26e9592 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Transform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Transform: @@ -11,7 +12,7 @@ Transform Brief Description ----------------- -3D Transformation. +3D Transformation. 3x4 matrix. Member Functions ---------------- @@ -51,13 +52,13 @@ Member Functions Member Variables ---------------- -- :ref:`Basis` **basis** - The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system travelling with the object. -- :ref:`Vector3` **origin** - The origin of the transform. Which is the translation offset. +- :ref:`Basis` **basis** - The basis is a matrix containing 3 [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. +- :ref:`Vector3` **origin** - The translation offset of the transform. Description ----------- -Transform is used to store translation, rotation and scaling transformations. It consists of a Basis "basis" and Vector3 "origin". Transform is used to represent transformations of objects in space, and as such, determine their position, orientation and scale. It is similar to a 3x4 matrix. +Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a :ref:`Basis` "basis" and an :ref:`Vector3` "origin". It is similar to a 3x4 matrix. Member Function Description --------------------------- @@ -66,31 +67,31 @@ Member Function Description - :ref:`Transform` **Transform** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** -Construct the Transform from four Vector3. Each axis corresponds to local basis vectors (some of which may be scaled). +Constructs the Transform from four :ref:`Vector3`. Each axis corresponds to local basis vectors (some of which may be scaled). .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Basis` basis, :ref:`Vector3` origin **)** -Construct the Transform from a Basis and Vector3. +Constructs the Transform from a :ref:`Basis` and :ref:`Vector3`. .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Transform2D` from **)** -Construct the Transform from a Transform2D. +Constructs the Transform from a :ref:`Transform2D`. .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Quat` from **)** -Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0). +Constructs the Transform from a :ref:`Quat`. The origin will be Vector3(0, 0, 0). .. _class_Transform_Transform: - :ref:`Transform` **Transform** **(** :ref:`Basis` from **)** -Construct the Transform from a Basis. The origin will be Vector3(0, 0, 0). +Constructs the Transform from a :ref:`Basis`. The origin will be Vector3(0, 0, 0). .. _class_Transform_affine_inverse: @@ -102,11 +103,13 @@ Returns the inverse of the transfrom, under the assumption that the transformati - :ref:`Transform` **interpolate_with** **(** :ref:`Transform` transform, :ref:`float` weight **)** +Interpolates the transform to other Transform by weight amount (0-1). + .. _class_Transform_inverse: - :ref:`Transform` **inverse** **(** **)** -Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling). +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: @@ -118,25 +121,25 @@ Rotate the transform around the up vector to face the target. - :ref:`Transform` **orthonormalized** **(** **)** -Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. +Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. .. _class_Transform_rotated: - :ref:`Transform` **rotated** **(** :ref:`Vector3` axis, :ref:`float` phi **)** -Rotate the transform around given axis by phi. The axis must be a normalized vector. +Rotates the transform around given axis by phi. The axis must be a normalized vector. .. _class_Transform_scaled: - :ref:`Transform` **scaled** **(** :ref:`Vector3` scale **)** -Scale the transform by the specified 3D scaling factors. +Scales the transform by the specified 3D scaling factors. .. _class_Transform_translated: - :ref:`Transform` **translated** **(** :ref:`Vector3` ofs **)** -Translate the transform by the specified displacement. +Translates the transform by the specified offset. .. _class_Transform_xform: @@ -148,6 +151,6 @@ Transforms the given vector "v" by this transform. - var **xform_inv** **(** var v **)** -Inverse-transforms vector "v" by this transform. +Inverse-transforms the given vector "v" by this transform. diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 1a44c7d74..6fef9b5bc 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Transform2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Transform2D: @@ -11,7 +12,7 @@ Transform2D Brief Description ----------------- -3x2 Matrix for 2D transforms. +2D Transformation. 3x2 matrix. Member Functions ---------------- @@ -21,7 +22,7 @@ Member Functions +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rot, :ref:`Vector2` pos **)** | +| :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,14 +56,14 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **origin** -- :ref:`Vector2` **x** -- :ref:`Vector2` **y** +- :ref:`Vector2` **origin** - The translation offset of the transform. +- :ref:`Vector2` **x** - The X axis of 2x2 basis matrix containing 2 [Vector2] 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. +- :ref:`Vector2` **y** - The Y axis of 2x2 basis matrix containing 2 [Vector2] 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. Description ----------- -3x2 Matrix for 2D transforms. +Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a two :ref:`Vector2` x, y and :ref:`Vector2` "origin". It is similar to a 3x2 matrix. Member Function Description --------------------------- @@ -71,72 +72,102 @@ Member Function Description - :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** +Constructs the :ref:`Transform2D` from a 3D :ref:`Transform`. + .. _class_Transform2D_Transform2D: - :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** +Constructs the :ref:`Transform2D` from 3 :ref:`Vector2` consisting of rows x, y and origin. + .. _class_Transform2D_Transform2D: -- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rot, :ref:`Vector2` pos **)** +- :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** + +Constructs the :ref:`Transform2D` from rotation angle in radians and position :ref:`Vector2`. .. _class_Transform2D_affine_inverse: - :ref:`Transform2D` **affine_inverse** **(** **)** -Return the inverse of the matrix. +Returns the inverse of the matrix. .. _class_Transform2D_basis_xform: - :ref:`Transform2D` **basis_xform** **(** var v **)** +Transforms the given vector "v" by this transform basis (no translation). + .. _class_Transform2D_basis_xform_inv: - :ref:`Transform2D` **basis_xform_inv** **(** var v **)** +Inverse-transforms the given vector "v" by this transform basis (no translation). + .. _class_Transform2D_get_origin: - :ref:`Vector2` **get_origin** **(** **)** +Returns the origin :ref:`Vector2` (translation). + .. _class_Transform2D_get_rotation: - :ref:`float` **get_rotation** **(** **)** -Return the rotation (in radians). +Returns the rotation (in radians). .. _class_Transform2D_get_scale: - :ref:`Vector2` **get_scale** **(** **)** +Returns the scale. + .. _class_Transform2D_interpolate_with: - :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** +Interpolates the transform to other Transform2D by weight amount (0-1). + .. _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: - :ref:`Transform2D` **orthonormalized** **(** **)** +Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + .. _class_Transform2D_rotated: - :ref:`Transform2D` **rotated** **(** :ref:`float` phi **)** +Rotates the transform by phi. + .. _class_Transform2D_scaled: - :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** +Scales the transform by the specified 2D scaling factors. + .. _class_Transform2D_translated: - :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** +Translates the transform by the specified offset. + .. _class_Transform2D_xform: - :ref:`Transform2D` **xform** **(** var v **)** +Transforms the given vector "v" by this transform. + .. _class_Transform2D_xform_inv: - :ref:`Transform2D` **xform_inv** **(** var v **)** +Inverse-transforms the given vector "v" by this transform. + diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 15d7257b4..af88fd7f4 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Translation.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Translation: diff --git a/classes/class_translationserver.rst b/classes/class_translationserver.rst index 9b9509f1b..cb829cb70 100644 --- a/classes/class_translationserver.rst +++ b/classes/class_translationserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TranslationServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TranslationServer: diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 77d05efb4..a57579ee4 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Tree.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Tree: @@ -31,7 +32,7 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_allow_rmb_select` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_column_at_pos` **(** :ref:`Vector2` pos **)** const | +| :ref:`int` | :ref:`get_column_at_position` **(** :ref:`Vector2` position **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_column_title` **(** :ref:`int` column **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -43,13 +44,15 @@ Member Functions +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_drop_mode_flags` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_drop_section_at_position` **(** :ref:`Vector2` position **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_edited` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edited_column` **(** **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_item_area_rect` **(** :ref:`Object` item, :ref:`int` column=-1 **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_item_at_pos` **(** :ref:`Vector2` pos **)** const | +| :ref:`TreeItem` | :ref:`get_item_at_position` **(** :ref:`Vector2` position **)** const | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TreeItem` | :ref:`get_next_selected` **(** :ref:`Object` from **)** | +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -101,7 +104,7 @@ Emitted when a cell is selected. - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. -- **empty_tree_rmb_selected** **(** :ref:`Vector2` pos **)** +- **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. - **item_activated** **(** **)** @@ -116,7 +119,7 @@ Emitted when an item is collapsed by a click on the folding arrow. Emitted when an item is editted. - **item_rmb_edited** **(** **)** -- **item_rmb_selected** **(** :ref:`Vector2` pos **)** +- **item_rmb_selected** **(** :ref:`Vector2` position **)** Emitted when an item is selected with right mouse button. - **item_selected** **(** **)** @@ -189,9 +192,9 @@ Make the current selected item visible. This will scroll the tree to make sure t Get whether a right click can select items. -.. _class_Tree_get_column_at_pos: +.. _class_Tree_get_column_at_position: -- :ref:`int` **get_column_at_pos** **(** :ref:`Vector2` pos **)** const +- :ref:`int` **get_column_at_position** **(** :ref:`Vector2` position **)** const Get the column index under the given point. @@ -225,6 +228,10 @@ Get the rectangle for custom popups. Helper to create custom cell controls that Get the flags of the current drop mode. +.. _class_Tree_get_drop_section_at_position: + +- :ref:`int` **get_drop_section_at_position** **(** :ref:`Vector2` position **)** const + .. _class_Tree_get_edited: - :ref:`TreeItem` **get_edited** **(** **)** const @@ -243,9 +250,9 @@ Get the column of the cell for the current edited icon. This is only available f Get the rectangle area of the 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_pos: +.. _class_Tree_get_item_at_position: -- :ref:`TreeItem` **get_item_at_pos** **(** :ref:`Vector2` pos **)** const +- :ref:`TreeItem` **get_item_at_position** **(** :ref:`Vector2` position **)** const Get the tree item at the specified position (relative to the tree origin position). diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 7ac8bc6fb..8a1e19750 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TreeItem.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TreeItem: @@ -39,6 +40,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_custom_minimum_height` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | @@ -109,6 +112,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_minimum_height` **(** :ref:`int` height **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | @@ -145,6 +150,9 @@ Numeric Constants - **CELL_MODE_RANGE_EXPRESSION** = **3** - **CELL_MODE_ICON** = **4** - **CELL_MODE_CUSTOM** = **5** +- **ALIGN_LEFT** = **0** +- **ALIGN_CENTER** = **1** +- **ALIGN_RIGHT** = **2** Member Function Description --------------------------- @@ -189,6 +197,10 @@ Member Function Description - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const +.. _class_TreeItem_get_custom_minimum_height: + +- :ref:`int` **get_custom_minimum_height** **(** **)** const + .. _class_TreeItem_get_expand_right: - :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const @@ -329,6 +341,10 @@ Member Function Description - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** +.. _class_TreeItem_set_custom_minimum_height: + +- void **set_custom_minimum_height** **(** :ref:`int` height **)** + .. _class_TreeItem_set_disable_folding: - void **set_disable_folding** **(** :ref:`bool` disable **)** diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index b8d850a90..4c869027e 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the TriangleMesh.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_TriangleMesh: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index ded8a9979..09787fb60 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Tween.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Tween: @@ -125,7 +126,7 @@ Because it is easy to get it wrong, here is a quick usage example: :: var tween = get_node("Tween") - tween.interpolate_property(get_node("Node2D_to_move"), "transform/pos", Vector2(0,0), Vector2(100,100), 1, Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) + tween.interpolate_property(get_node("Node2D_to_move"), "transform/origin", Vector2(0,0), Vector2(100,100), 1, Tween.TRANS_LINEAR, Tween.EASE_IN_OUT) tween.start() Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index fb4fc7c8b..d94167de7 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the UndoRedo.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_UndoRedo: @@ -39,8 +40,16 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_action_name` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_max_steps` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_version` **(** **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`redo` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_steps` **(** :ref:`int` max_steps **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`undo` **(** **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -115,6 +124,10 @@ Create a new action. After this is called, do all your calls to :ref:`add_do_met Get the name of the current action. +.. _class_UndoRedo_get_max_steps: + +- :ref:`int` **get_max_steps** **(** **)** const + .. _class_UndoRedo_get_version: - :ref:`int` **get_version** **(** **)** const @@ -123,4 +136,16 @@ 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: + +- void **redo** **(** **)** + +.. _class_UndoRedo_set_max_steps: + +- void **set_max_steps** **(** :ref:`int` max_steps **)** + +.. _class_UndoRedo_undo: + +- void **undo** **(** **)** + diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 93e3bff10..bf7b7b1d1 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Variant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Variant: @@ -11,5 +12,10 @@ Variant Brief Description ----------------- +The most important data type in Godot. +Description +----------- + +A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time, instead they are used mainly for communication, editing, serialization and moving data around. diff --git a/classes/class_vboxcontainer.rst b/classes/class_vboxcontainer.rst index 9c254c205..18f33a482 100644 --- a/classes/class_vboxcontainer.rst +++ b/classes/class_vboxcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VBoxContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VBoxContainer: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index d80f12efd..8a09f571d 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Vector2.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Vector2: diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index cb9788a48..e7f748cc1 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Vector3.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Vector3: diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 17645f9fc..6e95f69a2 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VehicleBody.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VehicleBody: diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index 9cb918d1b..b3a9827d3 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VehicleWheel.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VehicleWheel: diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index ae91bf1ac..873d554f1 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VideoPlayer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VideoPlayer: @@ -27,7 +28,7 @@ Member Functions +----------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_stream_name` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_stream_pos` **(** **)** const | +| :ref:`float` | :ref:`get_stream_position` **(** **)** const | +----------------------------------------+------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_video_texture` **(** **)** | +----------------------------------------+------------------------------------------------------------------------------------------------------------+ @@ -106,9 +107,9 @@ Get the video stream. Get the name of the video stream. -.. _class_VideoPlayer_get_stream_pos: +.. _class_VideoPlayer_get_stream_position: -- :ref:`float` **get_stream_pos** **(** **)** const +- :ref:`float` **get_stream_position** **(** **)** const Get the current position of the stream, in seconds. diff --git a/classes/class_videostream.rst b/classes/class_videostream.rst index fc522ade4..d7841df4e 100644 --- a/classes/class_videostream.rst +++ b/classes/class_videostream.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VideoStream.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VideoStream: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index aba3a47a0..d9b141f98 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the Viewport.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_Viewport: @@ -89,6 +90,8 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_size_override_stretch_enabled` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_snap_controls_to_pixels_enabled` **(** **)** const | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | @@ -125,6 +128,8 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_size_override_stretch` **(** :ref:`bool` enabled **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_snap_controls_to_pixels` **(** :ref:`bool` enabled **)** | ++------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_transparent_background` **(** :ref:`bool` enable **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | @@ -147,7 +152,7 @@ Member Functions +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`use_arvr` **(** **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_pos **)** | +| void | :ref:`warp_mouse` **(** :ref:`Vector2` to_position **)** | +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -166,6 +171,7 @@ Member Variables - :ref:`int` **debug_draw** - :ref:`bool` **disable_3d** - :ref:`bool` **gui_disable_input** +- :ref:`bool` **gui_snap_controls_to_pixels** - :ref:`bool` **hdr** - :ref:`int` **msaa** - :ref:`bool` **own_world** @@ -214,6 +220,13 @@ Numeric Constants - **MSAA_4X** = **2** - **MSAA_8X** = **3** - **MSAA_16X** = **4** +- **USAGE_2D** = **0** +- **USAGE_2D_NO_SAMPLING** = **1** +- **USAGE_3D** = **2** +- **USAGE_3D_NO_EFFECTS** = **3** +- **CLEAR_MODE_ALWAYS** = **0** +- **CLEAR_MODE_NEVER** = **1** +- **CLEAR_MODE_ONLY_NEXT_FRAME** = **2** Description ----------- @@ -425,6 +438,10 @@ Get the enabled status of the size override set with :ref:`set_size_override`. +.. _class_Viewport_is_snap_controls_to_pixels_enabled: + +- :ref:`bool` **is_snap_controls_to_pixels_enabled** **(** **)** const + .. _class_Viewport_is_using_own_world: - :ref:`bool` **is_using_own_world** **(** **)** const @@ -517,6 +534,10 @@ Set the size override of the viewport. If the enable parameter is true, it would Set whether the size override affects stretch as well. +.. _class_Viewport_set_snap_controls_to_pixels: + +- void **set_snap_controls_to_pixels** **(** :ref:`bool` enabled **)** + .. _class_Viewport_set_transparent_background: - void **set_transparent_background** **(** :ref:`bool` enable **)** @@ -537,6 +558,14 @@ Set when the render target would be updated, using the ``UPDATE\_\*`` constants - void **set_use_arvr** **(** :ref:`bool` use **)** +If true this viewport will be bound to our ARVR Server. + +If this is our main Godot viewport our AR/VR output will be displayed on screen. + +If output is redirected to an HMD we'll see the output of just one of the eyes without any distortion applied else we'll see the stereo buffer with distortion applied if applicable + +If this is an extra viewport output will only work if redirection to an HMD is supported by the interface. The render target will allow you to use the undistorted output for the right eye in the display. + .. _class_Viewport_set_use_own_world: - void **set_use_own_world** **(** :ref:`bool` enable **)** @@ -573,9 +602,11 @@ Force update of the 2D and 3D worlds. - :ref:`bool` **use_arvr** **(** **)** +Returns whether this viewport is using our ARVR Server + .. _class_Viewport_warp_mouse: -- void **warp_mouse** **(** :ref:`Vector2` to_pos **)** +- void **warp_mouse** **(** :ref:`Vector2` to_position **)** Warp the mouse to a position, relative to the viewport. diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index a1b508c59..2f76aa088 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ViewportContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ViewportContainer: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 1348209c7..599f4226f 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the ViewportTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_ViewportTexture: diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index a2b7af927..72b9f6a93 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisibilityEnabler.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisibilityEnabler: diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 58f5dec72..06f894211 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisibilityEnabler2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisibilityEnabler2D: diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index a7aadc843..5a4e30f1b 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisibilityNotifier.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisibilityNotifier: @@ -15,7 +16,7 @@ VisibilityNotifier Brief Description ----------------- -Detect when the node is visible on screen. +Detects when the node is visible on screen. Member Functions ---------------- @@ -47,12 +48,12 @@ Emitted when the VisibilityNotifier exits the screen. Member Variables ---------------- -- :ref:`Rect3` **aabb** +- :ref:`Rect3` **aabb** - The VisibilityNotifier's bounding box. Description ----------- -The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen. +The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a :ref:`Camera`'s view. Member Function Description --------------------------- @@ -61,13 +62,13 @@ Member Function Description - :ref:`Rect3` **get_aabb** **(** **)** const -Return the visibility bounding box of the VisibilityNotifier. +Returns the bounding box of the VisibilityNotifier. .. _class_VisibilityNotifier_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const -Return true if any part of the bounding box is on the screen. +If ``true`` the bounding box is on the screen. .. _class_VisibilityNotifier_set_aabb: diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index c46491004..4091d6889 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisibilityNotifier2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisibilityNotifier2D: @@ -15,7 +16,7 @@ VisibilityNotifier2D Brief Description ----------------- -Detect when the node is visible on screen. +Detects when the node is visible on screen. Member Functions ---------------- @@ -47,12 +48,12 @@ Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s Member Variables ---------------- -- :ref:`Rect2` **rect** +- :ref:`Rect2` **rect** - The VisibilityNotifier2D's bounding rectangle. Description ----------- -The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen. +The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. Member Function Description --------------------------- @@ -61,13 +62,13 @@ Member Function Description - :ref:`Rect2` **get_rect** **(** **)** const -Return the visibility bounding rectangle of the VisibilityNotifier2D. +Returns the bounding rectangle of the VisibilityNotifier2D. .. _class_VisibilityNotifier2D_is_on_screen: - :ref:`bool` **is_on_screen** **(** **)** const -Return true if any part of the bounding rectangle is on the screen. +If ``true`` the bounding rectangle is on the screen. .. _class_VisibilityNotifier2D_set_rect: diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 3a2bb2c05..e10cf4ba8 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualInstance: diff --git a/classes/class_visualscript.rst b/classes/class_visualscript.rst index c873adc63..6bee23dca 100644 --- a/classes/class_visualscript.rst +++ b/classes/class_visualscript.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScript: @@ -23,7 +24,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_function` **(** :ref:`String` name **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=Vector2( 0, 0 ) **)** | +| void | :ref:`add_node` **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_variable` **(** :ref:`String` name, :ref:`Variant` default_value=null, :ref:`bool` export=false **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -53,7 +54,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VisualScriptNode` | :ref:`get_node` **(** :ref:`String` func, :ref:`int` id **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_node_pos` **(** :ref:`String` func, :ref:`int` id **)** const | +| :ref:`Vector2` | :ref:`get_node_position` **(** :ref:`String` func, :ref:`int` id **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_variable_default_value` **(** :ref:`String` name **)** const | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -95,7 +96,7 @@ Member Functions +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_base_type` **(** :ref:`String` type **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_node_pos` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** | +| void | :ref:`set_node_position` **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_variable_default_value` **(** :ref:`String` name, :ref:`Variant` value **)** | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -127,7 +128,7 @@ Member Function Description .. _class_VisualScript_add_node: -- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` pos=Vector2( 0, 0 ) **)** +- void **add_node** **(** :ref:`String` func, :ref:`int` id, :ref:`VisualScriptNode` node, :ref:`Vector2` position=Vector2( 0, 0 ) **)** .. _class_VisualScript_add_variable: @@ -185,9 +186,9 @@ Member Function Description - :ref:`VisualScriptNode` **get_node** **(** :ref:`String` func, :ref:`int` id **)** const -.. _class_VisualScript_get_node_pos: +.. _class_VisualScript_get_node_position: -- :ref:`Vector2` **get_node_pos** **(** :ref:`String` func, :ref:`int` id **)** const +- :ref:`Vector2` **get_node_position** **(** :ref:`String` func, :ref:`int` id **)** const .. _class_VisualScript_get_variable_default_value: @@ -269,9 +270,9 @@ Member Function Description - void **set_instance_base_type** **(** :ref:`String` type **)** -.. _class_VisualScript_set_node_pos: +.. _class_VisualScript_set_node_position: -- void **set_node_pos** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` pos **)** +- void **set_node_position** **(** :ref:`String` func, :ref:`int` id, :ref:`Vector2` position **)** .. _class_VisualScript_set_variable_default_value: diff --git a/classes/class_visualscriptbasictypeconstant.rst b/classes/class_visualscriptbasictypeconstant.rst index dea573bf3..061875912 100644 --- a/classes/class_visualscriptbasictypeconstant.rst +++ b/classes/class_visualscriptbasictypeconstant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptBasicTypeConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptBasicTypeConstant: @@ -32,7 +33,7 @@ Member Variables ---------------- - :ref:`int` **basic_type** -- :ref:`String` **constant/constant** +- :ref:`String` **constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index ac8a0a317..3117cbedc 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptBuiltinFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptBuiltinFunc: @@ -29,6 +30,68 @@ Member Variables - :ref:`int` **function** +Numeric Constants +----------------- + +- **MATH_SIN** = **0** +- **MATH_COS** = **1** +- **MATH_TAN** = **2** +- **MATH_SINH** = **3** +- **MATH_COSH** = **4** +- **MATH_TANH** = **5** +- **MATH_ASIN** = **6** +- **MATH_ACOS** = **7** +- **MATH_ATAN** = **8** +- **MATH_ATAN2** = **9** +- **MATH_SQRT** = **10** +- **MATH_FMOD** = **11** +- **MATH_FPOSMOD** = **12** +- **MATH_FLOOR** = **13** +- **MATH_CEIL** = **14** +- **MATH_ROUND** = **15** +- **MATH_ABS** = **16** +- **MATH_SIGN** = **17** +- **MATH_POW** = **18** +- **MATH_LOG** = **19** +- **MATH_EXP** = **20** +- **MATH_ISNAN** = **21** +- **MATH_ISINF** = **22** +- **MATH_EASE** = **23** +- **MATH_DECIMALS** = **24** +- **MATH_STEPIFY** = **25** +- **MATH_LERP** = **26** +- **MATH_DECTIME** = **27** +- **MATH_RANDOMIZE** = **28** +- **MATH_RAND** = **29** +- **MATH_RANDF** = **30** +- **MATH_RANDOM** = **31** +- **MATH_SEED** = **32** +- **MATH_RANDSEED** = **33** +- **MATH_DEG2RAD** = **34** +- **MATH_RAD2DEG** = **35** +- **MATH_LINEAR2DB** = **36** +- **MATH_DB2LINEAR** = **37** +- **LOGIC_MAX** = **38** +- **LOGIC_MIN** = **39** +- **LOGIC_CLAMP** = **40** +- **LOGIC_NEAREST_PO2** = **41** +- **OBJ_WEAKREF** = **42** +- **FUNC_FUNCREF** = **43** +- **TYPE_CONVERT** = **44** +- **TYPE_OF** = **45** +- **TYPE_EXISTS** = **46** +- **TEXT_CHAR** = **47** +- **TEXT_STR** = **48** +- **TEXT_PRINT** = **49** +- **TEXT_PRINTERR** = **50** +- **TEXT_PRINTRAW** = **51** +- **VAR_TO_STR** = **52** +- **STR_TO_VAR** = **53** +- **VAR_TO_BYTES** = **54** +- **BYTES_TO_VAR** = **55** +- **COLORN** = **56** +- **FUNC_MAX** = **57** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptclassconstant.rst b/classes/class_visualscriptclassconstant.rst index f543570b4..4811dcd34 100644 --- a/classes/class_visualscriptclassconstant.rst +++ b/classes/class_visualscriptclassconstant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptClassConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptClassConstant: @@ -32,7 +33,7 @@ Member Variables ---------------- - :ref:`String` **base_type** -- :ref:`String` **constant/constant** +- :ref:`String` **constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptcomment.rst b/classes/class_visualscriptcomment.rst index 32f2999ab..e51128bad 100644 --- a/classes/class_visualscriptcomment.rst +++ b/classes/class_visualscriptcomment.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptComment.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptComment: diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index 1caddc267..0e45652df 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptCondition.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptCondition: diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index ff9d929f9..f04e29d0a 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptConstant: diff --git a/classes/class_visualscriptconstructor.rst b/classes/class_visualscriptconstructor.rst index c3cf7b02a..3750ff0f0 100644 --- a/classes/class_visualscriptconstructor.rst +++ b/classes/class_visualscriptconstructor.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptConstructor.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptConstructor: diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index d8c0a4e87..5bc820075 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptCustomNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptCustomNode: diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 626ac4676..db60aea07 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptDeconstruct.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptDeconstruct: diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index 2552a47b9..4ddf7e3db 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptEmitSignal.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptEmitSignal: diff --git a/classes/class_visualscriptenginesingleton.rst b/classes/class_visualscriptenginesingleton.rst index 91c7fc569..29481a99a 100644 --- a/classes/class_visualscriptenginesingleton.rst +++ b/classes/class_visualscriptenginesingleton.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptEngineSingleton.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptEngineSingleton: @@ -27,7 +28,7 @@ Member Functions Member Variables ---------------- -- :ref:`String` **constant/constant** +- :ref:`String` **constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptexpression.rst b/classes/class_visualscriptexpression.rst index cffd58f3f..ade916a95 100644 --- a/classes/class_visualscriptexpression.rst +++ b/classes/class_visualscriptexpression.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptExpression.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptExpression: diff --git a/classes/class_visualscriptfunction.rst b/classes/class_visualscriptfunction.rst index f9b175ab1..0c2f54d4c 100644 --- a/classes/class_visualscriptfunction.rst +++ b/classes/class_visualscriptfunction.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptFunction.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptFunction: diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index de9d8aeda..49f49951e 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptFunctionCall.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptFunctionCall: @@ -82,6 +83,12 @@ Numeric Constants - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** - **CALL_MODE_BASIC_TYPE** = **3** +- **CALL_MODE_SINGLETON** = **4** +- **RPC_DISABLED** = **0** +- **RPC_RELIABLE** = **1** +- **RPC_UNRELIABLE** = **2** +- **RPC_RELIABLE_TO_ID** = **3** +- **RPC_UNRELIABLE_TO_ID** = **4** Member Function Description --------------------------- diff --git a/classes/class_visualscriptfunctionstate.rst b/classes/class_visualscriptfunctionstate.rst index af91428db..07304626f 100644 --- a/classes/class_visualscriptfunctionstate.rst +++ b/classes/class_visualscriptfunctionstate.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptFunctionState.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptFunctionState: diff --git a/classes/class_visualscriptglobalconstant.rst b/classes/class_visualscriptglobalconstant.rst index 0ad7c8782..190c4f61b 100644 --- a/classes/class_visualscriptglobalconstant.rst +++ b/classes/class_visualscriptglobalconstant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptGlobalConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptGlobalConstant: @@ -27,7 +28,7 @@ Member Functions Member Variables ---------------- -- :ref:`int` **constant/constant** +- :ref:`int` **constant** Member Function Description --------------------------- diff --git a/classes/class_visualscriptindexget.rst b/classes/class_visualscriptindexget.rst index 6ca2ebfc8..24940db02 100644 --- a/classes/class_visualscriptindexget.rst +++ b/classes/class_visualscriptindexget.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptIndexGet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptIndexGet: diff --git a/classes/class_visualscriptindexset.rst b/classes/class_visualscriptindexset.rst index 0a9c022e8..80ffcc12b 100644 --- a/classes/class_visualscriptindexset.rst +++ b/classes/class_visualscriptindexset.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptIndexSet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptIndexSet: diff --git a/classes/class_visualscriptinputaction.rst b/classes/class_visualscriptinputaction.rst index 15180dee2..f8003ee30 100644 --- a/classes/class_visualscriptinputaction.rst +++ b/classes/class_visualscriptinputaction.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptInputAction.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptInputAction: @@ -34,6 +35,14 @@ Member Variables - :ref:`String` **action** - :ref:`int` **mode** +Numeric Constants +----------------- + +- **MODE_PRESSED** = **0** +- **MODE_RELEASED** = **1** +- **MODE_JUST_PRESSED** = **2** +- **MODE_JUST_RELEASED** = **3** + Member Function Description --------------------------- diff --git a/classes/class_visualscriptiterator.rst b/classes/class_visualscriptiterator.rst index 0585883bc..c6b95a1c9 100644 --- a/classes/class_visualscriptiterator.rst +++ b/classes/class_visualscriptiterator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptIterator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptIterator: diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index e7562cc37..cd528ccbe 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptLocalVar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptLocalVar: diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index 1375b1c62..08c8de6e6 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptLocalVarSet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptLocalVarSet: diff --git a/classes/class_visualscriptmathconstant.rst b/classes/class_visualscriptmathconstant.rst index e057f3c1e..207659987 100644 --- a/classes/class_visualscriptmathconstant.rst +++ b/classes/class_visualscriptmathconstant.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptMathConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptMathConstant: @@ -27,7 +28,20 @@ Member Functions Member Variables ---------------- -- :ref:`int` **constant/constant** +- :ref:`int` **constant** + +Numeric Constants +----------------- + +- **MATH_CONSTANT_ONE** = **0** +- **MATH_CONSTANT_PI** = **1** +- **MATH_CONSTANT_2PI** = **2** +- **MATH_CONSTANT_HALF_PI** = **3** +- **MATH_CONSTANT_E** = **4** +- **MATH_CONSTANT_SQRT2** = **5** +- **MATH_CONSTANT_INF** = **6** +- **MATH_CONSTANT_NAN** = **7** +- **MATH_CONSTANT_MAX** = **8** Member Function Description --------------------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index a48eebed3..7cd8bfeac 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptNode: @@ -8,7 +9,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptSelf`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 4c8a5c425..8851b5d97 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptOperator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptOperator: diff --git a/classes/class_visualscriptpreload.rst b/classes/class_visualscriptpreload.rst index c7442bef2..4b4f09488 100644 --- a/classes/class_visualscriptpreload.rst +++ b/classes/class_visualscriptpreload.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptPreload.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptPreload: diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index fcd1097b1..4030931a8 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptPropertyGet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptPropertyGet: diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 753584909..0a96db21c 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptPropertySet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptPropertySet: @@ -71,6 +72,18 @@ Numeric Constants - **CALL_MODE_SELF** = **0** - **CALL_MODE_NODE_PATH** = **1** - **CALL_MODE_INSTANCE** = **2** +- **CALL_MODE_BASIC_TYPE** = **3** +- **ASSIGN_OP_NONE** = **0** +- **ASSIGN_OP_ADD** = **1** +- **ASSIGN_OP_SUB** = **2** +- **ASSIGN_OP_MUL** = **3** +- **ASSIGN_OP_DIV** = **4** +- **ASSIGN_OP_MOD** = **5** +- **ASSIGN_OP_SHIFT_LEFT** = **6** +- **ASSIGN_OP_SHIFT_RIGHT** = **7** +- **ASSIGN_OP_BIT_AND** = **8** +- **ASSIGN_OP_BIT_OR** = **9** +- **ASSIGN_OP_BIT_XOR** = **10** Member Function Description --------------------------- diff --git a/classes/class_visualscriptresourcepath.rst b/classes/class_visualscriptresourcepath.rst index 497bcce5e..473d2f0c2 100644 --- a/classes/class_visualscriptresourcepath.rst +++ b/classes/class_visualscriptresourcepath.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptResourcePath.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptResourcePath: diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 2f60545e6..2b1d05349 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptReturn.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptReturn: diff --git a/classes/class_visualscriptscenenode.rst b/classes/class_visualscriptscenenode.rst index 16f2e9b0b..4c7bb42b9 100644 --- a/classes/class_visualscriptscenenode.rst +++ b/classes/class_visualscriptscenenode.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSceneNode.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSceneNode: diff --git a/classes/class_visualscriptscenetree.rst b/classes/class_visualscriptscenetree.rst index 3de0ada39..49949944e 100644 --- a/classes/class_visualscriptscenetree.rst +++ b/classes/class_visualscriptscenetree.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSceneTree.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSceneTree: diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst index ad1f09a6e..43b3b45db 100644 --- a/classes/class_visualscriptselect.rst +++ b/classes/class_visualscriptselect.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSelect.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSelect: diff --git a/classes/class_visualscriptself.rst b/classes/class_visualscriptself.rst index 8acb75180..49fc9031e 100644 --- a/classes/class_visualscriptself.rst +++ b/classes/class_visualscriptself.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSelf.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSelf: diff --git a/classes/class_visualscriptsequence.rst b/classes/class_visualscriptsequence.rst index f3899aa79..979b9a8d4 100644 --- a/classes/class_visualscriptsequence.rst +++ b/classes/class_visualscriptsequence.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSequence.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSequence: diff --git a/classes/class_visualscriptsubcall.rst b/classes/class_visualscriptsubcall.rst index c9738eea2..7b1a0d4a7 100644 --- a/classes/class_visualscriptsubcall.rst +++ b/classes/class_visualscriptsubcall.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSubCall.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSubCall: diff --git a/classes/class_visualscriptswitch.rst b/classes/class_visualscriptswitch.rst index e56b3bd8b..7b46d0667 100644 --- a/classes/class_visualscriptswitch.rst +++ b/classes/class_visualscriptswitch.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptSwitch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptSwitch: diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index 42a6d222f..1248ecb7a 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptTypeCast.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptTypeCast: diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index b02a723b6..6adeb2631 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptVariableGet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptVariableGet: diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 3a59d16fc..28d214902 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptVariableSet.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptVariableSet: diff --git a/classes/class_visualscriptwhile.rst b/classes/class_visualscriptwhile.rst index e5cc1d21c..9afe510e8 100644 --- a/classes/class_visualscriptwhile.rst +++ b/classes/class_visualscriptwhile.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptWhile.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptWhile: diff --git a/classes/class_visualscriptyield.rst b/classes/class_visualscriptyield.rst index 4c9438a11..11eb4ef93 100644 --- a/classes/class_visualscriptyield.rst +++ b/classes/class_visualscriptyield.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptYield.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptYield: diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 13f01b4ee..acc84c853 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualScriptYieldSignal.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualScriptYieldSignal: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 6a24929a9..3f78f25ba 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VisualServer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VisualServer: diff --git a/classes/class_vscrollbar.rst b/classes/class_vscrollbar.rst index b41dbd4c8..ed01f6914 100644 --- a/classes/class_vscrollbar.rst +++ b/classes/class_vscrollbar.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VScrollBar.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VScrollBar: diff --git a/classes/class_vseparator.rst b/classes/class_vseparator.rst index 353994883..cdaa6a9a2 100644 --- a/classes/class_vseparator.rst +++ b/classes/class_vseparator.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VSeparator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VSeparator: diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 4322dd414..8d043cd11 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VSlider.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VSlider: diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index dd0f7db29..899e253d2 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the VSplitContainer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_VSplitContainer: diff --git a/classes/class_weakref.rst b/classes/class_weakref.rst index 2d794e6a4..a46eec45b 100644 --- a/classes/class_weakref.rst +++ b/classes/class_weakref.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the WeakRef.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_WeakRef: diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index 89ad983e1..9bab47ffa 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the WindowDialog.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_WindowDialog: diff --git a/classes/class_world.rst b/classes/class_world.rst index c77086eb9..4b32e527e 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the World.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_World: diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index 9e581ef7c..9e4260432 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the World2D.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_World2D: diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 9e33d765f..4812f4463 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the WorldEnvironment.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_WorldEnvironment: diff --git a/classes/class_xmlparser.rst b/classes/class_xmlparser.rst index ad8a1f99d..b425ec667 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the XMLParser.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_XMLParser: @@ -49,7 +50,7 @@ Member Functions +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`read` **(** **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`seek` **(** :ref:`int` pos **)** | +| :ref:`int` | :ref:`seek` **(** :ref:`int` position **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skip_section` **(** **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -165,7 +166,7 @@ Read the next node of the file. This returns an error code. .. _class_XMLParser_seek: -- :ref:`int` **seek** **(** :ref:`int` pos **)** +- :ref:`int` **seek** **(** :ref:`int` position **)** Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 3886bda34..e57c158ae 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -1,5 +1,6 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. +.. DO NOT EDIT THIS FILE, but the YSort.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. .. _class_YSort: